1 2 #include <petsc-private/tsimpl.h> /*I "petscts.h" I*/ 3 #include <petscdmshell.h> 4 #include <petscdmda.h> 5 #include <petscviewer.h> 6 #include <petscdraw.h> 7 8 /* Logging support */ 9 PetscClassId TS_CLASSID, DMTS_CLASSID; 10 PetscLogEvent TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval; 11 12 const char *const TSExactFinalTimeOptions[] = {"STEPOVER","INTERPOLATE","MATCHSTEP","TSExactFinalTimeOption","TS_EXACTFINALTIME_",0}; 13 14 #undef __FUNCT__ 15 #define __FUNCT__ "TSSetTypeFromOptions" 16 /* 17 TSSetTypeFromOptions - Sets the type of ts from user options. 18 19 Collective on TS 20 21 Input Parameter: 22 . ts - The ts 23 24 Level: intermediate 25 26 .keywords: TS, set, options, database, type 27 .seealso: TSSetFromOptions(), TSSetType() 28 */ 29 static PetscErrorCode TSSetTypeFromOptions(TS ts) 30 { 31 PetscBool opt; 32 const char *defaultType; 33 char typeName[256]; 34 PetscErrorCode ierr; 35 36 PetscFunctionBegin; 37 if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name; 38 else defaultType = TSEULER; 39 40 if (!TSRegisterAllCalled) {ierr = TSRegisterAll();CHKERRQ(ierr);} 41 ierr = PetscOptionsFList("-ts_type", "TS method"," TSSetType", TSList, defaultType, typeName, 256, &opt);CHKERRQ(ierr); 42 if (opt) { 43 ierr = TSSetType(ts, typeName);CHKERRQ(ierr); 44 } else { 45 ierr = TSSetType(ts, defaultType);CHKERRQ(ierr); 46 } 47 PetscFunctionReturn(0); 48 } 49 50 struct _n_TSMonitorDrawCtx { 51 PetscViewer viewer; 52 PetscDrawAxis axis; 53 Vec initialsolution; 54 PetscBool showinitial; 55 PetscInt howoften; /* when > 0 uses step % howoften, when negative only final solution plotted */ 56 PetscBool showtimestepandtime; 57 int color; 58 }; 59 60 #undef __FUNCT__ 61 #define __FUNCT__ "TSSetFromOptions" 62 /*@ 63 TSSetFromOptions - Sets various TS parameters from user options. 64 65 Collective on TS 66 67 Input Parameter: 68 . ts - the TS context obtained from TSCreate() 69 70 Options Database Keys: 71 + -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSGL, TSSSP 72 . -ts_max_steps maxsteps - maximum number of time-steps to take 73 . -ts_final_time time - maximum time to compute to 74 . -ts_dt dt - initial time step 75 . -ts_monitor - print information at each timestep 76 . -ts_monitor_lg_timestep - Monitor timestep size graphically 77 . -ts_monitor_lg_solution - Monitor solution graphically 78 . -ts_monitor_lg_error - Monitor error graphically 79 . -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically 80 . -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically 81 . -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically 82 . -ts_monitor_draw_solution - Monitor solution graphically 83 . -ts_monitor_draw_solution_phase - Monitor solution graphically with phase diagram 84 . -ts_monitor_draw_error - Monitor error graphically 85 . -ts_monitor_solution_binary <filename> - Save each solution to a binary file 86 - -ts_monitor_solution_vtk <filename.vts> - Save each time step to a binary file, use filename-%%03D.vts 87 88 Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified 89 90 Level: beginner 91 92 .keywords: TS, timestep, set, options, database 93 94 .seealso: TSGetType() 95 @*/ 96 PetscErrorCode TSSetFromOptions(TS ts) 97 { 98 PetscBool opt,flg; 99 PetscErrorCode ierr; 100 PetscViewer monviewer; 101 char monfilename[PETSC_MAX_PATH_LEN]; 102 SNES snes; 103 TSAdapt adapt; 104 PetscReal time_step; 105 TSExactFinalTimeOption eftopt; 106 char dir[16]; 107 108 PetscFunctionBegin; 109 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 110 ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr); 111 /* Handle TS type options */ 112 ierr = TSSetTypeFromOptions(ts);CHKERRQ(ierr); 113 114 /* Handle generic TS options */ 115 ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr); 116 ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr); 117 ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr); 118 ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr); 119 if (flg) { 120 ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 121 } 122 ierr = PetscOptionsEnum("-ts_exact_final_time","Option for handling of final time step","TSSetExactFinalTime",TSExactFinalTimeOptions,(PetscEnum)ts->exact_final_time,(PetscEnum*)&eftopt,&flg);CHKERRQ(ierr); 123 if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);} 124 ierr = PetscOptionsInt("-ts_max_snes_failures","Maximum number of nonlinear solve failures","TSSetMaxSNESFailures",ts->max_snes_failures,&ts->max_snes_failures,NULL);CHKERRQ(ierr); 125 ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr); 126 ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr); 127 ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr); 128 ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr); 129 130 #if defined(PETSC_HAVE_SAWS) 131 { 132 PetscBool set; 133 flg = PETSC_FALSE; 134 ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr); 135 if (set) { 136 ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr); 137 } 138 } 139 #endif 140 141 /* Monitor options */ 142 ierr = PetscOptionsString("-ts_monitor","Monitor timestep size","TSMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 143 if (flg) { 144 ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)ts),monfilename,&monviewer);CHKERRQ(ierr); 145 ierr = TSMonitorSet(ts,TSMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 146 } 147 ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 148 if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);} 149 150 ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr); 151 if (opt) { 152 TSMonitorLGCtx ctx; 153 PetscInt howoften = 1; 154 155 ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr); 156 ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 157 ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 158 } 159 ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr); 160 if (opt) { 161 TSMonitorLGCtx ctx; 162 PetscInt howoften = 1; 163 164 ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 165 ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 166 ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 167 } 168 ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr); 169 if (opt) { 170 TSMonitorLGCtx ctx; 171 PetscInt howoften = 1; 172 173 ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr); 174 ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 175 ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 176 } 177 ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr); 178 if (opt) { 179 TSMonitorLGCtx ctx; 180 PetscInt howoften = 1; 181 182 ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 183 ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 184 ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 185 } 186 ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr); 187 if (opt) { 188 TSMonitorLGCtx ctx; 189 PetscInt howoften = 1; 190 191 ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 192 ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 193 ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 194 } 195 ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr); 196 if (opt) { 197 TSMonitorSPEigCtx ctx; 198 PetscInt howoften = 1; 199 200 ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr); 201 ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 202 ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr); 203 } 204 opt = PETSC_FALSE; 205 ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr); 206 if (opt) { 207 TSMonitorDrawCtx ctx; 208 PetscInt howoften = 1; 209 210 ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 211 ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 212 ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 213 } 214 opt = PETSC_FALSE; 215 ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr); 216 if (opt) { 217 TSMonitorDrawCtx ctx; 218 PetscReal bounds[4]; 219 PetscInt n = 4; 220 PetscDraw draw; 221 222 ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr); 223 if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field"); 224 ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,1,&ctx);CHKERRQ(ierr); 225 ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr); 226 ierr = PetscDrawClear(draw);CHKERRQ(ierr); 227 ierr = PetscDrawAxisCreate(draw,&ctx->axis);CHKERRQ(ierr); 228 ierr = PetscDrawAxisSetLimits(ctx->axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr); 229 ierr = PetscDrawAxisSetLabels(ctx->axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr); 230 ierr = PetscDrawAxisDraw(ctx->axis);CHKERRQ(ierr); 231 /* ierr = PetscDrawSetCoordinates(draw,bounds[0],bounds[1],bounds[2],bounds[3]);CHKERRQ(ierr); */ 232 ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 233 } 234 opt = PETSC_FALSE; 235 ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr); 236 if (opt) { 237 TSMonitorDrawCtx ctx; 238 PetscInt howoften = 1; 239 240 ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr); 241 ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 242 ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 243 } 244 opt = PETSC_FALSE; 245 ierr = PetscOptionsString("-ts_monitor_solution_binary","Save each solution to a binary file","TSMonitorSolutionBinary",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 246 if (flg) { 247 PetscViewer ctx; 248 if (monfilename[0]) { 249 ierr = PetscViewerBinaryOpen(PetscObjectComm((PetscObject)ts),monfilename,FILE_MODE_WRITE,&ctx);CHKERRQ(ierr); 250 ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 251 } else { 252 ctx = PETSC_VIEWER_BINARY_(PetscObjectComm((PetscObject)ts)); 253 ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))NULL);CHKERRQ(ierr); 254 } 255 } 256 opt = PETSC_FALSE; 257 ierr = PetscOptionsString("-ts_monitor_solution_vtk","Save each time step to a binary file, use filename-%%03D.vts","TSMonitorSolutionVTK",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 258 if (flg) { 259 const char *ptr,*ptr2; 260 char *filetemplate; 261 if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 262 /* Do some cursory validation of the input. */ 263 ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr); 264 if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 265 for (ptr++; ptr && *ptr; ptr++) { 266 ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr); 267 if (!ptr2 && (*ptr < '0' || '9' < *ptr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Invalid file template argument to -ts_monitor_solution_vtk, should look like filename-%%03D.vts"); 268 if (ptr2) break; 269 } 270 ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr); 271 ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr); 272 } 273 274 ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr); 275 if (flg) { 276 TSMonitorDMDARayCtx *rayctx; 277 int ray = 0; 278 DMDADirection ddir; 279 DM da; 280 PetscMPIInt rank; 281 282 if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 283 if (dir[0] == 'x') ddir = DMDA_X; 284 else if (dir[0] == 'y') ddir = DMDA_Y; 285 else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 286 sscanf(dir+2,"%d",&ray); 287 288 ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr); 289 ierr = PetscNew(&rayctx);CHKERRQ(ierr); 290 ierr = TSGetDM(ts,&da);CHKERRQ(ierr); 291 ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr); 292 ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr); 293 if (!rank) { 294 ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr); 295 } 296 rayctx->lgctx = NULL; 297 ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr); 298 } 299 ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr); 300 if (flg) { 301 TSMonitorDMDARayCtx *rayctx; 302 int ray = 0; 303 DMDADirection ddir; 304 DM da; 305 PetscInt howoften = 1; 306 307 if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir); 308 if (dir[0] == 'x') ddir = DMDA_X; 309 else if (dir[0] == 'y') ddir = DMDA_Y; 310 else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir); 311 sscanf(dir+2, "%d", &ray); 312 313 ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr); 314 ierr = PetscNew(&rayctx);CHKERRQ(ierr); 315 ierr = TSGetDM(ts, &da);CHKERRQ(ierr); 316 ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr); 317 ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr); 318 ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr); 319 } 320 321 /* 322 This code is all wrong. One is creating objects inside the TSSetFromOptions() so if run with the options gui 323 will bleed memory. Also one is using a PetscOptionsBegin() inside a PetscOptionsBegin() 324 */ 325 ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr); 326 ierr = TSAdaptSetFromOptions(adapt);CHKERRQ(ierr); 327 328 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 329 if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);} 330 331 /* Handle specific TS options */ 332 if (ts->ops->setfromoptions) { 333 ierr = (*ts->ops->setfromoptions)(ts);CHKERRQ(ierr); 334 } 335 336 /* process any options handlers added with PetscObjectAddOptionsHandler() */ 337 ierr = PetscObjectProcessOptionsHandlers((PetscObject)ts);CHKERRQ(ierr); 338 ierr = PetscOptionsEnd();CHKERRQ(ierr); 339 PetscFunctionReturn(0); 340 } 341 342 #undef __FUNCT__ 343 #undef __FUNCT__ 344 #define __FUNCT__ "TSComputeRHSJacobian" 345 /*@ 346 TSComputeRHSJacobian - Computes the Jacobian matrix that has been 347 set with TSSetRHSJacobian(). 348 349 Collective on TS and Vec 350 351 Input Parameters: 352 + ts - the TS context 353 . t - current timestep 354 - U - input vector 355 356 Output Parameters: 357 + A - Jacobian matrix 358 . B - optional preconditioning matrix 359 - flag - flag indicating matrix structure 360 361 Notes: 362 Most users should not need to explicitly call this routine, as it 363 is used internally within the nonlinear solvers. 364 365 See KSPSetOperators() for important information about setting the 366 flag parameter. 367 368 Level: developer 369 370 .keywords: SNES, compute, Jacobian, matrix 371 372 .seealso: TSSetRHSJacobian(), KSPSetOperators() 373 @*/ 374 PetscErrorCode TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat *A,Mat *B,MatStructure *flg) 375 { 376 PetscErrorCode ierr; 377 PetscObjectState Ustate; 378 DM dm; 379 DMTS tsdm; 380 TSRHSJacobian rhsjacobianfunc; 381 void *ctx; 382 TSIJacobian ijacobianfunc; 383 384 PetscFunctionBegin; 385 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 386 PetscValidHeaderSpecific(U,VEC_CLASSID,3); 387 PetscCheckSameComm(ts,1,U,3); 388 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 389 ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr); 390 ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr); 391 ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr); 392 ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr); 393 if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate))) { 394 *flg = ts->rhsjacobian.mstructure; 395 PetscFunctionReturn(0); 396 } 397 398 if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 399 400 if (ts->rhsjacobian.reuse) { 401 ierr = MatShift(*A,-ts->rhsjacobian.shift);CHKERRQ(ierr); 402 ierr = MatScale(*A,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 403 if (*A != *B) { 404 ierr = MatShift(*B,-ts->rhsjacobian.shift);CHKERRQ(ierr); 405 ierr = MatScale(*B,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 406 } 407 ts->rhsjacobian.shift = 0; 408 ts->rhsjacobian.scale = 1.; 409 } 410 411 if (rhsjacobianfunc) { 412 ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,*A,*B);CHKERRQ(ierr); 413 *flg = DIFFERENT_NONZERO_PATTERN; 414 PetscStackPush("TS user Jacobian function"); 415 ierr = (*rhsjacobianfunc)(ts,t,U,A,B,flg,ctx);CHKERRQ(ierr); 416 PetscStackPop; 417 ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,*A,*B);CHKERRQ(ierr); 418 /* make sure user returned a correct Jacobian and preconditioner */ 419 PetscValidHeaderSpecific(*A,MAT_CLASSID,4); 420 PetscValidHeaderSpecific(*B,MAT_CLASSID,5); 421 } else { 422 ierr = MatZeroEntries(*A);CHKERRQ(ierr); 423 if (*A != *B) {ierr = MatZeroEntries(*B);CHKERRQ(ierr);} 424 *flg = SAME_NONZERO_PATTERN; 425 } 426 ts->rhsjacobian.time = t; 427 ts->rhsjacobian.X = U; 428 ierr = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr); 429 ts->rhsjacobian.mstructure = *flg; 430 PetscFunctionReturn(0); 431 } 432 433 #undef __FUNCT__ 434 #define __FUNCT__ "TSComputeRHSFunction" 435 /*@ 436 TSComputeRHSFunction - Evaluates the right-hand-side function. 437 438 Collective on TS and Vec 439 440 Input Parameters: 441 + ts - the TS context 442 . t - current time 443 - U - state vector 444 445 Output Parameter: 446 . y - right hand side 447 448 Note: 449 Most users should not need to explicitly call this routine, as it 450 is used internally within the nonlinear solvers. 451 452 Level: developer 453 454 .keywords: TS, compute 455 456 .seealso: TSSetRHSFunction(), TSComputeIFunction() 457 @*/ 458 PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y) 459 { 460 PetscErrorCode ierr; 461 TSRHSFunction rhsfunction; 462 TSIFunction ifunction; 463 void *ctx; 464 DM dm; 465 466 PetscFunctionBegin; 467 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 468 PetscValidHeaderSpecific(U,VEC_CLASSID,3); 469 PetscValidHeaderSpecific(y,VEC_CLASSID,4); 470 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 471 ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 472 ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr); 473 474 if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 475 476 ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 477 if (rhsfunction) { 478 PetscStackPush("TS user right-hand-side function"); 479 ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr); 480 PetscStackPop; 481 } else { 482 ierr = VecZeroEntries(y);CHKERRQ(ierr); 483 } 484 485 ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 486 PetscFunctionReturn(0); 487 } 488 489 #undef __FUNCT__ 490 #define __FUNCT__ "TSComputeSolutionFunction" 491 /*@ 492 TSComputeSolutionFunction - Evaluates the solution function. 493 494 Collective on TS and Vec 495 496 Input Parameters: 497 + ts - the TS context 498 - t - current time 499 500 Output Parameter: 501 . U - the solution 502 503 Note: 504 Most users should not need to explicitly call this routine, as it 505 is used internally within the nonlinear solvers. 506 507 Level: developer 508 509 .keywords: TS, compute 510 511 .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 512 @*/ 513 PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U) 514 { 515 PetscErrorCode ierr; 516 TSSolutionFunction solutionfunction; 517 void *ctx; 518 DM dm; 519 520 PetscFunctionBegin; 521 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 522 PetscValidHeaderSpecific(U,VEC_CLASSID,3); 523 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 524 ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr); 525 526 if (solutionfunction) { 527 PetscStackPush("TS user solution function"); 528 ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr); 529 PetscStackPop; 530 } 531 PetscFunctionReturn(0); 532 } 533 #undef __FUNCT__ 534 #define __FUNCT__ "TSComputeForcingFunction" 535 /*@ 536 TSComputeForcingFunction - Evaluates the forcing function. 537 538 Collective on TS and Vec 539 540 Input Parameters: 541 + ts - the TS context 542 - t - current time 543 544 Output Parameter: 545 . U - the function value 546 547 Note: 548 Most users should not need to explicitly call this routine, as it 549 is used internally within the nonlinear solvers. 550 551 Level: developer 552 553 .keywords: TS, compute 554 555 .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 556 @*/ 557 PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U) 558 { 559 PetscErrorCode ierr, (*forcing)(TS,PetscReal,Vec,void*); 560 void *ctx; 561 DM dm; 562 563 PetscFunctionBegin; 564 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 565 PetscValidHeaderSpecific(U,VEC_CLASSID,3); 566 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 567 ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr); 568 569 if (forcing) { 570 PetscStackPush("TS user forcing function"); 571 ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr); 572 PetscStackPop; 573 } 574 PetscFunctionReturn(0); 575 } 576 577 #undef __FUNCT__ 578 #define __FUNCT__ "TSGetRHSVec_Private" 579 static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs) 580 { 581 Vec F; 582 PetscErrorCode ierr; 583 584 PetscFunctionBegin; 585 *Frhs = NULL; 586 ierr = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr); 587 if (!ts->Frhs) { 588 ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr); 589 } 590 *Frhs = ts->Frhs; 591 PetscFunctionReturn(0); 592 } 593 594 #undef __FUNCT__ 595 #define __FUNCT__ "TSGetRHSMats_Private" 596 static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs) 597 { 598 Mat A,B; 599 PetscErrorCode ierr; 600 601 PetscFunctionBegin; 602 ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 603 if (Arhs) { 604 if (!ts->Arhs) { 605 ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr); 606 } 607 *Arhs = ts->Arhs; 608 } 609 if (Brhs) { 610 if (!ts->Brhs) { 611 if (A != B) { 612 ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr); 613 } else { 614 ts->Brhs = ts->Arhs; 615 ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr); 616 } 617 } 618 *Brhs = ts->Brhs; 619 } 620 PetscFunctionReturn(0); 621 } 622 623 #undef __FUNCT__ 624 #define __FUNCT__ "TSComputeIFunction" 625 /*@ 626 TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0 627 628 Collective on TS and Vec 629 630 Input Parameters: 631 + ts - the TS context 632 . t - current time 633 . U - state vector 634 . Udot - time derivative of state vector 635 - imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate 636 637 Output Parameter: 638 . Y - right hand side 639 640 Note: 641 Most users should not need to explicitly call this routine, as it 642 is used internally within the nonlinear solvers. 643 644 If the user did did not write their equations in implicit form, this 645 function recasts them in implicit form. 646 647 Level: developer 648 649 .keywords: TS, compute 650 651 .seealso: TSSetIFunction(), TSComputeRHSFunction() 652 @*/ 653 PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex) 654 { 655 PetscErrorCode ierr; 656 TSIFunction ifunction; 657 TSRHSFunction rhsfunction; 658 void *ctx; 659 DM dm; 660 661 PetscFunctionBegin; 662 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 663 PetscValidHeaderSpecific(U,VEC_CLASSID,3); 664 PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 665 PetscValidHeaderSpecific(Y,VEC_CLASSID,5); 666 667 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 668 ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr); 669 ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 670 671 if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 672 673 ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 674 if (ifunction) { 675 PetscStackPush("TS user implicit function"); 676 ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr); 677 PetscStackPop; 678 } 679 if (imex) { 680 if (!ifunction) { 681 ierr = VecCopy(Udot,Y);CHKERRQ(ierr); 682 } 683 } else if (rhsfunction) { 684 if (ifunction) { 685 Vec Frhs; 686 ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 687 ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 688 ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr); 689 } else { 690 ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr); 691 ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr); 692 } 693 } 694 ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 695 PetscFunctionReturn(0); 696 } 697 698 #undef __FUNCT__ 699 #define __FUNCT__ "TSComputeIJacobian" 700 /*@ 701 TSComputeIJacobian - Evaluates the Jacobian of the DAE 702 703 Collective on TS and Vec 704 705 Input 706 Input Parameters: 707 + ts - the TS context 708 . t - current timestep 709 . U - state vector 710 . Udot - time derivative of state vector 711 . shift - shift to apply, see note below 712 - imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate 713 714 Output Parameters: 715 + A - Jacobian matrix 716 . B - optional preconditioning matrix 717 - flag - flag indicating matrix structure 718 719 Notes: 720 If F(t,U,Udot)=0 is the DAE, the required Jacobian is 721 722 dF/dU + shift*dF/dUdot 723 724 Most users should not need to explicitly call this routine, as it 725 is used internally within the nonlinear solvers. 726 727 Level: developer 728 729 .keywords: TS, compute, Jacobian, matrix 730 731 .seealso: TSSetIJacobian() 732 @*/ 733 PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat *A,Mat *B,MatStructure *flg,PetscBool imex) 734 { 735 PetscErrorCode ierr; 736 TSIJacobian ijacobian; 737 TSRHSJacobian rhsjacobian; 738 DM dm; 739 void *ctx; 740 741 PetscFunctionBegin; 742 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 743 PetscValidHeaderSpecific(U,VEC_CLASSID,3); 744 PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 745 PetscValidPointer(A,6); 746 PetscValidHeaderSpecific(*A,MAT_CLASSID,6); 747 PetscValidPointer(B,7); 748 PetscValidHeaderSpecific(*B,MAT_CLASSID,7); 749 PetscValidPointer(flg,8); 750 751 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 752 ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr); 753 ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 754 755 if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 756 757 *flg = SAME_NONZERO_PATTERN; /* In case we're solving a linear problem in which case it wouldn't get initialized below. */ 758 ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,*A,*B);CHKERRQ(ierr); 759 if (ijacobian) { 760 *flg = DIFFERENT_NONZERO_PATTERN; 761 PetscStackPush("TS user implicit Jacobian"); 762 ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,flg,ctx);CHKERRQ(ierr); 763 PetscStackPop; 764 /* make sure user returned a correct Jacobian and preconditioner */ 765 PetscValidHeaderSpecific(*A,MAT_CLASSID,4); 766 PetscValidHeaderSpecific(*B,MAT_CLASSID,5); 767 } 768 if (imex) { 769 if (!ijacobian) { /* system was written as Udot = G(t,U) */ 770 ierr = MatZeroEntries(*A);CHKERRQ(ierr); 771 ierr = MatShift(*A,shift);CHKERRQ(ierr); 772 if (*A != *B) { 773 ierr = MatZeroEntries(*B);CHKERRQ(ierr); 774 ierr = MatShift(*B,shift);CHKERRQ(ierr); 775 } 776 *flg = SAME_PRECONDITIONER; 777 } 778 } else { 779 Mat Arhs = NULL,Brhs = NULL; 780 MatStructure flg2; 781 if (rhsjacobian) { 782 ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 783 ierr = TSComputeRHSJacobian(ts,t,U,&Arhs,&Brhs,&flg2);CHKERRQ(ierr); 784 } 785 if (Arhs == *A) { /* No IJacobian, so we only have the RHS matrix */ 786 ts->rhsjacobian.scale = -1; 787 ts->rhsjacobian.shift = shift; 788 ierr = MatScale(*A,-1);CHKERRQ(ierr); 789 ierr = MatShift(*A,shift);CHKERRQ(ierr); 790 if (*A != *B) { 791 ierr = MatScale(*B,-1);CHKERRQ(ierr); 792 ierr = MatShift(*B,shift);CHKERRQ(ierr); 793 } 794 } else if (Arhs) { /* Both IJacobian and RHSJacobian */ 795 MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 796 if (!ijacobian) { /* No IJacobian provided, but we have a separate RHS matrix */ 797 ierr = MatZeroEntries(*A);CHKERRQ(ierr); 798 ierr = MatShift(*A,shift);CHKERRQ(ierr); 799 if (*A != *B) { 800 ierr = MatZeroEntries(*B);CHKERRQ(ierr); 801 ierr = MatShift(*B,shift);CHKERRQ(ierr); 802 } 803 } 804 ierr = MatAXPY(*A,-1,Arhs,axpy);CHKERRQ(ierr); 805 if (*A != *B) { 806 ierr = MatAXPY(*B,-1,Brhs,axpy);CHKERRQ(ierr); 807 } 808 *flg = PetscMin(*flg,flg2); 809 } 810 } 811 812 ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,*A,*B);CHKERRQ(ierr); 813 PetscFunctionReturn(0); 814 } 815 816 #undef __FUNCT__ 817 #define __FUNCT__ "TSSetRHSFunction" 818 /*@C 819 TSSetRHSFunction - Sets the routine for evaluating the function, 820 where U_t = G(t,u). 821 822 Logically Collective on TS 823 824 Input Parameters: 825 + ts - the TS context obtained from TSCreate() 826 . r - vector to put the computed right hand side (or NULL to have it created) 827 . f - routine for evaluating the right-hand-side function 828 - ctx - [optional] user-defined context for private data for the 829 function evaluation routine (may be NULL) 830 831 Calling sequence of func: 832 $ func (TS ts,PetscReal t,Vec u,Vec F,void *ctx); 833 834 + t - current timestep 835 . u - input vector 836 . F - function vector 837 - ctx - [optional] user-defined function context 838 839 Level: beginner 840 841 .keywords: TS, timestep, set, right-hand-side, function 842 843 .seealso: TSSetRHSJacobian(), TSSetIJacobian() 844 @*/ 845 PetscErrorCode TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx) 846 { 847 PetscErrorCode ierr; 848 SNES snes; 849 Vec ralloc = NULL; 850 DM dm; 851 852 PetscFunctionBegin; 853 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 854 if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 855 856 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 857 ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr); 858 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 859 if (!r && !ts->dm && ts->vec_sol) { 860 ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 861 r = ralloc; 862 } 863 ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 864 ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 865 PetscFunctionReturn(0); 866 } 867 868 #undef __FUNCT__ 869 #define __FUNCT__ "TSSetSolutionFunction" 870 /*@C 871 TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE 872 873 Logically Collective on TS 874 875 Input Parameters: 876 + ts - the TS context obtained from TSCreate() 877 . f - routine for evaluating the solution 878 - ctx - [optional] user-defined context for private data for the 879 function evaluation routine (may be NULL) 880 881 Calling sequence of func: 882 $ func (TS ts,PetscReal t,Vec u,void *ctx); 883 884 + t - current timestep 885 . u - output vector 886 - ctx - [optional] user-defined function context 887 888 Notes: 889 This routine is used for testing accuracy of time integration schemes when you already know the solution. 890 If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to 891 create closed-form solutions with non-physical forcing terms. 892 893 For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 894 895 Level: beginner 896 897 .keywords: TS, timestep, set, right-hand-side, function 898 899 .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction() 900 @*/ 901 PetscErrorCode TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 902 { 903 PetscErrorCode ierr; 904 DM dm; 905 906 PetscFunctionBegin; 907 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 908 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 909 ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr); 910 PetscFunctionReturn(0); 911 } 912 913 #undef __FUNCT__ 914 #define __FUNCT__ "TSSetForcingFunction" 915 /*@C 916 TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE 917 918 Logically Collective on TS 919 920 Input Parameters: 921 + ts - the TS context obtained from TSCreate() 922 . f - routine for evaluating the forcing function 923 - ctx - [optional] user-defined context for private data for the 924 function evaluation routine (may be NULL) 925 926 Calling sequence of func: 927 $ func (TS ts,PetscReal t,Vec u,void *ctx); 928 929 + t - current timestep 930 . u - output vector 931 - ctx - [optional] user-defined function context 932 933 Notes: 934 This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to 935 create closed-form solutions with a non-physical forcing term. 936 937 For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 938 939 Level: beginner 940 941 .keywords: TS, timestep, set, right-hand-side, function 942 943 .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction() 944 @*/ 945 PetscErrorCode TSSetForcingFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 946 { 947 PetscErrorCode ierr; 948 DM dm; 949 950 PetscFunctionBegin; 951 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 952 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 953 ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr); 954 PetscFunctionReturn(0); 955 } 956 957 #undef __FUNCT__ 958 #define __FUNCT__ "TSSetRHSJacobian" 959 /*@C 960 TSSetRHSJacobian - Sets the function to compute the Jacobian of F, 961 where U_t = G(U,t), as well as the location to store the matrix. 962 963 Logically Collective on TS 964 965 Input Parameters: 966 + ts - the TS context obtained from TSCreate() 967 . Amat - (approximate) Jacobian matrix 968 . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 969 . f - the Jacobian evaluation routine 970 - ctx - [optional] user-defined context for private data for the 971 Jacobian evaluation routine (may be NULL) 972 973 Calling sequence of func: 974 $ func (TS ts,PetscReal t,Vec u,Mat *A,Mat *B,MatStructure *flag,void *ctx); 975 976 + t - current timestep 977 . u - input vector 978 . Amat - (approximate) Jacobian matrix 979 . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 980 . flag - flag indicating information about the preconditioner matrix 981 structure (same as flag in KSPSetOperators()) 982 - ctx - [optional] user-defined context for matrix evaluation routine 983 984 Notes: 985 See KSPSetOperators() for important information about setting the flag 986 output parameter in the routine func(). Be sure to read this information! 987 988 The routine func() takes Mat * as the matrix arguments rather than Mat. 989 This allows the matrix evaluation routine to replace A and/or B with a 990 completely new matrix structure (not just different matrix elements) 991 when appropriate, for instance, if the nonzero structure is changing 992 throughout the global iterations. 993 994 Level: beginner 995 996 .keywords: TS, timestep, set, right-hand-side, Jacobian 997 998 .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse() 999 1000 @*/ 1001 PetscErrorCode TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx) 1002 { 1003 PetscErrorCode ierr; 1004 SNES snes; 1005 DM dm; 1006 TSIJacobian ijacobian; 1007 1008 PetscFunctionBegin; 1009 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1010 if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1011 if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1012 if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1013 if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 1014 1015 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1016 ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr); 1017 if (f == TSComputeRHSJacobianConstant) { 1018 /* Handle this case automatically for the user; otherwise user should call themselves. */ 1019 ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr); 1020 } 1021 ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr); 1022 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1023 if (!ijacobian) { 1024 ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1025 } 1026 if (Amat) { 1027 ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 1028 ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 1029 1030 ts->Arhs = Amat; 1031 } 1032 if (Pmat) { 1033 ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr); 1034 ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1035 1036 ts->Brhs = Pmat; 1037 } 1038 PetscFunctionReturn(0); 1039 } 1040 1041 1042 #undef __FUNCT__ 1043 #define __FUNCT__ "TSSetIFunction" 1044 /*@C 1045 TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved. 1046 1047 Logically Collective on TS 1048 1049 Input Parameters: 1050 + ts - the TS context obtained from TSCreate() 1051 . r - vector to hold the residual (or NULL to have it created internally) 1052 . f - the function evaluation routine 1053 - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1054 1055 Calling sequence of f: 1056 $ f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx); 1057 1058 + t - time at step/stage being solved 1059 . u - state vector 1060 . u_t - time derivative of state vector 1061 . F - function vector 1062 - ctx - [optional] user-defined context for matrix evaluation routine 1063 1064 Important: 1065 The user MUST call either this routine, TSSetRHSFunction(). This routine must be used when not solving an ODE, for example a DAE. 1066 1067 Level: beginner 1068 1069 .keywords: TS, timestep, set, DAE, Jacobian 1070 1071 .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian() 1072 @*/ 1073 PetscErrorCode TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx) 1074 { 1075 PetscErrorCode ierr; 1076 SNES snes; 1077 Vec resalloc = NULL; 1078 DM dm; 1079 1080 PetscFunctionBegin; 1081 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1082 if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2); 1083 1084 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1085 ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr); 1086 1087 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1088 if (!res && !ts->dm && ts->vec_sol) { 1089 ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr); 1090 res = resalloc; 1091 } 1092 ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr); 1093 ierr = VecDestroy(&resalloc);CHKERRQ(ierr); 1094 PetscFunctionReturn(0); 1095 } 1096 1097 #undef __FUNCT__ 1098 #define __FUNCT__ "TSGetIFunction" 1099 /*@C 1100 TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1101 1102 Not Collective 1103 1104 Input Parameter: 1105 . ts - the TS context 1106 1107 Output Parameter: 1108 + r - vector to hold residual (or NULL) 1109 . func - the function to compute residual (or NULL) 1110 - ctx - the function context (or NULL) 1111 1112 Level: advanced 1113 1114 .keywords: TS, nonlinear, get, function 1115 1116 .seealso: TSSetIFunction(), SNESGetFunction() 1117 @*/ 1118 PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx) 1119 { 1120 PetscErrorCode ierr; 1121 SNES snes; 1122 DM dm; 1123 1124 PetscFunctionBegin; 1125 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1126 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1127 ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 1128 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1129 ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr); 1130 PetscFunctionReturn(0); 1131 } 1132 1133 #undef __FUNCT__ 1134 #define __FUNCT__ "TSGetRHSFunction" 1135 /*@C 1136 TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it. 1137 1138 Not Collective 1139 1140 Input Parameter: 1141 . ts - the TS context 1142 1143 Output Parameter: 1144 + r - vector to hold computed right hand side (or NULL) 1145 . func - the function to compute right hand side (or NULL) 1146 - ctx - the function context (or NULL) 1147 1148 Level: advanced 1149 1150 .keywords: TS, nonlinear, get, function 1151 1152 .seealso: TSSetRhsfunction(), SNESGetFunction() 1153 @*/ 1154 PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx) 1155 { 1156 PetscErrorCode ierr; 1157 SNES snes; 1158 DM dm; 1159 1160 PetscFunctionBegin; 1161 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1162 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1163 ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 1164 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1165 ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr); 1166 PetscFunctionReturn(0); 1167 } 1168 1169 #undef __FUNCT__ 1170 #define __FUNCT__ "TSSetIJacobian" 1171 /*@C 1172 TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function 1173 you provided with TSSetIFunction(). 1174 1175 Logically Collective on TS 1176 1177 Input Parameters: 1178 + ts - the TS context obtained from TSCreate() 1179 . Amat - (approximate) Jacobian matrix 1180 . Pmat - matrix used to compute preconditioner (usually the same as Amat) 1181 . f - the Jacobian evaluation routine 1182 - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1183 1184 Calling sequence of f: 1185 $ f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat *Amat,Mat *Pmat,MatStructure *flag,void *ctx); 1186 1187 + t - time at step/stage being solved 1188 . U - state vector 1189 . U_t - time derivative of state vector 1190 . a - shift 1191 . Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t 1192 . Pmat - matrix used for constructing preconditioner, usually the same as Amat 1193 . flag - flag indicating information about the preconditioner matrix 1194 structure (same as flag in KSPSetOperators()) 1195 - ctx - [optional] user-defined context for matrix evaluation routine 1196 1197 Notes: 1198 The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve. 1199 1200 The matrix dF/dU + a*dF/dU_t you provide turns out to be 1201 the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved. 1202 The time integrator internally approximates U_t by W+a*U where the positive "shift" 1203 a and vector W depend on the integration method, step size, and past states. For example with 1204 the backward Euler method a = 1/dt and W = -a*U(previous timestep) so 1205 W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt 1206 1207 Level: beginner 1208 1209 .keywords: TS, timestep, DAE, Jacobian 1210 1211 .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault() 1212 1213 @*/ 1214 PetscErrorCode TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx) 1215 { 1216 PetscErrorCode ierr; 1217 SNES snes; 1218 DM dm; 1219 1220 PetscFunctionBegin; 1221 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1222 if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1223 if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1224 if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1225 if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 1226 1227 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1228 ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr); 1229 1230 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1231 ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1232 PetscFunctionReturn(0); 1233 } 1234 1235 #undef __FUNCT__ 1236 #define __FUNCT__ "TSRHSJacobianSetReuse" 1237 /*@ 1238 TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating. Without this flag, TS will change the sign and 1239 shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute 1240 the entire Jacobian. The reuse flag must be set if the evaluation function will assume that the matrix entries have 1241 not been changed by the TS. 1242 1243 Logically Collective 1244 1245 Input Arguments: 1246 + ts - TS context obtained from TSCreate() 1247 - reuse - PETSC_TRUE if the RHS Jacobian 1248 1249 Level: intermediate 1250 1251 .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 1252 @*/ 1253 PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse) 1254 { 1255 PetscFunctionBegin; 1256 ts->rhsjacobian.reuse = reuse; 1257 PetscFunctionReturn(0); 1258 } 1259 1260 #undef __FUNCT__ 1261 #define __FUNCT__ "TSLoad" 1262 /*@C 1263 TSLoad - Loads a KSP that has been stored in binary with KSPView(). 1264 1265 Collective on PetscViewer 1266 1267 Input Parameters: 1268 + newdm - the newly loaded TS, this needs to have been created with TSCreate() or 1269 some related function before a call to TSLoad(). 1270 - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() 1271 1272 Level: intermediate 1273 1274 Notes: 1275 The type is determined by the data in the file, any type set into the TS before this call is ignored. 1276 1277 Notes for advanced users: 1278 Most users should not need to know the details of the binary storage 1279 format, since TSLoad() and TSView() completely hide these details. 1280 But for anyone who's interested, the standard binary matrix storage 1281 format is 1282 .vb 1283 has not yet been determined 1284 .ve 1285 1286 .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad() 1287 @*/ 1288 PetscErrorCode TSLoad(TS ts, PetscViewer viewer) 1289 { 1290 PetscErrorCode ierr; 1291 PetscBool isbinary; 1292 PetscInt classid; 1293 char type[256]; 1294 DMTS sdm; 1295 DM dm; 1296 1297 PetscFunctionBegin; 1298 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1299 PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1300 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 1301 if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()"); 1302 1303 ierr = PetscViewerBinaryRead(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr); 1304 if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file"); 1305 ierr = PetscViewerBinaryRead(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr); 1306 ierr = TSSetType(ts, type);CHKERRQ(ierr); 1307 if (ts->ops->load) { 1308 ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr); 1309 } 1310 ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr); 1311 ierr = DMLoad(dm,viewer);CHKERRQ(ierr); 1312 ierr = TSSetDM(ts,dm);CHKERRQ(ierr); 1313 ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr); 1314 ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr); 1315 ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 1316 ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr); 1317 PetscFunctionReturn(0); 1318 } 1319 1320 #include <petscdraw.h> 1321 #if defined(PETSC_HAVE_SAWS) 1322 #include <petscviewersaws.h> 1323 #endif 1324 #undef __FUNCT__ 1325 #define __FUNCT__ "TSView" 1326 /*@C 1327 TSView - Prints the TS data structure. 1328 1329 Collective on TS 1330 1331 Input Parameters: 1332 + ts - the TS context obtained from TSCreate() 1333 - viewer - visualization context 1334 1335 Options Database Key: 1336 . -ts_view - calls TSView() at end of TSStep() 1337 1338 Notes: 1339 The available visualization contexts include 1340 + PETSC_VIEWER_STDOUT_SELF - standard output (default) 1341 - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 1342 output where only the first processor opens 1343 the file. All other processors send their 1344 data to the first processor to print. 1345 1346 The user can open an alternative visualization context with 1347 PetscViewerASCIIOpen() - output to a specified file. 1348 1349 Level: beginner 1350 1351 .keywords: TS, timestep, view 1352 1353 .seealso: PetscViewerASCIIOpen() 1354 @*/ 1355 PetscErrorCode TSView(TS ts,PetscViewer viewer) 1356 { 1357 PetscErrorCode ierr; 1358 TSType type; 1359 PetscBool iascii,isstring,isundials,isbinary,isdraw; 1360 DMTS sdm; 1361 #if defined(PETSC_HAVE_SAWS) 1362 PetscBool isams; 1363 #endif 1364 1365 PetscFunctionBegin; 1366 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1367 if (!viewer) { 1368 ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr); 1369 } 1370 PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1371 PetscCheckSameComm(ts,1,viewer,2); 1372 1373 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1374 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 1375 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 1376 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 1377 #if defined(PETSC_HAVE_SAWS) 1378 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&isams);CHKERRQ(ierr); 1379 #endif 1380 if (iascii) { 1381 ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr); 1382 ierr = PetscViewerASCIIPrintf(viewer," maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr); 1383 ierr = PetscViewerASCIIPrintf(viewer," maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr); 1384 if (ts->problem_type == TS_NONLINEAR) { 1385 ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr); 1386 ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr); 1387 } 1388 ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr); 1389 ierr = PetscViewerASCIIPrintf(viewer," total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr); 1390 ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 1391 ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 1392 if (ts->ops->view) { 1393 ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1394 ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1395 ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1396 } 1397 } else if (isstring) { 1398 ierr = TSGetType(ts,&type);CHKERRQ(ierr); 1399 ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr); 1400 } else if (isbinary) { 1401 PetscInt classid = TS_FILE_CLASSID; 1402 MPI_Comm comm; 1403 PetscMPIInt rank; 1404 char type[256]; 1405 1406 ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 1407 ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 1408 if (!rank) { 1409 ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 1410 ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr); 1411 ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 1412 } 1413 if (ts->ops->view) { 1414 ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1415 } 1416 ierr = DMView(ts->dm,viewer);CHKERRQ(ierr); 1417 ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr); 1418 ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 1419 ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 1420 } else if (isdraw) { 1421 PetscDraw draw; 1422 char str[36]; 1423 PetscReal x,y,bottom,h; 1424 1425 ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 1426 ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 1427 ierr = PetscStrcpy(str,"TS: ");CHKERRQ(ierr); 1428 ierr = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr); 1429 ierr = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 1430 bottom = y - h; 1431 ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 1432 if (ts->ops->view) { 1433 ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1434 } 1435 ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 1436 #if defined(PETSC_HAVE_SAWS) 1437 } else if (isams) { 1438 PetscMPIInt rank; 1439 const char *name; 1440 1441 ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr); 1442 ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 1443 if (!((PetscObject)ts)->amsmem && !rank) { 1444 char dir[1024]; 1445 1446 ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr); 1447 ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr); 1448 PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT)); 1449 ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr); 1450 PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE)); 1451 } 1452 if (ts->ops->view) { 1453 ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1454 } 1455 #endif 1456 } 1457 1458 ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1459 ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr); 1460 ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1461 PetscFunctionReturn(0); 1462 } 1463 1464 1465 #undef __FUNCT__ 1466 #define __FUNCT__ "TSSetApplicationContext" 1467 /*@ 1468 TSSetApplicationContext - Sets an optional user-defined context for 1469 the timesteppers. 1470 1471 Logically Collective on TS 1472 1473 Input Parameters: 1474 + ts - the TS context obtained from TSCreate() 1475 - usrP - optional user context 1476 1477 Level: intermediate 1478 1479 .keywords: TS, timestep, set, application, context 1480 1481 .seealso: TSGetApplicationContext() 1482 @*/ 1483 PetscErrorCode TSSetApplicationContext(TS ts,void *usrP) 1484 { 1485 PetscFunctionBegin; 1486 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1487 ts->user = usrP; 1488 PetscFunctionReturn(0); 1489 } 1490 1491 #undef __FUNCT__ 1492 #define __FUNCT__ "TSGetApplicationContext" 1493 /*@ 1494 TSGetApplicationContext - Gets the user-defined context for the 1495 timestepper. 1496 1497 Not Collective 1498 1499 Input Parameter: 1500 . ts - the TS context obtained from TSCreate() 1501 1502 Output Parameter: 1503 . usrP - user context 1504 1505 Level: intermediate 1506 1507 .keywords: TS, timestep, get, application, context 1508 1509 .seealso: TSSetApplicationContext() 1510 @*/ 1511 PetscErrorCode TSGetApplicationContext(TS ts,void *usrP) 1512 { 1513 PetscFunctionBegin; 1514 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1515 *(void**)usrP = ts->user; 1516 PetscFunctionReturn(0); 1517 } 1518 1519 #undef __FUNCT__ 1520 #define __FUNCT__ "TSGetTimeStepNumber" 1521 /*@ 1522 TSGetTimeStepNumber - Gets the number of time steps completed. 1523 1524 Not Collective 1525 1526 Input Parameter: 1527 . ts - the TS context obtained from TSCreate() 1528 1529 Output Parameter: 1530 . iter - number of steps completed so far 1531 1532 Level: intermediate 1533 1534 .keywords: TS, timestep, get, iteration, number 1535 .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep() 1536 @*/ 1537 PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *iter) 1538 { 1539 PetscFunctionBegin; 1540 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1541 PetscValidIntPointer(iter,2); 1542 *iter = ts->steps; 1543 PetscFunctionReturn(0); 1544 } 1545 1546 #undef __FUNCT__ 1547 #define __FUNCT__ "TSSetInitialTimeStep" 1548 /*@ 1549 TSSetInitialTimeStep - Sets the initial timestep to be used, 1550 as well as the initial time. 1551 1552 Logically Collective on TS 1553 1554 Input Parameters: 1555 + ts - the TS context obtained from TSCreate() 1556 . initial_time - the initial time 1557 - time_step - the size of the timestep 1558 1559 Level: intermediate 1560 1561 .seealso: TSSetTimeStep(), TSGetTimeStep() 1562 1563 .keywords: TS, set, initial, timestep 1564 @*/ 1565 PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step) 1566 { 1567 PetscErrorCode ierr; 1568 1569 PetscFunctionBegin; 1570 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1571 ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 1572 ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr); 1573 PetscFunctionReturn(0); 1574 } 1575 1576 #undef __FUNCT__ 1577 #define __FUNCT__ "TSSetTimeStep" 1578 /*@ 1579 TSSetTimeStep - Allows one to reset the timestep at any time, 1580 useful for simple pseudo-timestepping codes. 1581 1582 Logically Collective on TS 1583 1584 Input Parameters: 1585 + ts - the TS context obtained from TSCreate() 1586 - time_step - the size of the timestep 1587 1588 Level: intermediate 1589 1590 .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1591 1592 .keywords: TS, set, timestep 1593 @*/ 1594 PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step) 1595 { 1596 PetscFunctionBegin; 1597 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1598 PetscValidLogicalCollectiveReal(ts,time_step,2); 1599 ts->time_step = time_step; 1600 ts->time_step_orig = time_step; 1601 PetscFunctionReturn(0); 1602 } 1603 1604 #undef __FUNCT__ 1605 #define __FUNCT__ "TSSetExactFinalTime" 1606 /*@ 1607 TSSetExactFinalTime - Determines whether to adapt the final time step to 1608 match the exact final time, interpolate solution to the exact final time, 1609 or just return at the final time TS computed. 1610 1611 Logically Collective on TS 1612 1613 Input Parameter: 1614 + ts - the time-step context 1615 - eftopt - exact final time option 1616 1617 Level: beginner 1618 1619 .seealso: TSExactFinalTimeOption 1620 @*/ 1621 PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt) 1622 { 1623 PetscFunctionBegin; 1624 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1625 PetscValidLogicalCollectiveEnum(ts,eftopt,2); 1626 ts->exact_final_time = eftopt; 1627 PetscFunctionReturn(0); 1628 } 1629 1630 #undef __FUNCT__ 1631 #define __FUNCT__ "TSGetTimeStep" 1632 /*@ 1633 TSGetTimeStep - Gets the current timestep size. 1634 1635 Not Collective 1636 1637 Input Parameter: 1638 . ts - the TS context obtained from TSCreate() 1639 1640 Output Parameter: 1641 . dt - the current timestep size 1642 1643 Level: intermediate 1644 1645 .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1646 1647 .keywords: TS, get, timestep 1648 @*/ 1649 PetscErrorCode TSGetTimeStep(TS ts,PetscReal *dt) 1650 { 1651 PetscFunctionBegin; 1652 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1653 PetscValidRealPointer(dt,2); 1654 *dt = ts->time_step; 1655 PetscFunctionReturn(0); 1656 } 1657 1658 #undef __FUNCT__ 1659 #define __FUNCT__ "TSGetSolution" 1660 /*@ 1661 TSGetSolution - Returns the solution at the present timestep. It 1662 is valid to call this routine inside the function that you are evaluating 1663 in order to move to the new timestep. This vector not changed until 1664 the solution at the next timestep has been calculated. 1665 1666 Not Collective, but Vec returned is parallel if TS is parallel 1667 1668 Input Parameter: 1669 . ts - the TS context obtained from TSCreate() 1670 1671 Output Parameter: 1672 . v - the vector containing the solution 1673 1674 Level: intermediate 1675 1676 .seealso: TSGetTimeStep() 1677 1678 .keywords: TS, timestep, get, solution 1679 @*/ 1680 PetscErrorCode TSGetSolution(TS ts,Vec *v) 1681 { 1682 PetscFunctionBegin; 1683 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1684 PetscValidPointer(v,2); 1685 *v = ts->vec_sol; 1686 PetscFunctionReturn(0); 1687 } 1688 1689 /* ----- Routines to initialize and destroy a timestepper ---- */ 1690 #undef __FUNCT__ 1691 #define __FUNCT__ "TSSetProblemType" 1692 /*@ 1693 TSSetProblemType - Sets the type of problem to be solved. 1694 1695 Not collective 1696 1697 Input Parameters: 1698 + ts - The TS 1699 - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 1700 .vb 1701 U_t - A U = 0 (linear) 1702 U_t - A(t) U = 0 (linear) 1703 F(t,U,U_t) = 0 (nonlinear) 1704 .ve 1705 1706 Level: beginner 1707 1708 .keywords: TS, problem type 1709 .seealso: TSSetUp(), TSProblemType, TS 1710 @*/ 1711 PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 1712 { 1713 PetscErrorCode ierr; 1714 1715 PetscFunctionBegin; 1716 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1717 ts->problem_type = type; 1718 if (type == TS_LINEAR) { 1719 SNES snes; 1720 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1721 ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr); 1722 } 1723 PetscFunctionReturn(0); 1724 } 1725 1726 #undef __FUNCT__ 1727 #define __FUNCT__ "TSGetProblemType" 1728 /*@C 1729 TSGetProblemType - Gets the type of problem to be solved. 1730 1731 Not collective 1732 1733 Input Parameter: 1734 . ts - The TS 1735 1736 Output Parameter: 1737 . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 1738 .vb 1739 M U_t = A U 1740 M(t) U_t = A(t) U 1741 F(t,U,U_t) 1742 .ve 1743 1744 Level: beginner 1745 1746 .keywords: TS, problem type 1747 .seealso: TSSetUp(), TSProblemType, TS 1748 @*/ 1749 PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 1750 { 1751 PetscFunctionBegin; 1752 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1753 PetscValidIntPointer(type,2); 1754 *type = ts->problem_type; 1755 PetscFunctionReturn(0); 1756 } 1757 1758 #undef __FUNCT__ 1759 #define __FUNCT__ "TSSetUp" 1760 /*@ 1761 TSSetUp - Sets up the internal data structures for the later use 1762 of a timestepper. 1763 1764 Collective on TS 1765 1766 Input Parameter: 1767 . ts - the TS context obtained from TSCreate() 1768 1769 Notes: 1770 For basic use of the TS solvers the user need not explicitly call 1771 TSSetUp(), since these actions will automatically occur during 1772 the call to TSStep(). However, if one wishes to control this 1773 phase separately, TSSetUp() should be called after TSCreate() 1774 and optional routines of the form TSSetXXX(), but before TSStep(). 1775 1776 Level: advanced 1777 1778 .keywords: TS, timestep, setup 1779 1780 .seealso: TSCreate(), TSStep(), TSDestroy() 1781 @*/ 1782 PetscErrorCode TSSetUp(TS ts) 1783 { 1784 PetscErrorCode ierr; 1785 DM dm; 1786 PetscErrorCode (*func)(SNES,Vec,Vec,void*); 1787 PetscErrorCode (*jac)(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 1788 TSIJacobian ijac; 1789 TSRHSJacobian rhsjac; 1790 1791 PetscFunctionBegin; 1792 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1793 if (ts->setupcalled) PetscFunctionReturn(0); 1794 1795 if (!((PetscObject)ts)->type_name) { 1796 ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr); 1797 } 1798 1799 if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first"); 1800 1801 ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 1802 1803 if (ts->rhsjacobian.reuse) { 1804 Mat Amat,Pmat; 1805 SNES snes; 1806 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1807 ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr); 1808 /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would 1809 * have displaced the RHS matrix */ 1810 if (Amat == ts->Arhs) { 1811 ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr); 1812 ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr); 1813 ierr = MatDestroy(&Amat);CHKERRQ(ierr); 1814 } 1815 if (Pmat == ts->Brhs) { 1816 ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr); 1817 ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr); 1818 ierr = MatDestroy(&Pmat);CHKERRQ(ierr); 1819 } 1820 } 1821 1822 if (ts->ops->setup) { 1823 ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr); 1824 } 1825 1826 /* in the case where we've set a DMTSFunction or what have you, we need the default SNESFunction 1827 to be set right but can't do it elsewhere due to the overreliance on ctx=ts. 1828 */ 1829 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1830 ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr); 1831 if (!func) { 1832 ierr =DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr); 1833 } 1834 /* if the SNES doesn't have a jacobian set and the TS has an ijacobian or rhsjacobian set, set the SNES to use it. 1835 Otherwise, the SNES will use coloring internally to form the Jacobian. 1836 */ 1837 ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr); 1838 ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr); 1839 ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr); 1840 if (!jac && (ijac || rhsjac)) { 1841 ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1842 } 1843 ts->setupcalled = PETSC_TRUE; 1844 PetscFunctionReturn(0); 1845 } 1846 1847 #undef __FUNCT__ 1848 #define __FUNCT__ "TSReset" 1849 /*@ 1850 TSReset - Resets a TS context and removes any allocated Vecs and Mats. 1851 1852 Collective on TS 1853 1854 Input Parameter: 1855 . ts - the TS context obtained from TSCreate() 1856 1857 Level: beginner 1858 1859 .keywords: TS, timestep, reset 1860 1861 .seealso: TSCreate(), TSSetup(), TSDestroy() 1862 @*/ 1863 PetscErrorCode TSReset(TS ts) 1864 { 1865 PetscErrorCode ierr; 1866 1867 PetscFunctionBegin; 1868 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1869 if (ts->ops->reset) { 1870 ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr); 1871 } 1872 if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);} 1873 1874 ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 1875 ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1876 ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr); 1877 ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 1878 ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 1879 ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 1880 ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr); 1881 1882 ts->setupcalled = PETSC_FALSE; 1883 PetscFunctionReturn(0); 1884 } 1885 1886 #undef __FUNCT__ 1887 #define __FUNCT__ "TSDestroy" 1888 /*@ 1889 TSDestroy - Destroys the timestepper context that was created 1890 with TSCreate(). 1891 1892 Collective on TS 1893 1894 Input Parameter: 1895 . ts - the TS context obtained from TSCreate() 1896 1897 Level: beginner 1898 1899 .keywords: TS, timestepper, destroy 1900 1901 .seealso: TSCreate(), TSSetUp(), TSSolve() 1902 @*/ 1903 PetscErrorCode TSDestroy(TS *ts) 1904 { 1905 PetscErrorCode ierr; 1906 1907 PetscFunctionBegin; 1908 if (!*ts) PetscFunctionReturn(0); 1909 PetscValidHeaderSpecific((*ts),TS_CLASSID,1); 1910 if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);} 1911 1912 ierr = TSReset((*ts));CHKERRQ(ierr); 1913 1914 /* if memory was published with SAWs then destroy it */ 1915 ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr); 1916 if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);} 1917 1918 ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr); 1919 ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr); 1920 ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr); 1921 ierr = TSMonitorCancel((*ts));CHKERRQ(ierr); 1922 1923 ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr); 1924 PetscFunctionReturn(0); 1925 } 1926 1927 #undef __FUNCT__ 1928 #define __FUNCT__ "TSGetSNES" 1929 /*@ 1930 TSGetSNES - Returns the SNES (nonlinear solver) associated with 1931 a TS (timestepper) context. Valid only for nonlinear problems. 1932 1933 Not Collective, but SNES is parallel if TS is parallel 1934 1935 Input Parameter: 1936 . ts - the TS context obtained from TSCreate() 1937 1938 Output Parameter: 1939 . snes - the nonlinear solver context 1940 1941 Notes: 1942 The user can then directly manipulate the SNES context to set various 1943 options, etc. Likewise, the user can then extract and manipulate the 1944 KSP, KSP, and PC contexts as well. 1945 1946 TSGetSNES() does not work for integrators that do not use SNES; in 1947 this case TSGetSNES() returns NULL in snes. 1948 1949 Level: beginner 1950 1951 .keywords: timestep, get, SNES 1952 @*/ 1953 PetscErrorCode TSGetSNES(TS ts,SNES *snes) 1954 { 1955 PetscErrorCode ierr; 1956 1957 PetscFunctionBegin; 1958 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1959 PetscValidPointer(snes,2); 1960 if (!ts->snes) { 1961 ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr); 1962 ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 1963 ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr); 1964 ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr); 1965 if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 1966 if (ts->problem_type == TS_LINEAR) { 1967 ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); 1968 } 1969 } 1970 *snes = ts->snes; 1971 PetscFunctionReturn(0); 1972 } 1973 1974 #undef __FUNCT__ 1975 #define __FUNCT__ "TSSetSNES" 1976 /*@ 1977 TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context 1978 1979 Collective 1980 1981 Input Parameter: 1982 + ts - the TS context obtained from TSCreate() 1983 - snes - the nonlinear solver context 1984 1985 Notes: 1986 Most users should have the TS created by calling TSGetSNES() 1987 1988 Level: developer 1989 1990 .keywords: timestep, set, SNES 1991 @*/ 1992 PetscErrorCode TSSetSNES(TS ts,SNES snes) 1993 { 1994 PetscErrorCode ierr; 1995 PetscErrorCode (*func)(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 1996 1997 PetscFunctionBegin; 1998 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1999 PetscValidHeaderSpecific(snes,SNES_CLASSID,2); 2000 ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr); 2001 ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr); 2002 2003 ts->snes = snes; 2004 2005 ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 2006 ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr); 2007 if (func == SNESTSFormJacobian) { 2008 ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr); 2009 } 2010 PetscFunctionReturn(0); 2011 } 2012 2013 #undef __FUNCT__ 2014 #define __FUNCT__ "TSGetKSP" 2015 /*@ 2016 TSGetKSP - Returns the KSP (linear solver) associated with 2017 a TS (timestepper) context. 2018 2019 Not Collective, but KSP is parallel if TS is parallel 2020 2021 Input Parameter: 2022 . ts - the TS context obtained from TSCreate() 2023 2024 Output Parameter: 2025 . ksp - the nonlinear solver context 2026 2027 Notes: 2028 The user can then directly manipulate the KSP context to set various 2029 options, etc. Likewise, the user can then extract and manipulate the 2030 KSP and PC contexts as well. 2031 2032 TSGetKSP() does not work for integrators that do not use KSP; 2033 in this case TSGetKSP() returns NULL in ksp. 2034 2035 Level: beginner 2036 2037 .keywords: timestep, get, KSP 2038 @*/ 2039 PetscErrorCode TSGetKSP(TS ts,KSP *ksp) 2040 { 2041 PetscErrorCode ierr; 2042 SNES snes; 2043 2044 PetscFunctionBegin; 2045 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2046 PetscValidPointer(ksp,2); 2047 if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first"); 2048 if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()"); 2049 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2050 ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr); 2051 PetscFunctionReturn(0); 2052 } 2053 2054 /* ----------- Routines to set solver parameters ---------- */ 2055 2056 #undef __FUNCT__ 2057 #define __FUNCT__ "TSGetDuration" 2058 /*@ 2059 TSGetDuration - Gets the maximum number of timesteps to use and 2060 maximum time for iteration. 2061 2062 Not Collective 2063 2064 Input Parameters: 2065 + ts - the TS context obtained from TSCreate() 2066 . maxsteps - maximum number of iterations to use, or NULL 2067 - maxtime - final time to iterate to, or NULL 2068 2069 Level: intermediate 2070 2071 .keywords: TS, timestep, get, maximum, iterations, time 2072 @*/ 2073 PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 2074 { 2075 PetscFunctionBegin; 2076 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2077 if (maxsteps) { 2078 PetscValidIntPointer(maxsteps,2); 2079 *maxsteps = ts->max_steps; 2080 } 2081 if (maxtime) { 2082 PetscValidScalarPointer(maxtime,3); 2083 *maxtime = ts->max_time; 2084 } 2085 PetscFunctionReturn(0); 2086 } 2087 2088 #undef __FUNCT__ 2089 #define __FUNCT__ "TSSetDuration" 2090 /*@ 2091 TSSetDuration - Sets the maximum number of timesteps to use and 2092 maximum time for iteration. 2093 2094 Logically Collective on TS 2095 2096 Input Parameters: 2097 + ts - the TS context obtained from TSCreate() 2098 . maxsteps - maximum number of iterations to use 2099 - maxtime - final time to iterate to 2100 2101 Options Database Keys: 2102 . -ts_max_steps <maxsteps> - Sets maxsteps 2103 . -ts_final_time <maxtime> - Sets maxtime 2104 2105 Notes: 2106 The default maximum number of iterations is 5000. Default time is 5.0 2107 2108 Level: intermediate 2109 2110 .keywords: TS, timestep, set, maximum, iterations 2111 2112 .seealso: TSSetExactFinalTime() 2113 @*/ 2114 PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime) 2115 { 2116 PetscFunctionBegin; 2117 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2118 PetscValidLogicalCollectiveInt(ts,maxsteps,2); 2119 PetscValidLogicalCollectiveReal(ts,maxtime,2); 2120 if (maxsteps >= 0) ts->max_steps = maxsteps; 2121 if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime; 2122 PetscFunctionReturn(0); 2123 } 2124 2125 #undef __FUNCT__ 2126 #define __FUNCT__ "TSSetSolution" 2127 /*@ 2128 TSSetSolution - Sets the initial solution vector 2129 for use by the TS routines. 2130 2131 Logically Collective on TS and Vec 2132 2133 Input Parameters: 2134 + ts - the TS context obtained from TSCreate() 2135 - u - the solution vector 2136 2137 Level: beginner 2138 2139 .keywords: TS, timestep, set, solution, initial conditions 2140 @*/ 2141 PetscErrorCode TSSetSolution(TS ts,Vec u) 2142 { 2143 PetscErrorCode ierr; 2144 DM dm; 2145 2146 PetscFunctionBegin; 2147 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2148 PetscValidHeaderSpecific(u,VEC_CLASSID,2); 2149 ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr); 2150 ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 2151 2152 ts->vec_sol = u; 2153 2154 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 2155 ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr); 2156 PetscFunctionReturn(0); 2157 } 2158 2159 #undef __FUNCT__ 2160 #define __FUNCT__ "TSSetPreStep" 2161 /*@C 2162 TSSetPreStep - Sets the general-purpose function 2163 called once at the beginning of each time step. 2164 2165 Logically Collective on TS 2166 2167 Input Parameters: 2168 + ts - The TS context obtained from TSCreate() 2169 - func - The function 2170 2171 Calling sequence of func: 2172 . func (TS ts); 2173 2174 Level: intermediate 2175 2176 Note: 2177 If a step is rejected, TSStep() will call this routine again before each attempt. 2178 The last completed time step number can be queried using TSGetTimeStepNumber(), the 2179 size of the step being attempted can be obtained using TSGetTimeStep(). 2180 2181 .keywords: TS, timestep 2182 .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep() 2183 @*/ 2184 PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS)) 2185 { 2186 PetscFunctionBegin; 2187 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2188 ts->prestep = func; 2189 PetscFunctionReturn(0); 2190 } 2191 2192 #undef __FUNCT__ 2193 #define __FUNCT__ "TSPreStep" 2194 /*@ 2195 TSPreStep - Runs the user-defined pre-step function. 2196 2197 Collective on TS 2198 2199 Input Parameters: 2200 . ts - The TS context obtained from TSCreate() 2201 2202 Notes: 2203 TSPreStep() is typically used within time stepping implementations, 2204 so most users would not generally call this routine themselves. 2205 2206 Level: developer 2207 2208 .keywords: TS, timestep 2209 .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep() 2210 @*/ 2211 PetscErrorCode TSPreStep(TS ts) 2212 { 2213 PetscErrorCode ierr; 2214 2215 PetscFunctionBegin; 2216 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2217 if (ts->prestep) { 2218 PetscStackCallStandard((*ts->prestep),(ts)); 2219 } 2220 PetscFunctionReturn(0); 2221 } 2222 2223 #undef __FUNCT__ 2224 #define __FUNCT__ "TSSetPreStage" 2225 /*@C 2226 TSSetPreStage - Sets the general-purpose function 2227 called once at the beginning of each stage. 2228 2229 Logically Collective on TS 2230 2231 Input Parameters: 2232 + ts - The TS context obtained from TSCreate() 2233 - func - The function 2234 2235 Calling sequence of func: 2236 . PetscErrorCode func(TS ts, PetscReal stagetime); 2237 2238 Level: intermediate 2239 2240 Note: 2241 There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 2242 The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 2243 attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 2244 2245 .keywords: TS, timestep 2246 .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 2247 @*/ 2248 PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal)) 2249 { 2250 PetscFunctionBegin; 2251 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2252 ts->prestage = func; 2253 PetscFunctionReturn(0); 2254 } 2255 2256 #undef __FUNCT__ 2257 #define __FUNCT__ "TSSetPostStage" 2258 /*@C 2259 TSSetPostStage - Sets the general-purpose function 2260 called once at the end of each stage. 2261 2262 Logically Collective on TS 2263 2264 Input Parameters: 2265 + ts - The TS context obtained from TSCreate() 2266 - func - The function 2267 2268 Calling sequence of func: 2269 . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y); 2270 2271 Level: intermediate 2272 2273 Note: 2274 There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 2275 The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 2276 attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 2277 2278 .keywords: TS, timestep 2279 .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 2280 @*/ 2281 PetscErrorCode TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*)) 2282 { 2283 PetscFunctionBegin; 2284 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2285 ts->poststage = func; 2286 PetscFunctionReturn(0); 2287 } 2288 2289 #undef __FUNCT__ 2290 #define __FUNCT__ "TSPreStage" 2291 /*@ 2292 TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage() 2293 2294 Collective on TS 2295 2296 Input Parameters: 2297 . ts - The TS context obtained from TSCreate() 2298 stagetime - The absolute time of the current stage 2299 2300 Notes: 2301 TSPreStage() is typically used within time stepping implementations, 2302 most users would not generally call this routine themselves. 2303 2304 Level: developer 2305 2306 .keywords: TS, timestep 2307 .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 2308 @*/ 2309 PetscErrorCode TSPreStage(TS ts, PetscReal stagetime) 2310 { 2311 PetscErrorCode ierr; 2312 2313 PetscFunctionBegin; 2314 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2315 if (ts->prestage) { 2316 PetscStackCallStandard((*ts->prestage),(ts,stagetime)); 2317 } 2318 PetscFunctionReturn(0); 2319 } 2320 2321 #undef __FUNCT__ 2322 #define __FUNCT__ "TSPostStage" 2323 /*@ 2324 TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage() 2325 2326 Collective on TS 2327 2328 Input Parameters: 2329 . ts - The TS context obtained from TSCreate() 2330 stagetime - The absolute time of the current stage 2331 stageindex - Stage number 2332 Y - Array of vectors (of size = total number 2333 of stages) with the stage solutions 2334 2335 Notes: 2336 TSPostStage() is typically used within time stepping implementations, 2337 most users would not generally call this routine themselves. 2338 2339 Level: developer 2340 2341 .keywords: TS, timestep 2342 .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 2343 @*/ 2344 PetscErrorCode TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y) 2345 { 2346 PetscErrorCode ierr; 2347 2348 PetscFunctionBegin; 2349 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2350 if (ts->prestage) { 2351 PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y)); 2352 } 2353 PetscFunctionReturn(0); 2354 } 2355 2356 #undef __FUNCT__ 2357 #define __FUNCT__ "TSSetPostStep" 2358 /*@C 2359 TSSetPostStep - Sets the general-purpose function 2360 called once at the end of each time step. 2361 2362 Logically Collective on TS 2363 2364 Input Parameters: 2365 + ts - The TS context obtained from TSCreate() 2366 - func - The function 2367 2368 Calling sequence of func: 2369 $ func (TS ts); 2370 2371 Level: intermediate 2372 2373 .keywords: TS, timestep 2374 .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime() 2375 @*/ 2376 PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS)) 2377 { 2378 PetscFunctionBegin; 2379 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2380 ts->poststep = func; 2381 PetscFunctionReturn(0); 2382 } 2383 2384 #undef __FUNCT__ 2385 #define __FUNCT__ "TSPostStep" 2386 /*@ 2387 TSPostStep - Runs the user-defined post-step function. 2388 2389 Collective on TS 2390 2391 Input Parameters: 2392 . ts - The TS context obtained from TSCreate() 2393 2394 Notes: 2395 TSPostStep() is typically used within time stepping implementations, 2396 so most users would not generally call this routine themselves. 2397 2398 Level: developer 2399 2400 .keywords: TS, timestep 2401 @*/ 2402 PetscErrorCode TSPostStep(TS ts) 2403 { 2404 PetscErrorCode ierr; 2405 2406 PetscFunctionBegin; 2407 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2408 if (ts->poststep) { 2409 PetscStackCallStandard((*ts->poststep),(ts)); 2410 } 2411 PetscFunctionReturn(0); 2412 } 2413 2414 /* ------------ Routines to set performance monitoring options ----------- */ 2415 2416 #undef __FUNCT__ 2417 #define __FUNCT__ "TSMonitorSet" 2418 /*@C 2419 TSMonitorSet - Sets an ADDITIONAL function that is to be used at every 2420 timestep to display the iteration's progress. 2421 2422 Logically Collective on TS 2423 2424 Input Parameters: 2425 + ts - the TS context obtained from TSCreate() 2426 . monitor - monitoring routine 2427 . mctx - [optional] user-defined context for private data for the 2428 monitor routine (use NULL if no context is desired) 2429 - monitordestroy - [optional] routine that frees monitor context 2430 (may be NULL) 2431 2432 Calling sequence of monitor: 2433 $ int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx) 2434 2435 + ts - the TS context 2436 . steps - iteration number (after the final time step the monitor routine is called with a step of -1, this is at the final time which may have 2437 been interpolated to) 2438 . time - current time 2439 . u - current iterate 2440 - mctx - [optional] monitoring context 2441 2442 Notes: 2443 This routine adds an additional monitor to the list of monitors that 2444 already has been loaded. 2445 2446 Fortran notes: Only a single monitor function can be set for each TS object 2447 2448 Level: intermediate 2449 2450 .keywords: TS, timestep, set, monitor 2451 2452 .seealso: TSMonitorDefault(), TSMonitorCancel() 2453 @*/ 2454 PetscErrorCode TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**)) 2455 { 2456 PetscFunctionBegin; 2457 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2458 if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 2459 ts->monitor[ts->numbermonitors] = monitor; 2460 ts->monitordestroy[ts->numbermonitors] = mdestroy; 2461 ts->monitorcontext[ts->numbermonitors++] = (void*)mctx; 2462 PetscFunctionReturn(0); 2463 } 2464 2465 #undef __FUNCT__ 2466 #define __FUNCT__ "TSMonitorCancel" 2467 /*@C 2468 TSMonitorCancel - Clears all the monitors that have been set on a time-step object. 2469 2470 Logically Collective on TS 2471 2472 Input Parameters: 2473 . ts - the TS context obtained from TSCreate() 2474 2475 Notes: 2476 There is no way to remove a single, specific monitor. 2477 2478 Level: intermediate 2479 2480 .keywords: TS, timestep, set, monitor 2481 2482 .seealso: TSMonitorDefault(), TSMonitorSet() 2483 @*/ 2484 PetscErrorCode TSMonitorCancel(TS ts) 2485 { 2486 PetscErrorCode ierr; 2487 PetscInt i; 2488 2489 PetscFunctionBegin; 2490 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2491 for (i=0; i<ts->numbermonitors; i++) { 2492 if (ts->monitordestroy[i]) { 2493 ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr); 2494 } 2495 } 2496 ts->numbermonitors = 0; 2497 PetscFunctionReturn(0); 2498 } 2499 2500 #undef __FUNCT__ 2501 #define __FUNCT__ "TSMonitorDefault" 2502 /*@ 2503 TSMonitorDefault - Sets the Default monitor 2504 2505 Level: intermediate 2506 2507 .keywords: TS, set, monitor 2508 2509 .seealso: TSMonitorDefault(), TSMonitorSet() 2510 @*/ 2511 PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy) 2512 { 2513 PetscErrorCode ierr; 2514 PetscViewer viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)ts)); 2515 2516 PetscFunctionBegin; 2517 ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 2518 ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g\n",step,(double)ts->time_step,(double)ptime);CHKERRQ(ierr); 2519 ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 2520 PetscFunctionReturn(0); 2521 } 2522 2523 #undef __FUNCT__ 2524 #define __FUNCT__ "TSSetRetainStages" 2525 /*@ 2526 TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available. 2527 2528 Logically Collective on TS 2529 2530 Input Argument: 2531 . ts - time stepping context 2532 2533 Output Argument: 2534 . flg - PETSC_TRUE or PETSC_FALSE 2535 2536 Level: intermediate 2537 2538 .keywords: TS, set 2539 2540 .seealso: TSInterpolate(), TSSetPostStep() 2541 @*/ 2542 PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg) 2543 { 2544 PetscFunctionBegin; 2545 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2546 ts->retain_stages = flg; 2547 PetscFunctionReturn(0); 2548 } 2549 2550 #undef __FUNCT__ 2551 #define __FUNCT__ "TSInterpolate" 2552 /*@ 2553 TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval 2554 2555 Collective on TS 2556 2557 Input Argument: 2558 + ts - time stepping context 2559 - t - time to interpolate to 2560 2561 Output Argument: 2562 . U - state at given time 2563 2564 Notes: 2565 The user should call TSSetRetainStages() before taking a step in which interpolation will be requested. 2566 2567 Level: intermediate 2568 2569 Developer Notes: 2570 TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints. 2571 2572 .keywords: TS, set 2573 2574 .seealso: TSSetRetainStages(), TSSetPostStep() 2575 @*/ 2576 PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U) 2577 { 2578 PetscErrorCode ierr; 2579 2580 PetscFunctionBegin; 2581 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2582 PetscValidHeaderSpecific(U,VEC_CLASSID,3); 2583 if (t < ts->ptime - ts->time_step_prev || t > ts->ptime) SETERRQ3(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Requested time %g not in last time steps [%g,%g]",t,(double)(ts->ptime-ts->time_step_prev),(double)ts->ptime); 2584 if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name); 2585 ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr); 2586 PetscFunctionReturn(0); 2587 } 2588 2589 #undef __FUNCT__ 2590 #define __FUNCT__ "TSStep" 2591 /*@ 2592 TSStep - Steps one time step 2593 2594 Collective on TS 2595 2596 Input Parameter: 2597 . ts - the TS context obtained from TSCreate() 2598 2599 Level: intermediate 2600 2601 Notes: 2602 The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may 2603 be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages. 2604 2605 This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the 2606 time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep. 2607 2608 .keywords: TS, timestep, solve 2609 2610 .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate() 2611 @*/ 2612 PetscErrorCode TSStep(TS ts) 2613 { 2614 PetscReal ptime_prev; 2615 PetscErrorCode ierr; 2616 static PetscBool cite = PETSC_FALSE; 2617 2618 PetscFunctionBegin; 2619 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2620 ierr = PetscCitationsRegister("@techreport{tspaper,\n" 2621 " title = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n" 2622 " author = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n" 2623 " type = {Preprint},\n" 2624 " number = {ANL/MCS-P5061-0114},\n" 2625 " institution = {Argonne National Laboratory},\n" 2626 " year = {2014}\n}\n",&cite); 2627 2628 ierr = TSSetUp(ts);CHKERRQ(ierr); 2629 2630 ts->reason = TS_CONVERGED_ITERATING; 2631 ptime_prev = ts->ptime; 2632 2633 ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 2634 ierr = (*ts->ops->step)(ts);CHKERRQ(ierr); 2635 ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 2636 2637 ts->time_step_prev = ts->ptime - ptime_prev; 2638 2639 if (ts->reason < 0) { 2640 if (ts->errorifstepfailed) { 2641 if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) { 2642 SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_snes_failures or make negative to attempt recovery",TSConvergedReasons[ts->reason]); 2643 } else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 2644 } 2645 } else if (!ts->reason) { 2646 if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 2647 else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 2648 } 2649 PetscFunctionReturn(0); 2650 } 2651 2652 #undef __FUNCT__ 2653 #define __FUNCT__ "TSEvaluateStep" 2654 /*@ 2655 TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy. 2656 2657 Collective on TS 2658 2659 Input Arguments: 2660 + ts - time stepping context 2661 . order - desired order of accuracy 2662 - done - whether the step was evaluated at this order (pass NULL to generate an error if not available) 2663 2664 Output Arguments: 2665 . U - state at the end of the current step 2666 2667 Level: advanced 2668 2669 Notes: 2670 This function cannot be called until all stages have been evaluated. 2671 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. 2672 2673 .seealso: TSStep(), TSAdapt 2674 @*/ 2675 PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done) 2676 { 2677 PetscErrorCode ierr; 2678 2679 PetscFunctionBegin; 2680 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2681 PetscValidType(ts,1); 2682 PetscValidHeaderSpecific(U,VEC_CLASSID,3); 2683 if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name); 2684 ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr); 2685 PetscFunctionReturn(0); 2686 } 2687 2688 #undef __FUNCT__ 2689 #define __FUNCT__ "TSSolve" 2690 /*@ 2691 TSSolve - Steps the requested number of timesteps. 2692 2693 Collective on TS 2694 2695 Input Parameter: 2696 + ts - the TS context obtained from TSCreate() 2697 - u - the solution vector (can be null if TSSetSolution() was used, otherwise must contain the initial conditions) 2698 2699 Level: beginner 2700 2701 Notes: 2702 The final time returned by this function may be different from the time of the internally 2703 held state accessible by TSGetSolution() and TSGetTime() because the method may have 2704 stepped over the final time. 2705 2706 .keywords: TS, timestep, solve 2707 2708 .seealso: TSCreate(), TSSetSolution(), TSStep() 2709 @*/ 2710 PetscErrorCode TSSolve(TS ts,Vec u) 2711 { 2712 Vec solution; 2713 PetscErrorCode ierr; 2714 2715 PetscFunctionBegin; 2716 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2717 if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2); 2718 if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE) { /* Need ts->vec_sol to be distinct so it is not overwritten when we interpolate at the end */ 2719 PetscValidHeaderSpecific(u,VEC_CLASSID,2); 2720 if (!ts->vec_sol || u == ts->vec_sol) { 2721 ierr = VecDuplicate(u,&solution);CHKERRQ(ierr); 2722 ierr = TSSetSolution(ts,solution);CHKERRQ(ierr); 2723 ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */ 2724 } 2725 ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr); 2726 } else if (u) { 2727 ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 2728 } 2729 ierr = TSSetUp(ts);CHKERRQ(ierr); 2730 /* reset time step and iteration counters */ 2731 ts->steps = 0; 2732 ts->ksp_its = 0; 2733 ts->snes_its = 0; 2734 ts->num_snes_failures = 0; 2735 ts->reject = 0; 2736 ts->reason = TS_CONVERGED_ITERATING; 2737 2738 ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr); 2739 2740 if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 2741 ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr); 2742 ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr); 2743 ts->solvetime = ts->ptime; 2744 } else { 2745 /* steps the requested number of timesteps. */ 2746 if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 2747 else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 2748 while (!ts->reason) { 2749 ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 2750 ierr = TSStep(ts);CHKERRQ(ierr); 2751 ierr = TSPostStep(ts);CHKERRQ(ierr); 2752 } 2753 if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) { 2754 ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr); 2755 ts->solvetime = ts->max_time; 2756 solution = u; 2757 } else { 2758 if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 2759 ts->solvetime = ts->ptime; 2760 solution = ts->vec_sol; 2761 } 2762 ierr = TSMonitor(ts,ts->steps,ts->solvetime,solution);CHKERRQ(ierr); 2763 } 2764 ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr); 2765 ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr); 2766 PetscFunctionReturn(0); 2767 } 2768 2769 #undef __FUNCT__ 2770 #define __FUNCT__ "TSMonitor" 2771 /*@ 2772 TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet() 2773 2774 Collective on TS 2775 2776 Input Parameters: 2777 + ts - time stepping context obtained from TSCreate() 2778 . step - step number that has just completed 2779 . ptime - model time of the state 2780 - u - state at the current model time 2781 2782 Notes: 2783 TSMonitor() is typically used within the time stepping implementations. 2784 Users might call this function when using the TSStep() interface instead of TSSolve(). 2785 2786 Level: advanced 2787 2788 .keywords: TS, timestep 2789 @*/ 2790 PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u) 2791 { 2792 PetscErrorCode ierr; 2793 PetscInt i,n = ts->numbermonitors; 2794 2795 PetscFunctionBegin; 2796 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2797 PetscValidHeaderSpecific(u,VEC_CLASSID,4); 2798 for (i=0; i<n; i++) { 2799 ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr); 2800 } 2801 PetscFunctionReturn(0); 2802 } 2803 2804 /* ------------------------------------------------------------------------*/ 2805 #undef __FUNCT__ 2806 #define __FUNCT__ "TSMonitorLGCtxCreate" 2807 /*@C 2808 TSMonitorLGCtxCreate - Creates a line graph context for use with 2809 TS to monitor the solution process graphically in various ways 2810 2811 Collective on TS 2812 2813 Input Parameters: 2814 + host - the X display to open, or null for the local machine 2815 . label - the title to put in the title bar 2816 . x, y - the screen coordinates of the upper left coordinate of the window 2817 . m, n - the screen width and height in pixels 2818 - howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time 2819 2820 Output Parameter: 2821 . ctx - the context 2822 2823 Options Database Key: 2824 + -ts_monitor_lg_timestep - automatically sets line graph monitor 2825 . -ts_monitor_lg_solution - 2826 . -ts_monitor_lg_error - 2827 . -ts_monitor_lg_ksp_iterations - 2828 . -ts_monitor_lg_snes_iterations - 2829 - -lg_indicate_data_points <true,false> - indicate the data points (at each time step) on the plot; default is true 2830 2831 Notes: 2832 Use TSMonitorLGCtxDestroy() to destroy. 2833 2834 Level: intermediate 2835 2836 .keywords: TS, monitor, line graph, residual, seealso 2837 2838 .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError() 2839 2840 @*/ 2841 PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx) 2842 { 2843 PetscDraw win; 2844 PetscErrorCode ierr; 2845 2846 PetscFunctionBegin; 2847 ierr = PetscNew(ctx);CHKERRQ(ierr); 2848 ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&win);CHKERRQ(ierr); 2849 ierr = PetscDrawSetFromOptions(win);CHKERRQ(ierr); 2850 ierr = PetscDrawLGCreate(win,1,&(*ctx)->lg);CHKERRQ(ierr); 2851 ierr = PetscLogObjectParent((PetscObject)(*ctx)->lg,(PetscObject)win);CHKERRQ(ierr); 2852 ierr = PetscDrawLGIndicateDataPoints((*ctx)->lg,PETSC_TRUE);CHKERRQ(ierr); 2853 ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr); 2854 (*ctx)->howoften = howoften; 2855 PetscFunctionReturn(0); 2856 } 2857 2858 #undef __FUNCT__ 2859 #define __FUNCT__ "TSMonitorLGTimeStep" 2860 PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx) 2861 { 2862 TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 2863 PetscReal x = ptime,y; 2864 PetscErrorCode ierr; 2865 2866 PetscFunctionBegin; 2867 if (!step) { 2868 PetscDrawAxis axis; 2869 ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 2870 ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time step");CHKERRQ(ierr); 2871 ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 2872 ierr = PetscDrawLGIndicateDataPoints(ctx->lg,PETSC_TRUE);CHKERRQ(ierr); 2873 } 2874 ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr); 2875 ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 2876 if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 2877 ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 2878 } 2879 PetscFunctionReturn(0); 2880 } 2881 2882 #undef __FUNCT__ 2883 #define __FUNCT__ "TSMonitorLGCtxDestroy" 2884 /*@C 2885 TSMonitorLGCtxDestroy - Destroys a line graph context that was created 2886 with TSMonitorLGCtxCreate(). 2887 2888 Collective on TSMonitorLGCtx 2889 2890 Input Parameter: 2891 . ctx - the monitor context 2892 2893 Level: intermediate 2894 2895 .keywords: TS, monitor, line graph, destroy 2896 2897 .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep(); 2898 @*/ 2899 PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx) 2900 { 2901 PetscDraw draw; 2902 PetscErrorCode ierr; 2903 2904 PetscFunctionBegin; 2905 ierr = PetscDrawLGGetDraw((*ctx)->lg,&draw);CHKERRQ(ierr); 2906 ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 2907 ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr); 2908 ierr = PetscFree(*ctx);CHKERRQ(ierr); 2909 PetscFunctionReturn(0); 2910 } 2911 2912 #undef __FUNCT__ 2913 #define __FUNCT__ "TSGetTime" 2914 /*@ 2915 TSGetTime - Gets the time of the most recently completed step. 2916 2917 Not Collective 2918 2919 Input Parameter: 2920 . ts - the TS context obtained from TSCreate() 2921 2922 Output Parameter: 2923 . t - the current time 2924 2925 Level: beginner 2926 2927 Note: 2928 When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(), 2929 TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated. 2930 2931 .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 2932 2933 .keywords: TS, get, time 2934 @*/ 2935 PetscErrorCode TSGetTime(TS ts,PetscReal *t) 2936 { 2937 PetscFunctionBegin; 2938 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2939 PetscValidRealPointer(t,2); 2940 *t = ts->ptime; 2941 PetscFunctionReturn(0); 2942 } 2943 2944 #undef __FUNCT__ 2945 #define __FUNCT__ "TSSetTime" 2946 /*@ 2947 TSSetTime - Allows one to reset the time. 2948 2949 Logically Collective on TS 2950 2951 Input Parameters: 2952 + ts - the TS context obtained from TSCreate() 2953 - time - the time 2954 2955 Level: intermediate 2956 2957 .seealso: TSGetTime(), TSSetDuration() 2958 2959 .keywords: TS, set, time 2960 @*/ 2961 PetscErrorCode TSSetTime(TS ts, PetscReal t) 2962 { 2963 PetscFunctionBegin; 2964 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2965 PetscValidLogicalCollectiveReal(ts,t,2); 2966 ts->ptime = t; 2967 PetscFunctionReturn(0); 2968 } 2969 2970 #undef __FUNCT__ 2971 #define __FUNCT__ "TSSetOptionsPrefix" 2972 /*@C 2973 TSSetOptionsPrefix - Sets the prefix used for searching for all 2974 TS options in the database. 2975 2976 Logically Collective on TS 2977 2978 Input Parameter: 2979 + ts - The TS context 2980 - prefix - The prefix to prepend to all option names 2981 2982 Notes: 2983 A hyphen (-) must NOT be given at the beginning of the prefix name. 2984 The first character of all runtime options is AUTOMATICALLY the 2985 hyphen. 2986 2987 Level: advanced 2988 2989 .keywords: TS, set, options, prefix, database 2990 2991 .seealso: TSSetFromOptions() 2992 2993 @*/ 2994 PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[]) 2995 { 2996 PetscErrorCode ierr; 2997 SNES snes; 2998 2999 PetscFunctionBegin; 3000 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3001 ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 3002 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3003 ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr); 3004 PetscFunctionReturn(0); 3005 } 3006 3007 3008 #undef __FUNCT__ 3009 #define __FUNCT__ "TSAppendOptionsPrefix" 3010 /*@C 3011 TSAppendOptionsPrefix - Appends to the prefix used for searching for all 3012 TS options in the database. 3013 3014 Logically Collective on TS 3015 3016 Input Parameter: 3017 + ts - The TS context 3018 - prefix - The prefix to prepend to all option names 3019 3020 Notes: 3021 A hyphen (-) must NOT be given at the beginning of the prefix name. 3022 The first character of all runtime options is AUTOMATICALLY the 3023 hyphen. 3024 3025 Level: advanced 3026 3027 .keywords: TS, append, options, prefix, database 3028 3029 .seealso: TSGetOptionsPrefix() 3030 3031 @*/ 3032 PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[]) 3033 { 3034 PetscErrorCode ierr; 3035 SNES snes; 3036 3037 PetscFunctionBegin; 3038 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3039 ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 3040 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3041 ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr); 3042 PetscFunctionReturn(0); 3043 } 3044 3045 #undef __FUNCT__ 3046 #define __FUNCT__ "TSGetOptionsPrefix" 3047 /*@C 3048 TSGetOptionsPrefix - Sets the prefix used for searching for all 3049 TS options in the database. 3050 3051 Not Collective 3052 3053 Input Parameter: 3054 . ts - The TS context 3055 3056 Output Parameter: 3057 . prefix - A pointer to the prefix string used 3058 3059 Notes: On the fortran side, the user should pass in a string 'prifix' of 3060 sufficient length to hold the prefix. 3061 3062 Level: intermediate 3063 3064 .keywords: TS, get, options, prefix, database 3065 3066 .seealso: TSAppendOptionsPrefix() 3067 @*/ 3068 PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[]) 3069 { 3070 PetscErrorCode ierr; 3071 3072 PetscFunctionBegin; 3073 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3074 PetscValidPointer(prefix,2); 3075 ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 3076 PetscFunctionReturn(0); 3077 } 3078 3079 #undef __FUNCT__ 3080 #define __FUNCT__ "TSGetRHSJacobian" 3081 /*@C 3082 TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 3083 3084 Not Collective, but parallel objects are returned if TS is parallel 3085 3086 Input Parameter: 3087 . ts - The TS context obtained from TSCreate() 3088 3089 Output Parameters: 3090 + Amat - The (approximate) Jacobian J of G, where U_t = G(U,t) (or NULL) 3091 . Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat (or NULL) 3092 . func - Function to compute the Jacobian of the RHS (or NULL) 3093 - ctx - User-defined context for Jacobian evaluation routine (or NULL) 3094 3095 Notes: You can pass in NULL for any return argument you do not need. 3096 3097 Level: intermediate 3098 3099 .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 3100 3101 .keywords: TS, timestep, get, matrix, Jacobian 3102 @*/ 3103 PetscErrorCode TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx) 3104 { 3105 PetscErrorCode ierr; 3106 SNES snes; 3107 DM dm; 3108 3109 PetscFunctionBegin; 3110 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3111 ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 3112 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 3113 ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr); 3114 PetscFunctionReturn(0); 3115 } 3116 3117 #undef __FUNCT__ 3118 #define __FUNCT__ "TSGetIJacobian" 3119 /*@C 3120 TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 3121 3122 Not Collective, but parallel objects are returned if TS is parallel 3123 3124 Input Parameter: 3125 . ts - The TS context obtained from TSCreate() 3126 3127 Output Parameters: 3128 + Amat - The (approximate) Jacobian of F(t,U,U_t) 3129 . Pmat - The matrix from which the preconditioner is constructed, often the same as Amat 3130 . f - The function to compute the matrices 3131 - ctx - User-defined context for Jacobian evaluation routine 3132 3133 Notes: You can pass in NULL for any return argument you do not need. 3134 3135 Level: advanced 3136 3137 .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 3138 3139 .keywords: TS, timestep, get, matrix, Jacobian 3140 @*/ 3141 PetscErrorCode TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx) 3142 { 3143 PetscErrorCode ierr; 3144 SNES snes; 3145 DM dm; 3146 3147 PetscFunctionBegin; 3148 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3149 ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 3150 ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 3151 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 3152 ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr); 3153 PetscFunctionReturn(0); 3154 } 3155 3156 3157 #undef __FUNCT__ 3158 #define __FUNCT__ "TSMonitorDrawSolution" 3159 /*@C 3160 TSMonitorDrawSolution - Monitors progress of the TS solvers by calling 3161 VecView() for the solution at each timestep 3162 3163 Collective on TS 3164 3165 Input Parameters: 3166 + ts - the TS context 3167 . step - current time-step 3168 . ptime - current time 3169 - dummy - either a viewer or NULL 3170 3171 Options Database: 3172 . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 3173 3174 Notes: the initial solution and current solution are not displayed with a common axis scaling so generally the option -ts_monitor_draw_solution_initial 3175 will look bad 3176 3177 Level: intermediate 3178 3179 .keywords: TS, vector, monitor, view 3180 3181 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 3182 @*/ 3183 PetscErrorCode TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 3184 { 3185 PetscErrorCode ierr; 3186 TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 3187 PetscDraw draw; 3188 3189 PetscFunctionBegin; 3190 if (!step && ictx->showinitial) { 3191 if (!ictx->initialsolution) { 3192 ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr); 3193 } 3194 ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr); 3195 } 3196 if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 3197 3198 if (ictx->showinitial) { 3199 PetscReal pause; 3200 ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr); 3201 ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr); 3202 ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr); 3203 ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr); 3204 ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr); 3205 } 3206 ierr = VecView(u,ictx->viewer);CHKERRQ(ierr); 3207 if (ictx->showtimestepandtime) { 3208 PetscReal xl,yl,xr,yr,tw,w,h; 3209 char time[32]; 3210 size_t len; 3211 3212 ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 3213 ierr = PetscSNPrintf(time,32,"Timestep %d Time %f",(int)step,(double)ptime);CHKERRQ(ierr); 3214 ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 3215 ierr = PetscStrlen(time,&len);CHKERRQ(ierr); 3216 ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr); 3217 w = xl + .5*(xr - xl) - .5*len*tw; 3218 h = yl + .95*(yr - yl); 3219 ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 3220 ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 3221 } 3222 3223 if (ictx->showinitial) { 3224 ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr); 3225 } 3226 PetscFunctionReturn(0); 3227 } 3228 3229 #undef __FUNCT__ 3230 #define __FUNCT__ "TSMonitorDrawSolutionPhase" 3231 /*@C 3232 TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram 3233 3234 Collective on TS 3235 3236 Input Parameters: 3237 + ts - the TS context 3238 . step - current time-step 3239 . ptime - current time 3240 - dummy - either a viewer or NULL 3241 3242 Level: intermediate 3243 3244 .keywords: TS, vector, monitor, view 3245 3246 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 3247 @*/ 3248 PetscErrorCode TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 3249 { 3250 PetscErrorCode ierr; 3251 TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 3252 PetscDraw draw; 3253 MPI_Comm comm; 3254 PetscInt n; 3255 PetscMPIInt size; 3256 PetscReal xl,yl,xr,yr,tw,w,h; 3257 char time[32]; 3258 size_t len; 3259 const PetscScalar *U; 3260 3261 PetscFunctionBegin; 3262 ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 3263 ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr); 3264 if (size != 1) SETERRQ(comm,PETSC_ERR_SUP,"Only allowed for sequential runs"); 3265 ierr = VecGetSize(u,&n);CHKERRQ(ierr); 3266 if (n != 2) SETERRQ(comm,PETSC_ERR_SUP,"Only for ODEs with two unknowns"); 3267 3268 ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 3269 3270 ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr); 3271 ierr = PetscDrawAxisGetLimits(ictx->axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr); 3272 if ((PetscRealPart(U[0]) < xl) || (PetscRealPart(U[1]) < yl) || (PetscRealPart(U[0]) > xr) || (PetscRealPart(U[1]) > yr)) { 3273 ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 3274 PetscFunctionReturn(0); 3275 } 3276 if (!step) ictx->color++; 3277 ierr = PetscDrawPoint(draw,PetscRealPart(U[0]),PetscRealPart(U[1]),ictx->color);CHKERRQ(ierr); 3278 ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 3279 3280 if (ictx->showtimestepandtime) { 3281 ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 3282 ierr = PetscSNPrintf(time,32,"Timestep %d Time %f",(int)step,(double)ptime);CHKERRQ(ierr); 3283 ierr = PetscStrlen(time,&len);CHKERRQ(ierr); 3284 ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr); 3285 w = xl + .5*(xr - xl) - .5*len*tw; 3286 h = yl + .95*(yr - yl); 3287 ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 3288 } 3289 ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 3290 PetscFunctionReturn(0); 3291 } 3292 3293 3294 #undef __FUNCT__ 3295 #define __FUNCT__ "TSMonitorDrawCtxDestroy" 3296 /*@C 3297 TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution() 3298 3299 Collective on TS 3300 3301 Input Parameters: 3302 . ctx - the monitor context 3303 3304 Level: intermediate 3305 3306 .keywords: TS, vector, monitor, view 3307 3308 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError() 3309 @*/ 3310 PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx) 3311 { 3312 PetscErrorCode ierr; 3313 3314 PetscFunctionBegin; 3315 ierr = PetscDrawAxisDestroy(&(*ictx)->axis);CHKERRQ(ierr); 3316 ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr); 3317 ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr); 3318 ierr = PetscFree(*ictx);CHKERRQ(ierr); 3319 PetscFunctionReturn(0); 3320 } 3321 3322 #undef __FUNCT__ 3323 #define __FUNCT__ "TSMonitorDrawCtxCreate" 3324 /*@C 3325 TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx 3326 3327 Collective on TS 3328 3329 Input Parameter: 3330 . ts - time-step context 3331 3332 Output Patameter: 3333 . ctx - the monitor context 3334 3335 Options Database: 3336 . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 3337 3338 Level: intermediate 3339 3340 .keywords: TS, vector, monitor, view 3341 3342 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx() 3343 @*/ 3344 PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx) 3345 { 3346 PetscErrorCode ierr; 3347 3348 PetscFunctionBegin; 3349 ierr = PetscNew(ctx);CHKERRQ(ierr); 3350 ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr); 3351 ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr); 3352 3353 (*ctx)->howoften = howoften; 3354 (*ctx)->showinitial = PETSC_FALSE; 3355 ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr); 3356 3357 (*ctx)->showtimestepandtime = PETSC_FALSE; 3358 ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr); 3359 (*ctx)->color = PETSC_DRAW_WHITE; 3360 PetscFunctionReturn(0); 3361 } 3362 3363 #undef __FUNCT__ 3364 #define __FUNCT__ "TSMonitorDrawError" 3365 /*@C 3366 TSMonitorDrawError - Monitors progress of the TS solvers by calling 3367 VecView() for the error at each timestep 3368 3369 Collective on TS 3370 3371 Input Parameters: 3372 + ts - the TS context 3373 . step - current time-step 3374 . ptime - current time 3375 - dummy - either a viewer or NULL 3376 3377 Level: intermediate 3378 3379 .keywords: TS, vector, monitor, view 3380 3381 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 3382 @*/ 3383 PetscErrorCode TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 3384 { 3385 PetscErrorCode ierr; 3386 TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy; 3387 PetscViewer viewer = ctx->viewer; 3388 Vec work; 3389 3390 PetscFunctionBegin; 3391 if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 3392 ierr = VecDuplicate(u,&work);CHKERRQ(ierr); 3393 ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr); 3394 ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr); 3395 ierr = VecView(work,viewer);CHKERRQ(ierr); 3396 ierr = VecDestroy(&work);CHKERRQ(ierr); 3397 PetscFunctionReturn(0); 3398 } 3399 3400 #include <petsc-private/dmimpl.h> 3401 #undef __FUNCT__ 3402 #define __FUNCT__ "TSSetDM" 3403 /*@ 3404 TSSetDM - Sets the DM that may be used by some preconditioners 3405 3406 Logically Collective on TS and DM 3407 3408 Input Parameters: 3409 + ts - the preconditioner context 3410 - dm - the dm 3411 3412 Level: intermediate 3413 3414 3415 .seealso: TSGetDM(), SNESSetDM(), SNESGetDM() 3416 @*/ 3417 PetscErrorCode TSSetDM(TS ts,DM dm) 3418 { 3419 PetscErrorCode ierr; 3420 SNES snes; 3421 DMTS tsdm; 3422 3423 PetscFunctionBegin; 3424 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3425 ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr); 3426 if (ts->dm) { /* Move the DMTS context over to the new DM unless the new DM already has one */ 3427 if (ts->dm->dmts && !dm->dmts) { 3428 ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr); 3429 ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr); 3430 if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */ 3431 tsdm->originaldm = dm; 3432 } 3433 } 3434 ierr = DMDestroy(&ts->dm);CHKERRQ(ierr); 3435 } 3436 ts->dm = dm; 3437 3438 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3439 ierr = SNESSetDM(snes,dm);CHKERRQ(ierr); 3440 PetscFunctionReturn(0); 3441 } 3442 3443 #undef __FUNCT__ 3444 #define __FUNCT__ "TSGetDM" 3445 /*@ 3446 TSGetDM - Gets the DM that may be used by some preconditioners 3447 3448 Not Collective 3449 3450 Input Parameter: 3451 . ts - the preconditioner context 3452 3453 Output Parameter: 3454 . dm - the dm 3455 3456 Level: intermediate 3457 3458 3459 .seealso: TSSetDM(), SNESSetDM(), SNESGetDM() 3460 @*/ 3461 PetscErrorCode TSGetDM(TS ts,DM *dm) 3462 { 3463 PetscErrorCode ierr; 3464 3465 PetscFunctionBegin; 3466 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3467 if (!ts->dm) { 3468 ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr); 3469 if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 3470 } 3471 *dm = ts->dm; 3472 PetscFunctionReturn(0); 3473 } 3474 3475 #undef __FUNCT__ 3476 #define __FUNCT__ "SNESTSFormFunction" 3477 /*@ 3478 SNESTSFormFunction - Function to evaluate nonlinear residual 3479 3480 Logically Collective on SNES 3481 3482 Input Parameter: 3483 + snes - nonlinear solver 3484 . U - the current state at which to evaluate the residual 3485 - ctx - user context, must be a TS 3486 3487 Output Parameter: 3488 . F - the nonlinear residual 3489 3490 Notes: 3491 This function is not normally called by users and is automatically registered with the SNES used by TS. 3492 It is most frequently passed to MatFDColoringSetFunction(). 3493 3494 Level: advanced 3495 3496 .seealso: SNESSetFunction(), MatFDColoringSetFunction() 3497 @*/ 3498 PetscErrorCode SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx) 3499 { 3500 TS ts = (TS)ctx; 3501 PetscErrorCode ierr; 3502 3503 PetscFunctionBegin; 3504 PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3505 PetscValidHeaderSpecific(U,VEC_CLASSID,2); 3506 PetscValidHeaderSpecific(F,VEC_CLASSID,3); 3507 PetscValidHeaderSpecific(ts,TS_CLASSID,4); 3508 ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr); 3509 PetscFunctionReturn(0); 3510 } 3511 3512 #undef __FUNCT__ 3513 #define __FUNCT__ "SNESTSFormJacobian" 3514 /*@ 3515 SNESTSFormJacobian - Function to evaluate the Jacobian 3516 3517 Collective on SNES 3518 3519 Input Parameter: 3520 + snes - nonlinear solver 3521 . U - the current state at which to evaluate the residual 3522 - ctx - user context, must be a TS 3523 3524 Output Parameter: 3525 + A - the Jacobian 3526 . B - the preconditioning matrix (may be the same as A) 3527 - flag - indicates any structure change in the matrix 3528 3529 Notes: 3530 This function is not normally called by users and is automatically registered with the SNES used by TS. 3531 3532 Level: developer 3533 3534 .seealso: SNESSetJacobian() 3535 @*/ 3536 PetscErrorCode SNESTSFormJacobian(SNES snes,Vec U,Mat *A,Mat *B,MatStructure *flag,void *ctx) 3537 { 3538 TS ts = (TS)ctx; 3539 PetscErrorCode ierr; 3540 3541 PetscFunctionBegin; 3542 PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3543 PetscValidHeaderSpecific(U,VEC_CLASSID,2); 3544 PetscValidPointer(A,3); 3545 PetscValidHeaderSpecific(*A,MAT_CLASSID,3); 3546 PetscValidPointer(B,4); 3547 PetscValidHeaderSpecific(*B,MAT_CLASSID,4); 3548 PetscValidPointer(flag,5); 3549 PetscValidHeaderSpecific(ts,TS_CLASSID,6); 3550 ierr = (ts->ops->snesjacobian)(snes,U,A,B,flag,ts);CHKERRQ(ierr); 3551 PetscFunctionReturn(0); 3552 } 3553 3554 #undef __FUNCT__ 3555 #define __FUNCT__ "TSComputeRHSFunctionLinear" 3556 /*@C 3557 TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only 3558 3559 Collective on TS 3560 3561 Input Arguments: 3562 + ts - time stepping context 3563 . t - time at which to evaluate 3564 . U - state at which to evaluate 3565 - ctx - context 3566 3567 Output Arguments: 3568 . F - right hand side 3569 3570 Level: intermediate 3571 3572 Notes: 3573 This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems. 3574 The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian(). 3575 3576 .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 3577 @*/ 3578 PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx) 3579 { 3580 PetscErrorCode ierr; 3581 Mat Arhs,Brhs; 3582 MatStructure flg2; 3583 3584 PetscFunctionBegin; 3585 ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 3586 ierr = TSComputeRHSJacobian(ts,t,U,&Arhs,&Brhs,&flg2);CHKERRQ(ierr); 3587 ierr = MatMult(Arhs,U,F);CHKERRQ(ierr); 3588 PetscFunctionReturn(0); 3589 } 3590 3591 #undef __FUNCT__ 3592 #define __FUNCT__ "TSComputeRHSJacobianConstant" 3593 /*@C 3594 TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 3595 3596 Collective on TS 3597 3598 Input Arguments: 3599 + ts - time stepping context 3600 . t - time at which to evaluate 3601 . U - state at which to evaluate 3602 - ctx - context 3603 3604 Output Arguments: 3605 + A - pointer to operator 3606 . B - pointer to preconditioning matrix 3607 - flg - matrix structure flag 3608 3609 Level: intermediate 3610 3611 Notes: 3612 This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems. 3613 3614 .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear() 3615 @*/ 3616 PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat *A,Mat *B,MatStructure *flg,void *ctx) 3617 { 3618 PetscFunctionBegin; 3619 *flg = SAME_PRECONDITIONER; 3620 PetscFunctionReturn(0); 3621 } 3622 3623 #undef __FUNCT__ 3624 #define __FUNCT__ "TSComputeIFunctionLinear" 3625 /*@C 3626 TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 3627 3628 Collective on TS 3629 3630 Input Arguments: 3631 + ts - time stepping context 3632 . t - time at which to evaluate 3633 . U - state at which to evaluate 3634 . Udot - time derivative of state vector 3635 - ctx - context 3636 3637 Output Arguments: 3638 . F - left hand side 3639 3640 Level: intermediate 3641 3642 Notes: 3643 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 3644 user is required to write their own TSComputeIFunction. 3645 This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems. 3646 The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian(). 3647 3648 .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant() 3649 @*/ 3650 PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx) 3651 { 3652 PetscErrorCode ierr; 3653 Mat A,B; 3654 MatStructure flg2; 3655 3656 PetscFunctionBegin; 3657 ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 3658 ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,&A,&B,&flg2,PETSC_TRUE);CHKERRQ(ierr); 3659 ierr = MatMult(A,Udot,F);CHKERRQ(ierr); 3660 PetscFunctionReturn(0); 3661 } 3662 3663 #undef __FUNCT__ 3664 #define __FUNCT__ "TSComputeIJacobianConstant" 3665 /*@C 3666 TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE 3667 3668 Collective on TS 3669 3670 Input Arguments: 3671 + ts - time stepping context 3672 . t - time at which to evaluate 3673 . U - state at which to evaluate 3674 . Udot - time derivative of state vector 3675 . shift - shift to apply 3676 - ctx - context 3677 3678 Output Arguments: 3679 + A - pointer to operator 3680 . B - pointer to preconditioning matrix 3681 - flg - matrix structure flag 3682 3683 Level: advanced 3684 3685 Notes: 3686 This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems. 3687 3688 It is only appropriate for problems of the form 3689 3690 $ M Udot = F(U,t) 3691 3692 where M is constant and F is non-stiff. The user must pass M to TSSetIJacobian(). The current implementation only 3693 works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing 3694 an implicit operator of the form 3695 3696 $ shift*M + J 3697 3698 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 3699 a copy of M or reassemble it when requested. 3700 3701 .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear() 3702 @*/ 3703 PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat *A,Mat *B,MatStructure *flg,void *ctx) 3704 { 3705 PetscErrorCode ierr; 3706 3707 PetscFunctionBegin; 3708 ierr = MatScale(*A, shift / ts->ijacobian.shift);CHKERRQ(ierr); 3709 ts->ijacobian.shift = shift; 3710 *flg = SAME_PRECONDITIONER; 3711 PetscFunctionReturn(0); 3712 } 3713 3714 #undef __FUNCT__ 3715 #define __FUNCT__ "TSGetEquationType" 3716 /*@ 3717 TSGetEquationType - Gets the type of the equation that TS is solving. 3718 3719 Not Collective 3720 3721 Input Parameter: 3722 . ts - the TS context 3723 3724 Output Parameter: 3725 . equation_type - see TSEquationType 3726 3727 Level: beginner 3728 3729 .keywords: TS, equation type 3730 3731 .seealso: TSSetEquationType(), TSEquationType 3732 @*/ 3733 PetscErrorCode TSGetEquationType(TS ts,TSEquationType *equation_type) 3734 { 3735 PetscFunctionBegin; 3736 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3737 PetscValidPointer(equation_type,2); 3738 *equation_type = ts->equation_type; 3739 PetscFunctionReturn(0); 3740 } 3741 3742 #undef __FUNCT__ 3743 #define __FUNCT__ "TSSetEquationType" 3744 /*@ 3745 TSSetEquationType - Sets the type of the equation that TS is solving. 3746 3747 Not Collective 3748 3749 Input Parameter: 3750 + ts - the TS context 3751 . equation_type - see TSEquationType 3752 3753 Level: advanced 3754 3755 .keywords: TS, equation type 3756 3757 .seealso: TSGetEquationType(), TSEquationType 3758 @*/ 3759 PetscErrorCode TSSetEquationType(TS ts,TSEquationType equation_type) 3760 { 3761 PetscFunctionBegin; 3762 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3763 ts->equation_type = equation_type; 3764 PetscFunctionReturn(0); 3765 } 3766 3767 #undef __FUNCT__ 3768 #define __FUNCT__ "TSGetConvergedReason" 3769 /*@ 3770 TSGetConvergedReason - Gets the reason the TS iteration was stopped. 3771 3772 Not Collective 3773 3774 Input Parameter: 3775 . ts - the TS context 3776 3777 Output Parameter: 3778 . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 3779 manual pages for the individual convergence tests for complete lists 3780 3781 Level: beginner 3782 3783 Notes: 3784 Can only be called after the call to TSSolve() is complete. 3785 3786 .keywords: TS, nonlinear, set, convergence, test 3787 3788 .seealso: TSSetConvergenceTest(), TSConvergedReason 3789 @*/ 3790 PetscErrorCode TSGetConvergedReason(TS ts,TSConvergedReason *reason) 3791 { 3792 PetscFunctionBegin; 3793 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3794 PetscValidPointer(reason,2); 3795 *reason = ts->reason; 3796 PetscFunctionReturn(0); 3797 } 3798 3799 #undef __FUNCT__ 3800 #define __FUNCT__ "TSSetConvergedReason" 3801 /*@ 3802 TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve. 3803 3804 Not Collective 3805 3806 Input Parameter: 3807 + ts - the TS context 3808 . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 3809 manual pages for the individual convergence tests for complete lists 3810 3811 Level: advanced 3812 3813 Notes: 3814 Can only be called during TSSolve() is active. 3815 3816 .keywords: TS, nonlinear, set, convergence, test 3817 3818 .seealso: TSConvergedReason 3819 @*/ 3820 PetscErrorCode TSSetConvergedReason(TS ts,TSConvergedReason reason) 3821 { 3822 PetscFunctionBegin; 3823 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3824 ts->reason = reason; 3825 PetscFunctionReturn(0); 3826 } 3827 3828 #undef __FUNCT__ 3829 #define __FUNCT__ "TSGetSolveTime" 3830 /*@ 3831 TSGetSolveTime - Gets the time after a call to TSSolve() 3832 3833 Not Collective 3834 3835 Input Parameter: 3836 . ts - the TS context 3837 3838 Output Parameter: 3839 . ftime - the final time. This time should correspond to the final time set with TSSetDuration() 3840 3841 Level: beginner 3842 3843 Notes: 3844 Can only be called after the call to TSSolve() is complete. 3845 3846 .keywords: TS, nonlinear, set, convergence, test 3847 3848 .seealso: TSSetConvergenceTest(), TSConvergedReason 3849 @*/ 3850 PetscErrorCode TSGetSolveTime(TS ts,PetscReal *ftime) 3851 { 3852 PetscFunctionBegin; 3853 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3854 PetscValidPointer(ftime,2); 3855 *ftime = ts->solvetime; 3856 PetscFunctionReturn(0); 3857 } 3858 3859 #undef __FUNCT__ 3860 #define __FUNCT__ "TSGetSNESIterations" 3861 /*@ 3862 TSGetSNESIterations - Gets the total number of nonlinear iterations 3863 used by the time integrator. 3864 3865 Not Collective 3866 3867 Input Parameter: 3868 . ts - TS context 3869 3870 Output Parameter: 3871 . nits - number of nonlinear iterations 3872 3873 Notes: 3874 This counter is reset to zero for each successive call to TSSolve(). 3875 3876 Level: intermediate 3877 3878 .keywords: TS, get, number, nonlinear, iterations 3879 3880 .seealso: TSGetKSPIterations() 3881 @*/ 3882 PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits) 3883 { 3884 PetscFunctionBegin; 3885 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3886 PetscValidIntPointer(nits,2); 3887 *nits = ts->snes_its; 3888 PetscFunctionReturn(0); 3889 } 3890 3891 #undef __FUNCT__ 3892 #define __FUNCT__ "TSGetKSPIterations" 3893 /*@ 3894 TSGetKSPIterations - Gets the total number of linear iterations 3895 used by the time integrator. 3896 3897 Not Collective 3898 3899 Input Parameter: 3900 . ts - TS context 3901 3902 Output Parameter: 3903 . lits - number of linear iterations 3904 3905 Notes: 3906 This counter is reset to zero for each successive call to TSSolve(). 3907 3908 Level: intermediate 3909 3910 .keywords: TS, get, number, linear, iterations 3911 3912 .seealso: TSGetSNESIterations(), SNESGetKSPIterations() 3913 @*/ 3914 PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits) 3915 { 3916 PetscFunctionBegin; 3917 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3918 PetscValidIntPointer(lits,2); 3919 *lits = ts->ksp_its; 3920 PetscFunctionReturn(0); 3921 } 3922 3923 #undef __FUNCT__ 3924 #define __FUNCT__ "TSGetStepRejections" 3925 /*@ 3926 TSGetStepRejections - Gets the total number of rejected steps. 3927 3928 Not Collective 3929 3930 Input Parameter: 3931 . ts - TS context 3932 3933 Output Parameter: 3934 . rejects - number of steps rejected 3935 3936 Notes: 3937 This counter is reset to zero for each successive call to TSSolve(). 3938 3939 Level: intermediate 3940 3941 .keywords: TS, get, number 3942 3943 .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails() 3944 @*/ 3945 PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects) 3946 { 3947 PetscFunctionBegin; 3948 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3949 PetscValidIntPointer(rejects,2); 3950 *rejects = ts->reject; 3951 PetscFunctionReturn(0); 3952 } 3953 3954 #undef __FUNCT__ 3955 #define __FUNCT__ "TSGetSNESFailures" 3956 /*@ 3957 TSGetSNESFailures - Gets the total number of failed SNES solves 3958 3959 Not Collective 3960 3961 Input Parameter: 3962 . ts - TS context 3963 3964 Output Parameter: 3965 . fails - number of failed nonlinear solves 3966 3967 Notes: 3968 This counter is reset to zero for each successive call to TSSolve(). 3969 3970 Level: intermediate 3971 3972 .keywords: TS, get, number 3973 3974 .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures() 3975 @*/ 3976 PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails) 3977 { 3978 PetscFunctionBegin; 3979 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3980 PetscValidIntPointer(fails,2); 3981 *fails = ts->num_snes_failures; 3982 PetscFunctionReturn(0); 3983 } 3984 3985 #undef __FUNCT__ 3986 #define __FUNCT__ "TSSetMaxStepRejections" 3987 /*@ 3988 TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails 3989 3990 Not Collective 3991 3992 Input Parameter: 3993 + ts - TS context 3994 - rejects - maximum number of rejected steps, pass -1 for unlimited 3995 3996 Notes: 3997 The counter is reset to zero for each step 3998 3999 Options Database Key: 4000 . -ts_max_reject - Maximum number of step rejections before a step fails 4001 4002 Level: intermediate 4003 4004 .keywords: TS, set, maximum, number 4005 4006 .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 4007 @*/ 4008 PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects) 4009 { 4010 PetscFunctionBegin; 4011 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4012 ts->max_reject = rejects; 4013 PetscFunctionReturn(0); 4014 } 4015 4016 #undef __FUNCT__ 4017 #define __FUNCT__ "TSSetMaxSNESFailures" 4018 /*@ 4019 TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves 4020 4021 Not Collective 4022 4023 Input Parameter: 4024 + ts - TS context 4025 - fails - maximum number of failed nonlinear solves, pass -1 for unlimited 4026 4027 Notes: 4028 The counter is reset to zero for each successive call to TSSolve(). 4029 4030 Options Database Key: 4031 . -ts_max_snes_failures - Maximum number of nonlinear solve failures 4032 4033 Level: intermediate 4034 4035 .keywords: TS, set, maximum, number 4036 4037 .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason() 4038 @*/ 4039 PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails) 4040 { 4041 PetscFunctionBegin; 4042 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4043 ts->max_snes_failures = fails; 4044 PetscFunctionReturn(0); 4045 } 4046 4047 #undef __FUNCT__ 4048 #define __FUNCT__ "TSSetErrorIfStepFails" 4049 /*@ 4050 TSSetErrorIfStepFails - Error if no step succeeds 4051 4052 Not Collective 4053 4054 Input Parameter: 4055 + ts - TS context 4056 - err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure 4057 4058 Options Database Key: 4059 . -ts_error_if_step_fails - Error if no step succeeds 4060 4061 Level: intermediate 4062 4063 .keywords: TS, set, error 4064 4065 .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 4066 @*/ 4067 PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err) 4068 { 4069 PetscFunctionBegin; 4070 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4071 ts->errorifstepfailed = err; 4072 PetscFunctionReturn(0); 4073 } 4074 4075 #undef __FUNCT__ 4076 #define __FUNCT__ "TSMonitorSolutionBinary" 4077 /*@C 4078 TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file 4079 4080 Collective on TS 4081 4082 Input Parameters: 4083 + ts - the TS context 4084 . step - current time-step 4085 . ptime - current time 4086 . u - current state 4087 - viewer - binary viewer 4088 4089 Level: intermediate 4090 4091 .keywords: TS, vector, monitor, view 4092 4093 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 4094 @*/ 4095 PetscErrorCode TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec u,void *viewer) 4096 { 4097 PetscErrorCode ierr; 4098 PetscViewer v = (PetscViewer)viewer; 4099 4100 PetscFunctionBegin; 4101 ierr = VecView(u,v);CHKERRQ(ierr); 4102 PetscFunctionReturn(0); 4103 } 4104 4105 #undef __FUNCT__ 4106 #define __FUNCT__ "TSMonitorSolutionVTK" 4107 /*@C 4108 TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep. 4109 4110 Collective on TS 4111 4112 Input Parameters: 4113 + ts - the TS context 4114 . step - current time-step 4115 . ptime - current time 4116 . u - current state 4117 - filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 4118 4119 Level: intermediate 4120 4121 Notes: 4122 The VTK format does not allow writing multiple time steps in the same file, therefore a different file will be written for each time step. 4123 These are named according to the file name template. 4124 4125 This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy(). 4126 4127 .keywords: TS, vector, monitor, view 4128 4129 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 4130 @*/ 4131 PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate) 4132 { 4133 PetscErrorCode ierr; 4134 char filename[PETSC_MAX_PATH_LEN]; 4135 PetscViewer viewer; 4136 4137 PetscFunctionBegin; 4138 ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr); 4139 ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr); 4140 ierr = VecView(u,viewer);CHKERRQ(ierr); 4141 ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 4142 PetscFunctionReturn(0); 4143 } 4144 4145 #undef __FUNCT__ 4146 #define __FUNCT__ "TSMonitorSolutionVTKDestroy" 4147 /*@C 4148 TSMonitorSolutionVTKDestroy - Destroy context for monitoring 4149 4150 Collective on TS 4151 4152 Input Parameters: 4153 . filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 4154 4155 Level: intermediate 4156 4157 Note: 4158 This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK(). 4159 4160 .keywords: TS, vector, monitor, view 4161 4162 .seealso: TSMonitorSet(), TSMonitorSolutionVTK() 4163 @*/ 4164 PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate) 4165 { 4166 PetscErrorCode ierr; 4167 4168 PetscFunctionBegin; 4169 ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr); 4170 PetscFunctionReturn(0); 4171 } 4172 4173 #undef __FUNCT__ 4174 #define __FUNCT__ "TSGetAdapt" 4175 /*@ 4176 TSGetAdapt - Get the adaptive controller context for the current method 4177 4178 Collective on TS if controller has not been created yet 4179 4180 Input Arguments: 4181 . ts - time stepping context 4182 4183 Output Arguments: 4184 . adapt - adaptive controller 4185 4186 Level: intermediate 4187 4188 .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose() 4189 @*/ 4190 PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt) 4191 { 4192 PetscErrorCode ierr; 4193 4194 PetscFunctionBegin; 4195 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4196 PetscValidPointer(adapt,2); 4197 if (!ts->adapt) { 4198 ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr); 4199 ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr); 4200 ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr); 4201 } 4202 *adapt = ts->adapt; 4203 PetscFunctionReturn(0); 4204 } 4205 4206 #undef __FUNCT__ 4207 #define __FUNCT__ "TSSetTolerances" 4208 /*@ 4209 TSSetTolerances - Set tolerances for local truncation error when using adaptive controller 4210 4211 Logically Collective 4212 4213 Input Arguments: 4214 + ts - time integration context 4215 . atol - scalar absolute tolerances, PETSC_DECIDE to leave current value 4216 . vatol - vector of absolute tolerances or NULL, used in preference to atol if present 4217 . rtol - scalar relative tolerances, PETSC_DECIDE to leave current value 4218 - vrtol - vector of relative tolerances or NULL, used in preference to atol if present 4219 4220 Level: beginner 4221 4222 .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances() 4223 @*/ 4224 PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol) 4225 { 4226 PetscErrorCode ierr; 4227 4228 PetscFunctionBegin; 4229 if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol; 4230 if (vatol) { 4231 ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr); 4232 ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 4233 4234 ts->vatol = vatol; 4235 } 4236 if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol; 4237 if (vrtol) { 4238 ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr); 4239 ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 4240 4241 ts->vrtol = vrtol; 4242 } 4243 PetscFunctionReturn(0); 4244 } 4245 4246 #undef __FUNCT__ 4247 #define __FUNCT__ "TSGetTolerances" 4248 /*@ 4249 TSGetTolerances - Get tolerances for local truncation error when using adaptive controller 4250 4251 Logically Collective 4252 4253 Input Arguments: 4254 . ts - time integration context 4255 4256 Output Arguments: 4257 + atol - scalar absolute tolerances, NULL to ignore 4258 . vatol - vector of absolute tolerances, NULL to ignore 4259 . rtol - scalar relative tolerances, NULL to ignore 4260 - vrtol - vector of relative tolerances, NULL to ignore 4261 4262 Level: beginner 4263 4264 .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances() 4265 @*/ 4266 PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol) 4267 { 4268 PetscFunctionBegin; 4269 if (atol) *atol = ts->atol; 4270 if (vatol) *vatol = ts->vatol; 4271 if (rtol) *rtol = ts->rtol; 4272 if (vrtol) *vrtol = ts->vrtol; 4273 PetscFunctionReturn(0); 4274 } 4275 4276 #undef __FUNCT__ 4277 #define __FUNCT__ "TSErrorNormWRMS" 4278 /*@ 4279 TSErrorNormWRMS - compute a weighted norm of the difference between a vector and the current state 4280 4281 Collective on TS 4282 4283 Input Arguments: 4284 + ts - time stepping context 4285 - Y - state vector to be compared to ts->vec_sol 4286 4287 Output Arguments: 4288 . norm - weighted norm, a value of 1.0 is considered small 4289 4290 Level: developer 4291 4292 .seealso: TSSetTolerances() 4293 @*/ 4294 PetscErrorCode TSErrorNormWRMS(TS ts,Vec Y,PetscReal *norm) 4295 { 4296 PetscErrorCode ierr; 4297 PetscInt i,n,N; 4298 const PetscScalar *u,*y; 4299 Vec U; 4300 PetscReal sum,gsum; 4301 4302 PetscFunctionBegin; 4303 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4304 PetscValidHeaderSpecific(Y,VEC_CLASSID,2); 4305 PetscValidPointer(norm,3); 4306 U = ts->vec_sol; 4307 PetscCheckSameTypeAndComm(U,1,Y,2); 4308 if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"Y cannot be the TS solution vector"); 4309 4310 ierr = VecGetSize(U,&N);CHKERRQ(ierr); 4311 ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 4312 ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 4313 ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 4314 sum = 0.; 4315 if (ts->vatol && ts->vrtol) { 4316 const PetscScalar *atol,*rtol; 4317 ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 4318 ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 4319 for (i=0; i<n; i++) { 4320 PetscReal tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 4321 sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 4322 } 4323 ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 4324 ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 4325 } else if (ts->vatol) { /* vector atol, scalar rtol */ 4326 const PetscScalar *atol; 4327 ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 4328 for (i=0; i<n; i++) { 4329 PetscReal tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 4330 sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 4331 } 4332 ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 4333 } else if (ts->vrtol) { /* scalar atol, vector rtol */ 4334 const PetscScalar *rtol; 4335 ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 4336 for (i=0; i<n; i++) { 4337 PetscReal tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 4338 sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 4339 } 4340 ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 4341 } else { /* scalar atol, scalar rtol */ 4342 for (i=0; i<n; i++) { 4343 PetscReal tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 4344 sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 4345 } 4346 } 4347 ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 4348 ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 4349 4350 ierr = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 4351 *norm = PetscSqrtReal(gsum / N); 4352 if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 4353 PetscFunctionReturn(0); 4354 } 4355 4356 #undef __FUNCT__ 4357 #define __FUNCT__ "TSSetCFLTimeLocal" 4358 /*@ 4359 TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler 4360 4361 Logically Collective on TS 4362 4363 Input Arguments: 4364 + ts - time stepping context 4365 - cfltime - maximum stable time step if using forward Euler (value can be different on each process) 4366 4367 Note: 4368 After calling this function, the global CFL time can be obtained by calling TSGetCFLTime() 4369 4370 Level: intermediate 4371 4372 .seealso: TSGetCFLTime(), TSADAPTCFL 4373 @*/ 4374 PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime) 4375 { 4376 PetscFunctionBegin; 4377 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4378 ts->cfltime_local = cfltime; 4379 ts->cfltime = -1.; 4380 PetscFunctionReturn(0); 4381 } 4382 4383 #undef __FUNCT__ 4384 #define __FUNCT__ "TSGetCFLTime" 4385 /*@ 4386 TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler 4387 4388 Collective on TS 4389 4390 Input Arguments: 4391 . ts - time stepping context 4392 4393 Output Arguments: 4394 . cfltime - maximum stable time step for forward Euler 4395 4396 Level: advanced 4397 4398 .seealso: TSSetCFLTimeLocal() 4399 @*/ 4400 PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime) 4401 { 4402 PetscErrorCode ierr; 4403 4404 PetscFunctionBegin; 4405 if (ts->cfltime < 0) { 4406 ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 4407 } 4408 *cfltime = ts->cfltime; 4409 PetscFunctionReturn(0); 4410 } 4411 4412 #undef __FUNCT__ 4413 #define __FUNCT__ "TSVISetVariableBounds" 4414 /*@ 4415 TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu 4416 4417 Input Parameters: 4418 . ts - the TS context. 4419 . xl - lower bound. 4420 . xu - upper bound. 4421 4422 Notes: 4423 If this routine is not called then the lower and upper bounds are set to 4424 PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp(). 4425 4426 Level: advanced 4427 4428 @*/ 4429 PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu) 4430 { 4431 PetscErrorCode ierr; 4432 SNES snes; 4433 4434 PetscFunctionBegin; 4435 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4436 ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr); 4437 PetscFunctionReturn(0); 4438 } 4439 4440 #if defined(PETSC_HAVE_MATLAB_ENGINE) 4441 #include <mex.h> 4442 4443 typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext; 4444 4445 #undef __FUNCT__ 4446 #define __FUNCT__ "TSComputeFunction_Matlab" 4447 /* 4448 TSComputeFunction_Matlab - Calls the function that has been set with 4449 TSSetFunctionMatlab(). 4450 4451 Collective on TS 4452 4453 Input Parameters: 4454 + snes - the TS context 4455 - u - input vector 4456 4457 Output Parameter: 4458 . y - function vector, as set by TSSetFunction() 4459 4460 Notes: 4461 TSComputeFunction() is typically used within nonlinear solvers 4462 implementations, so most users would not generally call this routine 4463 themselves. 4464 4465 Level: developer 4466 4467 .keywords: TS, nonlinear, compute, function 4468 4469 .seealso: TSSetFunction(), TSGetFunction() 4470 */ 4471 PetscErrorCode TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx) 4472 { 4473 PetscErrorCode ierr; 4474 TSMatlabContext *sctx = (TSMatlabContext*)ctx; 4475 int nlhs = 1,nrhs = 7; 4476 mxArray *plhs[1],*prhs[7]; 4477 long long int lx = 0,lxdot = 0,ly = 0,ls = 0; 4478 4479 PetscFunctionBegin; 4480 PetscValidHeaderSpecific(snes,TS_CLASSID,1); 4481 PetscValidHeaderSpecific(u,VEC_CLASSID,3); 4482 PetscValidHeaderSpecific(udot,VEC_CLASSID,4); 4483 PetscValidHeaderSpecific(y,VEC_CLASSID,5); 4484 PetscCheckSameComm(snes,1,u,3); 4485 PetscCheckSameComm(snes,1,y,5); 4486 4487 ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 4488 ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 4489 ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr); 4490 ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr); 4491 4492 prhs[0] = mxCreateDoubleScalar((double)ls); 4493 prhs[1] = mxCreateDoubleScalar(time); 4494 prhs[2] = mxCreateDoubleScalar((double)lx); 4495 prhs[3] = mxCreateDoubleScalar((double)lxdot); 4496 prhs[4] = mxCreateDoubleScalar((double)ly); 4497 prhs[5] = mxCreateString(sctx->funcname); 4498 prhs[6] = sctx->ctx; 4499 ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr); 4500 ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 4501 mxDestroyArray(prhs[0]); 4502 mxDestroyArray(prhs[1]); 4503 mxDestroyArray(prhs[2]); 4504 mxDestroyArray(prhs[3]); 4505 mxDestroyArray(prhs[4]); 4506 mxDestroyArray(prhs[5]); 4507 mxDestroyArray(plhs[0]); 4508 PetscFunctionReturn(0); 4509 } 4510 4511 4512 #undef __FUNCT__ 4513 #define __FUNCT__ "TSSetFunctionMatlab" 4514 /* 4515 TSSetFunctionMatlab - Sets the function evaluation routine and function 4516 vector for use by the TS routines in solving ODEs 4517 equations from MATLAB. Here the function is a string containing the name of a MATLAB function 4518 4519 Logically Collective on TS 4520 4521 Input Parameters: 4522 + ts - the TS context 4523 - func - function evaluation routine 4524 4525 Calling sequence of func: 4526 $ func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx); 4527 4528 Level: beginner 4529 4530 .keywords: TS, nonlinear, set, function 4531 4532 .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 4533 */ 4534 PetscErrorCode TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx) 4535 { 4536 PetscErrorCode ierr; 4537 TSMatlabContext *sctx; 4538 4539 PetscFunctionBegin; 4540 /* currently sctx is memory bleed */ 4541 ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 4542 ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 4543 /* 4544 This should work, but it doesn't 4545 sctx->ctx = ctx; 4546 mexMakeArrayPersistent(sctx->ctx); 4547 */ 4548 sctx->ctx = mxDuplicateArray(ctx); 4549 4550 ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr); 4551 PetscFunctionReturn(0); 4552 } 4553 4554 #undef __FUNCT__ 4555 #define __FUNCT__ "TSComputeJacobian_Matlab" 4556 /* 4557 TSComputeJacobian_Matlab - Calls the function that has been set with 4558 TSSetJacobianMatlab(). 4559 4560 Collective on TS 4561 4562 Input Parameters: 4563 + ts - the TS context 4564 . u - input vector 4565 . A, B - the matrices 4566 - ctx - user context 4567 4568 Output Parameter: 4569 . flag - structure of the matrix 4570 4571 Level: developer 4572 4573 .keywords: TS, nonlinear, compute, function 4574 4575 .seealso: TSSetFunction(), TSGetFunction() 4576 @*/ 4577 PetscErrorCode TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat *A,Mat *B,MatStructure *flag, void *ctx) 4578 { 4579 PetscErrorCode ierr; 4580 TSMatlabContext *sctx = (TSMatlabContext*)ctx; 4581 int nlhs = 2,nrhs = 9; 4582 mxArray *plhs[2],*prhs[9]; 4583 long long int lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0; 4584 4585 PetscFunctionBegin; 4586 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4587 PetscValidHeaderSpecific(u,VEC_CLASSID,3); 4588 4589 /* call Matlab function in ctx with arguments u and y */ 4590 4591 ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 4592 ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 4593 ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr); 4594 ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr); 4595 ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr); 4596 4597 prhs[0] = mxCreateDoubleScalar((double)ls); 4598 prhs[1] = mxCreateDoubleScalar((double)time); 4599 prhs[2] = mxCreateDoubleScalar((double)lx); 4600 prhs[3] = mxCreateDoubleScalar((double)lxdot); 4601 prhs[4] = mxCreateDoubleScalar((double)shift); 4602 prhs[5] = mxCreateDoubleScalar((double)lA); 4603 prhs[6] = mxCreateDoubleScalar((double)lB); 4604 prhs[7] = mxCreateString(sctx->funcname); 4605 prhs[8] = sctx->ctx; 4606 ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr); 4607 ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 4608 *flag = (MatStructure) mxGetScalar(plhs[1]);CHKERRQ(ierr); 4609 mxDestroyArray(prhs[0]); 4610 mxDestroyArray(prhs[1]); 4611 mxDestroyArray(prhs[2]); 4612 mxDestroyArray(prhs[3]); 4613 mxDestroyArray(prhs[4]); 4614 mxDestroyArray(prhs[5]); 4615 mxDestroyArray(prhs[6]); 4616 mxDestroyArray(prhs[7]); 4617 mxDestroyArray(plhs[0]); 4618 mxDestroyArray(plhs[1]); 4619 PetscFunctionReturn(0); 4620 } 4621 4622 4623 #undef __FUNCT__ 4624 #define __FUNCT__ "TSSetJacobianMatlab" 4625 /* 4626 TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 4627 vector for use by the TS routines in solving ODEs from MATLAB. Here the function is a string containing the name of a MATLAB function 4628 4629 Logically Collective on TS 4630 4631 Input Parameters: 4632 + ts - the TS context 4633 . A,B - Jacobian matrices 4634 . func - function evaluation routine 4635 - ctx - user context 4636 4637 Calling sequence of func: 4638 $ flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx); 4639 4640 4641 Level: developer 4642 4643 .keywords: TS, nonlinear, set, function 4644 4645 .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 4646 */ 4647 PetscErrorCode TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx) 4648 { 4649 PetscErrorCode ierr; 4650 TSMatlabContext *sctx; 4651 4652 PetscFunctionBegin; 4653 /* currently sctx is memory bleed */ 4654 ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 4655 ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 4656 /* 4657 This should work, but it doesn't 4658 sctx->ctx = ctx; 4659 mexMakeArrayPersistent(sctx->ctx); 4660 */ 4661 sctx->ctx = mxDuplicateArray(ctx); 4662 4663 ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 4664 PetscFunctionReturn(0); 4665 } 4666 4667 #undef __FUNCT__ 4668 #define __FUNCT__ "TSMonitor_Matlab" 4669 /* 4670 TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab(). 4671 4672 Collective on TS 4673 4674 .seealso: TSSetFunction(), TSGetFunction() 4675 @*/ 4676 PetscErrorCode TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx) 4677 { 4678 PetscErrorCode ierr; 4679 TSMatlabContext *sctx = (TSMatlabContext*)ctx; 4680 int nlhs = 1,nrhs = 6; 4681 mxArray *plhs[1],*prhs[6]; 4682 long long int lx = 0,ls = 0; 4683 4684 PetscFunctionBegin; 4685 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4686 PetscValidHeaderSpecific(u,VEC_CLASSID,4); 4687 4688 ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 4689 ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 4690 4691 prhs[0] = mxCreateDoubleScalar((double)ls); 4692 prhs[1] = mxCreateDoubleScalar((double)it); 4693 prhs[2] = mxCreateDoubleScalar((double)time); 4694 prhs[3] = mxCreateDoubleScalar((double)lx); 4695 prhs[4] = mxCreateString(sctx->funcname); 4696 prhs[5] = sctx->ctx; 4697 ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr); 4698 ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 4699 mxDestroyArray(prhs[0]); 4700 mxDestroyArray(prhs[1]); 4701 mxDestroyArray(prhs[2]); 4702 mxDestroyArray(prhs[3]); 4703 mxDestroyArray(prhs[4]); 4704 mxDestroyArray(plhs[0]); 4705 PetscFunctionReturn(0); 4706 } 4707 4708 4709 #undef __FUNCT__ 4710 #define __FUNCT__ "TSMonitorSetMatlab" 4711 /* 4712 TSMonitorSetMatlab - Sets the monitor function from Matlab 4713 4714 Level: developer 4715 4716 .keywords: TS, nonlinear, set, function 4717 4718 .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 4719 */ 4720 PetscErrorCode TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx) 4721 { 4722 PetscErrorCode ierr; 4723 TSMatlabContext *sctx; 4724 4725 PetscFunctionBegin; 4726 /* currently sctx is memory bleed */ 4727 ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 4728 ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 4729 /* 4730 This should work, but it doesn't 4731 sctx->ctx = ctx; 4732 mexMakeArrayPersistent(sctx->ctx); 4733 */ 4734 sctx->ctx = mxDuplicateArray(ctx); 4735 4736 ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr); 4737 PetscFunctionReturn(0); 4738 } 4739 #endif 4740 4741 4742 4743 #undef __FUNCT__ 4744 #define __FUNCT__ "TSMonitorLGSolution" 4745 /*@C 4746 TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector 4747 in a time based line graph 4748 4749 Collective on TS 4750 4751 Input Parameters: 4752 + ts - the TS context 4753 . step - current time-step 4754 . ptime - current time 4755 - lg - a line graph object 4756 4757 Level: intermediate 4758 4759 Notes: each process in a parallel run displays its component solutions in a separate window 4760 4761 .keywords: TS, vector, monitor, view 4762 4763 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 4764 @*/ 4765 PetscErrorCode TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 4766 { 4767 PetscErrorCode ierr; 4768 TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 4769 const PetscScalar *yy; 4770 PetscInt dim; 4771 4772 PetscFunctionBegin; 4773 if (!step) { 4774 PetscDrawAxis axis; 4775 ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 4776 ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr); 4777 ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 4778 ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 4779 ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4780 } 4781 ierr = VecGetArrayRead(u,&yy);CHKERRQ(ierr); 4782 #if defined(PETSC_USE_COMPLEX) 4783 { 4784 PetscReal *yreal; 4785 PetscInt i,n; 4786 ierr = VecGetLocalSize(u,&n);CHKERRQ(ierr); 4787 ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 4788 for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 4789 ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 4790 ierr = PetscFree(yreal);CHKERRQ(ierr); 4791 } 4792 #else 4793 ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 4794 #endif 4795 ierr = VecRestoreArrayRead(u,&yy);CHKERRQ(ierr); 4796 if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 4797 ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 4798 } 4799 PetscFunctionReturn(0); 4800 } 4801 4802 #undef __FUNCT__ 4803 #define __FUNCT__ "TSMonitorLGError" 4804 /*@C 4805 TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector 4806 in a time based line graph 4807 4808 Collective on TS 4809 4810 Input Parameters: 4811 + ts - the TS context 4812 . step - current time-step 4813 . ptime - current time 4814 - lg - a line graph object 4815 4816 Level: intermediate 4817 4818 Notes: 4819 Only for sequential solves. 4820 4821 The user must provide the solution using TSSetSolutionFunction() to use this monitor. 4822 4823 Options Database Keys: 4824 . -ts_monitor_lg_error - create a graphical monitor of error history 4825 4826 .keywords: TS, vector, monitor, view 4827 4828 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 4829 @*/ 4830 PetscErrorCode TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 4831 { 4832 PetscErrorCode ierr; 4833 TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 4834 const PetscScalar *yy; 4835 Vec y; 4836 PetscInt dim; 4837 4838 PetscFunctionBegin; 4839 if (!step) { 4840 PetscDrawAxis axis; 4841 ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 4842 ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr); 4843 ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 4844 ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 4845 ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4846 } 4847 ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 4848 ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr); 4849 ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr); 4850 ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr); 4851 #if defined(PETSC_USE_COMPLEX) 4852 { 4853 PetscReal *yreal; 4854 PetscInt i,n; 4855 ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr); 4856 ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 4857 for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 4858 ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 4859 ierr = PetscFree(yreal);CHKERRQ(ierr); 4860 } 4861 #else 4862 ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 4863 #endif 4864 ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr); 4865 ierr = VecDestroy(&y);CHKERRQ(ierr); 4866 if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 4867 ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 4868 } 4869 PetscFunctionReturn(0); 4870 } 4871 4872 #undef __FUNCT__ 4873 #define __FUNCT__ "TSMonitorLGSNESIterations" 4874 PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 4875 { 4876 TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 4877 PetscReal x = ptime,y; 4878 PetscErrorCode ierr; 4879 PetscInt its; 4880 4881 PetscFunctionBegin; 4882 if (!n) { 4883 PetscDrawAxis axis; 4884 4885 ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 4886 ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr); 4887 ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4888 4889 ctx->snes_its = 0; 4890 } 4891 ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr); 4892 y = its - ctx->snes_its; 4893 ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 4894 if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 4895 ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 4896 } 4897 ctx->snes_its = its; 4898 PetscFunctionReturn(0); 4899 } 4900 4901 #undef __FUNCT__ 4902 #define __FUNCT__ "TSMonitorLGKSPIterations" 4903 PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 4904 { 4905 TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 4906 PetscReal x = ptime,y; 4907 PetscErrorCode ierr; 4908 PetscInt its; 4909 4910 PetscFunctionBegin; 4911 if (!n) { 4912 PetscDrawAxis axis; 4913 4914 ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 4915 ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr); 4916 ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4917 4918 ctx->ksp_its = 0; 4919 } 4920 ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr); 4921 y = its - ctx->ksp_its; 4922 ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 4923 if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 4924 ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 4925 } 4926 ctx->ksp_its = its; 4927 PetscFunctionReturn(0); 4928 } 4929 4930 #undef __FUNCT__ 4931 #define __FUNCT__ "TSComputeLinearStability" 4932 /*@ 4933 TSComputeLinearStability - computes the linear stability function at a point 4934 4935 Collective on TS and Vec 4936 4937 Input Parameters: 4938 + ts - the TS context 4939 - xr,xi - real and imaginary part of input arguments 4940 4941 Output Parameters: 4942 . yr,yi - real and imaginary part of function value 4943 4944 Level: developer 4945 4946 .keywords: TS, compute 4947 4948 .seealso: TSSetRHSFunction(), TSComputeIFunction() 4949 @*/ 4950 PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi) 4951 { 4952 PetscErrorCode ierr; 4953 4954 PetscFunctionBegin; 4955 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4956 if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method"); 4957 ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr); 4958 PetscFunctionReturn(0); 4959 } 4960