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_AdjointStep, TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval; 11 12 const char *const TSExactFinalTimeOptions[] = {"UNSPECIFIED","STEPOVER","INTERPOLATE","MATCHSTEP","TSExactFinalTimeOption","TS_EXACTFINALTIME_",0}; 13 14 struct _n_TSMonitorDrawCtx { 15 PetscViewer viewer; 16 Vec initialsolution; 17 PetscBool showinitial; 18 PetscInt howoften; /* when > 0 uses step % howoften, when negative only final solution plotted */ 19 PetscBool showtimestepandtime; 20 }; 21 22 #undef __FUNCT__ 23 #define __FUNCT__ "TSMonitorSetFromOptions" 24 /*@C 25 TSMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user 26 27 Collective on TS 28 29 Input Parameters: 30 + ts - TS object you wish to monitor 31 . name - the monitor type one is seeking 32 . help - message indicating what monitoring is done 33 . manual - manual page for the monitor 34 . monitor - the monitor function 35 - monitorsetup - a function that is called once ONLY if the user selected this monitor that may set additional features of the TS or PetscViewer objects 36 37 Level: developer 38 39 .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 40 PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 41 PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 42 PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 43 PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 44 PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 45 PetscOptionsFList(), PetscOptionsEList() 46 @*/ 47 PetscErrorCode TSMonitorSetFromOptions(TS ts,const char name[],const char help[], const char manual[],PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*),PetscErrorCode (*monitorsetup)(TS,PetscViewerAndFormat*)) 48 { 49 PetscErrorCode ierr; 50 PetscViewer viewer; 51 PetscViewerFormat format; 52 PetscBool flg; 53 54 PetscFunctionBegin; 55 ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,name,&viewer,&format,&flg);CHKERRQ(ierr); 56 if (flg) { 57 PetscViewerAndFormat *vf; 58 ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr); 59 ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr); 60 if (monitorsetup) { 61 ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr); 62 } 63 ierr = TSMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);CHKERRQ(ierr); 64 } 65 PetscFunctionReturn(0); 66 } 67 68 #undef __FUNCT__ 69 #define __FUNCT__ "TSAdjointMonitorSetFromOptions" 70 /*@C 71 TSAdjointMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user 72 73 Collective on TS 74 75 Input Parameters: 76 + ts - TS object you wish to monitor 77 . name - the monitor type one is seeking 78 . help - message indicating what monitoring is done 79 . manual - manual page for the monitor 80 . monitor - the monitor function 81 - monitorsetup - a function that is called once ONLY if the user selected this monitor that may set additional features of the TS or PetscViewer objects 82 83 Level: developer 84 85 .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 86 PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 87 PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 88 PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 89 PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 90 PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 91 PetscOptionsFList(), PetscOptionsEList() 92 @*/ 93 PetscErrorCode TSAdjointMonitorSetFromOptions(TS ts,const char name[],const char help[], const char manual[],PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat*),PetscErrorCode (*monitorsetup)(TS,PetscViewerAndFormat*)) 94 { 95 PetscErrorCode ierr; 96 PetscViewer viewer; 97 PetscViewerFormat format; 98 PetscBool flg; 99 100 PetscFunctionBegin; 101 ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,name,&viewer,&format,&flg);CHKERRQ(ierr); 102 if (flg) { 103 PetscViewerAndFormat *vf; 104 ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr); 105 ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr); 106 if (monitorsetup) { 107 ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr); 108 } 109 ierr = TSAdjointMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);CHKERRQ(ierr); 110 } 111 PetscFunctionReturn(0); 112 } 113 114 #undef __FUNCT__ 115 #define __FUNCT__ "TSSetFromOptions" 116 /*@ 117 TSSetFromOptions - Sets various TS parameters from user options. 118 119 Collective on TS 120 121 Input Parameter: 122 . ts - the TS context obtained from TSCreate() 123 124 Options Database Keys: 125 + -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSALPHA, TSGLLE, TSSSP 126 . -ts_save_trajectory - checkpoint the solution at each time-step 127 . -ts_max_steps <maxsteps> - maximum number of time-steps to take 128 . -ts_final_time <time> - maximum time to compute to 129 . -ts_dt <dt> - initial time step 130 . -ts_exact_final_time <stepover,interpolate,matchstep> whether to stop at the exact given final time and how to compute the solution at that ti,e 131 . -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed 132 . -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails 133 . -ts_error_if_step_fails <true,false> - Error if no step succeeds 134 . -ts_rtol <rtol> - relative tolerance for local truncation error 135 . -ts_atol <atol> Absolute tolerance for local truncation error 136 . -ts_adjoint_solve <yes,no> After solving the ODE/DAE solve the adjoint problem (requires -ts_save_trajectory) 137 . -ts_fd_color - Use finite differences with coloring to compute IJacobian 138 . -ts_monitor - print information at each timestep 139 . -ts_monitor_lg_solution - Monitor solution graphically 140 . -ts_monitor_lg_error - Monitor error graphically 141 . -ts_monitor_lg_timestep - Monitor timestep size graphically 142 . -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically 143 . -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically 144 . -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically 145 . -ts_monitor_draw_solution - Monitor solution graphically 146 . -ts_monitor_draw_solution_phase <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom 147 . -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction() 148 . -ts_monitor_solution [ascii binary draw][:filename][:viewerformat] - monitors the solution at each timestep 149 . -ts_monitor_solution_vtk <filename.vts> - Save each time step to a binary file, use filename-%%03D.vts 150 . -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time 151 . -ts_adjoint_monitor - print information at each adjoint time step 152 - -ts_adjoint_monitor_draw_sensi - monitor the sensitivity of the first cost function wrt initial conditions (lambda[0]) graphically 153 154 Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified 155 156 Level: beginner 157 158 .keywords: TS, timestep, set, options, database 159 160 .seealso: TSGetType() 161 @*/ 162 PetscErrorCode TSSetFromOptions(TS ts) 163 { 164 PetscBool opt,flg,tflg; 165 PetscErrorCode ierr; 166 char monfilename[PETSC_MAX_PATH_LEN]; 167 PetscReal time_step; 168 TSExactFinalTimeOption eftopt; 169 char dir[16]; 170 TSIFunction ifun; 171 const char *defaultType; 172 char typeName[256]; 173 174 PetscFunctionBegin; 175 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 176 177 ierr = TSRegisterAll();CHKERRQ(ierr); 178 ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr); 179 180 ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr); 181 if (((PetscObject)ts)->type_name) 182 defaultType = ((PetscObject)ts)->type_name; 183 else 184 defaultType = ifun ? TSBEULER : TSEULER; 185 ierr = PetscOptionsFList("-ts_type","TS method","TSSetType",TSList,defaultType,typeName,256,&opt);CHKERRQ(ierr); 186 if (opt) { 187 ierr = TSSetType(ts,typeName);CHKERRQ(ierr); 188 } else { 189 ierr = TSSetType(ts,defaultType);CHKERRQ(ierr); 190 } 191 192 /* Handle generic TS options */ 193 ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr); 194 ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr); 195 ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr); 196 ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr); 197 if (flg) {ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);} 198 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); 199 if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);} 200 ierr = PetscOptionsInt("-ts_max_snes_failures","Maximum number of nonlinear solve failures","TSSetMaxSNESFailures",ts->max_snes_failures,&ts->max_snes_failures,NULL);CHKERRQ(ierr); 201 ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr); 202 ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr); 203 ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr); 204 ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr); 205 206 #if defined(PETSC_HAVE_SAWS) 207 { 208 PetscBool set; 209 flg = PETSC_FALSE; 210 ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr); 211 if (set) { 212 ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr); 213 } 214 } 215 #endif 216 217 /* Monitor options */ 218 ierr = TSMonitorSetFromOptions(ts,"-ts_monitor","Monitor time and timestep size","TSMonitorDefault",TSMonitorDefault,NULL);CHKERRQ(ierr); 219 ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_solution","View the solution at each timestep","TSMonitorSolution",TSMonitorSolution,NULL);CHKERRQ(ierr); 220 ierr = TSAdjointMonitorSetFromOptions(ts,"-ts_adjoint_monitor","Monitor adjoint timestep size","TSAdjointMonitorDefault",TSAdjointMonitorDefault,NULL);CHKERRQ(ierr); 221 222 ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 223 if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);} 224 225 ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr); 226 if (opt) { 227 TSMonitorLGCtx ctx; 228 PetscInt howoften = 1; 229 230 ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 231 ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 232 ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 233 } 234 235 ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr); 236 if (opt) { 237 TSMonitorLGCtx ctx; 238 PetscInt howoften = 1; 239 240 ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr); 241 ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 242 ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 243 } 244 245 ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr); 246 if (opt) { 247 TSMonitorLGCtx ctx; 248 PetscInt howoften = 1; 249 250 ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr); 251 ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 252 ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 253 } 254 ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr); 255 if (opt) { 256 TSMonitorLGCtx ctx; 257 PetscInt howoften = 1; 258 259 ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 260 ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 261 ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 262 } 263 ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr); 264 if (opt) { 265 TSMonitorLGCtx ctx; 266 PetscInt howoften = 1; 267 268 ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 269 ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 270 ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 271 } 272 ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr); 273 if (opt) { 274 TSMonitorSPEigCtx ctx; 275 PetscInt howoften = 1; 276 277 ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr); 278 ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 279 ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr); 280 } 281 opt = PETSC_FALSE; 282 ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr); 283 if (opt) { 284 TSMonitorDrawCtx ctx; 285 PetscInt howoften = 1; 286 287 ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 288 ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 289 ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 290 } 291 opt = PETSC_FALSE; 292 ierr = PetscOptionsName("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",&opt);CHKERRQ(ierr); 293 if (opt) { 294 TSMonitorDrawCtx ctx; 295 PetscInt howoften = 1; 296 297 ierr = PetscOptionsInt("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",howoften,&howoften,NULL);CHKERRQ(ierr); 298 ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 299 ierr = TSAdjointMonitorSet(ts,TSAdjointMonitorDrawSensi,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 300 } 301 opt = PETSC_FALSE; 302 ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr); 303 if (opt) { 304 TSMonitorDrawCtx ctx; 305 PetscReal bounds[4]; 306 PetscInt n = 4; 307 PetscDraw draw; 308 PetscDrawAxis axis; 309 310 ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr); 311 if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field"); 312 ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx);CHKERRQ(ierr); 313 ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr); 314 ierr = PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis);CHKERRQ(ierr); 315 ierr = PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr); 316 ierr = PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr); 317 ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 318 } 319 opt = PETSC_FALSE; 320 ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr); 321 if (opt) { 322 TSMonitorDrawCtx ctx; 323 PetscInt howoften = 1; 324 325 ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr); 326 ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 327 ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 328 } 329 330 opt = PETSC_FALSE; 331 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); 332 if (flg) { 333 const char *ptr,*ptr2; 334 char *filetemplate; 335 if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 336 /* Do some cursory validation of the input. */ 337 ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr); 338 if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 339 for (ptr++; ptr && *ptr; ptr++) { 340 ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr); 341 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"); 342 if (ptr2) break; 343 } 344 ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr); 345 ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr); 346 } 347 348 ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr); 349 if (flg) { 350 TSMonitorDMDARayCtx *rayctx; 351 int ray = 0; 352 DMDADirection ddir; 353 DM da; 354 PetscMPIInt rank; 355 356 if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 357 if (dir[0] == 'x') ddir = DMDA_X; 358 else if (dir[0] == 'y') ddir = DMDA_Y; 359 else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 360 sscanf(dir+2,"%d",&ray); 361 362 ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr); 363 ierr = PetscNew(&rayctx);CHKERRQ(ierr); 364 ierr = TSGetDM(ts,&da);CHKERRQ(ierr); 365 ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr); 366 ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr); 367 if (!rank) { 368 ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr); 369 } 370 rayctx->lgctx = NULL; 371 ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr); 372 } 373 ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr); 374 if (flg) { 375 TSMonitorDMDARayCtx *rayctx; 376 int ray = 0; 377 DMDADirection ddir; 378 DM da; 379 PetscInt howoften = 1; 380 381 if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir); 382 if (dir[0] == 'x') ddir = DMDA_X; 383 else if (dir[0] == 'y') ddir = DMDA_Y; 384 else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir); 385 sscanf(dir+2, "%d", &ray); 386 387 ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr); 388 ierr = PetscNew(&rayctx);CHKERRQ(ierr); 389 ierr = TSGetDM(ts, &da);CHKERRQ(ierr); 390 ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr); 391 ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr); 392 ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr); 393 } 394 395 ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr); 396 if (opt) { 397 TSMonitorEnvelopeCtx ctx; 398 399 ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr); 400 ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr); 401 } 402 403 flg = PETSC_FALSE; 404 ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr); 405 if (flg) { 406 DM dm; 407 DMTS tdm; 408 409 ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 410 ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr); 411 tdm->ijacobianctx = NULL; 412 ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);CHKERRQ(ierr); 413 ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr); 414 } 415 416 if (ts->adapt) { 417 ierr = TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt);CHKERRQ(ierr); 418 } 419 420 /* Handle specific TS options */ 421 if (ts->ops->setfromoptions) { 422 ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr); 423 } 424 425 /* TS trajectory must be set after TS, since it may use some TS options above */ 426 tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE; 427 ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr); 428 if (tflg) { 429 ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr); 430 } 431 tflg = ts->adjoint_solve ? PETSC_TRUE : PETSC_FALSE; 432 ierr = PetscOptionsBool("-ts_adjoint_solve","Solve the adjoint problem immediately after solving the forward problem","",tflg,&tflg,&flg);CHKERRQ(ierr); 433 if (flg) { 434 ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr); 435 ts->adjoint_solve = tflg; 436 } 437 438 /* process any options handlers added with PetscObjectAddOptionsHandler() */ 439 ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);CHKERRQ(ierr); 440 ierr = PetscOptionsEnd();CHKERRQ(ierr); 441 442 if (ts->trajectory) { 443 ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr); 444 } 445 446 ierr = TSGetSNES(ts,&ts->snes);CHKERRQ(ierr); 447 if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);} 448 ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr); 449 PetscFunctionReturn(0); 450 } 451 452 #undef __FUNCT__ 453 #define __FUNCT__ "TSSetSaveTrajectory" 454 /*@ 455 TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object 456 457 Collective on TS 458 459 Input Parameters: 460 . ts - the TS context obtained from TSCreate() 461 462 Note: This routine should be called after all TS options have been set 463 464 Level: intermediate 465 466 .seealso: TSGetTrajectory(), TSAdjointSolve() 467 468 .keywords: TS, set, checkpoint, 469 @*/ 470 PetscErrorCode TSSetSaveTrajectory(TS ts) 471 { 472 PetscErrorCode ierr; 473 474 PetscFunctionBegin; 475 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 476 if (!ts->trajectory) { 477 ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr); 478 ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr); 479 } 480 PetscFunctionReturn(0); 481 } 482 483 #undef __FUNCT__ 484 #define __FUNCT__ "TSComputeRHSJacobian" 485 /*@ 486 TSComputeRHSJacobian - Computes the Jacobian matrix that has been 487 set with TSSetRHSJacobian(). 488 489 Collective on TS and Vec 490 491 Input Parameters: 492 + ts - the TS context 493 . t - current timestep 494 - U - input vector 495 496 Output Parameters: 497 + A - Jacobian matrix 498 . B - optional preconditioning matrix 499 - flag - flag indicating matrix structure 500 501 Notes: 502 Most users should not need to explicitly call this routine, as it 503 is used internally within the nonlinear solvers. 504 505 See KSPSetOperators() for important information about setting the 506 flag parameter. 507 508 Level: developer 509 510 .keywords: SNES, compute, Jacobian, matrix 511 512 .seealso: TSSetRHSJacobian(), KSPSetOperators() 513 @*/ 514 PetscErrorCode TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B) 515 { 516 PetscErrorCode ierr; 517 PetscObjectState Ustate; 518 DM dm; 519 DMTS tsdm; 520 TSRHSJacobian rhsjacobianfunc; 521 void *ctx; 522 TSIJacobian ijacobianfunc; 523 TSRHSFunction rhsfunction; 524 525 PetscFunctionBegin; 526 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 527 PetscValidHeaderSpecific(U,VEC_CLASSID,3); 528 PetscCheckSameComm(ts,1,U,3); 529 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 530 ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr); 531 ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr); 532 ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr); 533 ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 534 ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr); 535 if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) { 536 PetscFunctionReturn(0); 537 } 538 539 if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 540 541 if (ts->rhsjacobian.reuse) { 542 ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr); 543 ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 544 if (A != B) { 545 ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr); 546 ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 547 } 548 ts->rhsjacobian.shift = 0; 549 ts->rhsjacobian.scale = 1.; 550 } 551 552 if (rhsjacobianfunc) { 553 PetscBool missing; 554 ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 555 PetscStackPush("TS user Jacobian function"); 556 ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr); 557 PetscStackPop; 558 ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 559 if (A) { 560 ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr); 561 if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Amat passed to TSSetRHSJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value"); 562 } 563 if (B && B != A) { 564 ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr); 565 if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Bmat passed to TSSetRHSJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value"); 566 } 567 } else { 568 ierr = MatZeroEntries(A);CHKERRQ(ierr); 569 if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);} 570 } 571 ts->rhsjacobian.time = t; 572 ts->rhsjacobian.X = U; 573 ierr = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr); 574 PetscFunctionReturn(0); 575 } 576 577 #undef __FUNCT__ 578 #define __FUNCT__ "TSComputeRHSFunction" 579 /*@ 580 TSComputeRHSFunction - Evaluates the right-hand-side function. 581 582 Collective on TS and Vec 583 584 Input Parameters: 585 + ts - the TS context 586 . t - current time 587 - U - state vector 588 589 Output Parameter: 590 . y - right hand side 591 592 Note: 593 Most users should not need to explicitly call this routine, as it 594 is used internally within the nonlinear solvers. 595 596 Level: developer 597 598 .keywords: TS, compute 599 600 .seealso: TSSetRHSFunction(), TSComputeIFunction() 601 @*/ 602 PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y) 603 { 604 PetscErrorCode ierr; 605 TSRHSFunction rhsfunction; 606 TSIFunction ifunction; 607 void *ctx; 608 DM dm; 609 610 PetscFunctionBegin; 611 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 612 PetscValidHeaderSpecific(U,VEC_CLASSID,3); 613 PetscValidHeaderSpecific(y,VEC_CLASSID,4); 614 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 615 ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 616 ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr); 617 618 if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 619 620 ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 621 if (rhsfunction) { 622 PetscStackPush("TS user right-hand-side function"); 623 ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr); 624 PetscStackPop; 625 } else { 626 ierr = VecZeroEntries(y);CHKERRQ(ierr); 627 } 628 629 ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 630 PetscFunctionReturn(0); 631 } 632 633 #undef __FUNCT__ 634 #define __FUNCT__ "TSComputeSolutionFunction" 635 /*@ 636 TSComputeSolutionFunction - Evaluates the solution function. 637 638 Collective on TS and Vec 639 640 Input Parameters: 641 + ts - the TS context 642 - t - current time 643 644 Output Parameter: 645 . U - the solution 646 647 Note: 648 Most users should not need to explicitly call this routine, as it 649 is used internally within the nonlinear solvers. 650 651 Level: developer 652 653 .keywords: TS, compute 654 655 .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 656 @*/ 657 PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U) 658 { 659 PetscErrorCode ierr; 660 TSSolutionFunction solutionfunction; 661 void *ctx; 662 DM dm; 663 664 PetscFunctionBegin; 665 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 666 PetscValidHeaderSpecific(U,VEC_CLASSID,3); 667 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 668 ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr); 669 670 if (solutionfunction) { 671 PetscStackPush("TS user solution function"); 672 ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr); 673 PetscStackPop; 674 } 675 PetscFunctionReturn(0); 676 } 677 #undef __FUNCT__ 678 #define __FUNCT__ "TSComputeForcingFunction" 679 /*@ 680 TSComputeForcingFunction - Evaluates the forcing function. 681 682 Collective on TS and Vec 683 684 Input Parameters: 685 + ts - the TS context 686 - t - current time 687 688 Output Parameter: 689 . U - the function value 690 691 Note: 692 Most users should not need to explicitly call this routine, as it 693 is used internally within the nonlinear solvers. 694 695 Level: developer 696 697 .keywords: TS, compute 698 699 .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 700 @*/ 701 PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U) 702 { 703 PetscErrorCode ierr, (*forcing)(TS,PetscReal,Vec,void*); 704 void *ctx; 705 DM dm; 706 707 PetscFunctionBegin; 708 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 709 PetscValidHeaderSpecific(U,VEC_CLASSID,3); 710 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 711 ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr); 712 713 if (forcing) { 714 PetscStackPush("TS user forcing function"); 715 ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr); 716 PetscStackPop; 717 } 718 PetscFunctionReturn(0); 719 } 720 721 #undef __FUNCT__ 722 #define __FUNCT__ "TSGetRHSVec_Private" 723 static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs) 724 { 725 Vec F; 726 PetscErrorCode ierr; 727 728 PetscFunctionBegin; 729 *Frhs = NULL; 730 ierr = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr); 731 if (!ts->Frhs) { 732 ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr); 733 } 734 *Frhs = ts->Frhs; 735 PetscFunctionReturn(0); 736 } 737 738 #undef __FUNCT__ 739 #define __FUNCT__ "TSGetRHSMats_Private" 740 static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs) 741 { 742 Mat A,B; 743 PetscErrorCode ierr; 744 745 PetscFunctionBegin; 746 if (Arhs) *Arhs = NULL; 747 if (Brhs) *Brhs = NULL; 748 ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 749 if (Arhs) { 750 if (!ts->Arhs) { 751 ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr); 752 } 753 *Arhs = ts->Arhs; 754 } 755 if (Brhs) { 756 if (!ts->Brhs) { 757 if (A != B) { 758 ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr); 759 } else { 760 ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr); 761 ts->Brhs = ts->Arhs; 762 } 763 } 764 *Brhs = ts->Brhs; 765 } 766 PetscFunctionReturn(0); 767 } 768 769 #undef __FUNCT__ 770 #define __FUNCT__ "TSComputeIFunction" 771 /*@ 772 TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0 773 774 Collective on TS and Vec 775 776 Input Parameters: 777 + ts - the TS context 778 . t - current time 779 . U - state vector 780 . Udot - time derivative of state vector 781 - imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate 782 783 Output Parameter: 784 . Y - right hand side 785 786 Note: 787 Most users should not need to explicitly call this routine, as it 788 is used internally within the nonlinear solvers. 789 790 If the user did did not write their equations in implicit form, this 791 function recasts them in implicit form. 792 793 Level: developer 794 795 .keywords: TS, compute 796 797 .seealso: TSSetIFunction(), TSComputeRHSFunction() 798 @*/ 799 PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex) 800 { 801 PetscErrorCode ierr; 802 TSIFunction ifunction; 803 TSRHSFunction rhsfunction; 804 void *ctx; 805 DM dm; 806 807 PetscFunctionBegin; 808 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 809 PetscValidHeaderSpecific(U,VEC_CLASSID,3); 810 PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 811 PetscValidHeaderSpecific(Y,VEC_CLASSID,5); 812 813 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 814 ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr); 815 ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 816 817 if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 818 819 ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 820 if (ifunction) { 821 PetscStackPush("TS user implicit function"); 822 ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr); 823 PetscStackPop; 824 } 825 if (imex) { 826 if (!ifunction) { 827 ierr = VecCopy(Udot,Y);CHKERRQ(ierr); 828 } 829 } else if (rhsfunction) { 830 if (ifunction) { 831 Vec Frhs; 832 ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 833 ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 834 ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr); 835 } else { 836 ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr); 837 ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr); 838 } 839 } 840 ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 841 PetscFunctionReturn(0); 842 } 843 844 #undef __FUNCT__ 845 #define __FUNCT__ "TSComputeIJacobian" 846 /*@ 847 TSComputeIJacobian - Evaluates the Jacobian of the DAE 848 849 Collective on TS and Vec 850 851 Input 852 Input Parameters: 853 + ts - the TS context 854 . t - current timestep 855 . U - state vector 856 . Udot - time derivative of state vector 857 . shift - shift to apply, see note below 858 - imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate 859 860 Output Parameters: 861 + A - Jacobian matrix 862 . B - optional preconditioning matrix 863 - flag - flag indicating matrix structure 864 865 Notes: 866 If F(t,U,Udot)=0 is the DAE, the required Jacobian is 867 868 dF/dU + shift*dF/dUdot 869 870 Most users should not need to explicitly call this routine, as it 871 is used internally within the nonlinear solvers. 872 873 Level: developer 874 875 .keywords: TS, compute, Jacobian, matrix 876 877 .seealso: TSSetIJacobian() 878 @*/ 879 PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex) 880 { 881 PetscErrorCode ierr; 882 TSIJacobian ijacobian; 883 TSRHSJacobian rhsjacobian; 884 DM dm; 885 void *ctx; 886 887 PetscFunctionBegin; 888 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 889 PetscValidHeaderSpecific(U,VEC_CLASSID,3); 890 PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 891 PetscValidPointer(A,6); 892 PetscValidHeaderSpecific(A,MAT_CLASSID,6); 893 PetscValidPointer(B,7); 894 PetscValidHeaderSpecific(B,MAT_CLASSID,7); 895 896 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 897 ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr); 898 ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 899 900 if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 901 902 ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 903 if (ijacobian) { 904 PetscBool missing; 905 PetscStackPush("TS user implicit Jacobian"); 906 ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr); 907 PetscStackPop; 908 if (A) { 909 ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr); 910 if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Amat passed to TSSetIJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value"); 911 } 912 if (B && B != A) { 913 ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr); 914 if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Bmat passed to TSSetIJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value"); 915 } 916 } 917 if (imex) { 918 if (!ijacobian) { /* system was written as Udot = G(t,U) */ 919 ierr = MatZeroEntries(A);CHKERRQ(ierr); 920 ierr = MatShift(A,shift);CHKERRQ(ierr); 921 if (A != B) { 922 ierr = MatZeroEntries(B);CHKERRQ(ierr); 923 ierr = MatShift(B,shift);CHKERRQ(ierr); 924 } 925 } 926 } else { 927 Mat Arhs = NULL,Brhs = NULL; 928 if (rhsjacobian) { 929 ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 930 ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 931 } 932 if (Arhs == A) { /* No IJacobian, so we only have the RHS matrix */ 933 ts->rhsjacobian.scale = -1; 934 ts->rhsjacobian.shift = shift; 935 ierr = MatScale(A,-1);CHKERRQ(ierr); 936 ierr = MatShift(A,shift);CHKERRQ(ierr); 937 if (A != B) { 938 ierr = MatScale(B,-1);CHKERRQ(ierr); 939 ierr = MatShift(B,shift);CHKERRQ(ierr); 940 } 941 } else if (Arhs) { /* Both IJacobian and RHSJacobian */ 942 MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 943 if (!ijacobian) { /* No IJacobian provided, but we have a separate RHS matrix */ 944 ierr = MatZeroEntries(A);CHKERRQ(ierr); 945 ierr = MatShift(A,shift);CHKERRQ(ierr); 946 if (A != B) { 947 ierr = MatZeroEntries(B);CHKERRQ(ierr); 948 ierr = MatShift(B,shift);CHKERRQ(ierr); 949 } 950 } 951 ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr); 952 if (A != B) { 953 ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr); 954 } 955 } 956 } 957 ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 958 PetscFunctionReturn(0); 959 } 960 961 #undef __FUNCT__ 962 #define __FUNCT__ "TSSetRHSFunction" 963 /*@C 964 TSSetRHSFunction - Sets the routine for evaluating the function, 965 where U_t = G(t,u). 966 967 Logically Collective on TS 968 969 Input Parameters: 970 + ts - the TS context obtained from TSCreate() 971 . r - vector to put the computed right hand side (or NULL to have it created) 972 . f - routine for evaluating the right-hand-side function 973 - ctx - [optional] user-defined context for private data for the 974 function evaluation routine (may be NULL) 975 976 Calling sequence of func: 977 $ func (TS ts,PetscReal t,Vec u,Vec F,void *ctx); 978 979 + t - current timestep 980 . u - input vector 981 . F - function vector 982 - ctx - [optional] user-defined function context 983 984 Level: beginner 985 986 Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE. 987 988 .keywords: TS, timestep, set, right-hand-side, function 989 990 .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction() 991 @*/ 992 PetscErrorCode TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx) 993 { 994 PetscErrorCode ierr; 995 SNES snes; 996 Vec ralloc = NULL; 997 DM dm; 998 999 PetscFunctionBegin; 1000 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1001 if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 1002 1003 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1004 ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr); 1005 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1006 if (!r && !ts->dm && ts->vec_sol) { 1007 ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 1008 r = ralloc; 1009 } 1010 ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 1011 ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 1012 PetscFunctionReturn(0); 1013 } 1014 1015 #undef __FUNCT__ 1016 #define __FUNCT__ "TSSetSolutionFunction" 1017 /*@C 1018 TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE 1019 1020 Logically Collective on TS 1021 1022 Input Parameters: 1023 + ts - the TS context obtained from TSCreate() 1024 . f - routine for evaluating the solution 1025 - ctx - [optional] user-defined context for private data for the 1026 function evaluation routine (may be NULL) 1027 1028 Calling sequence of func: 1029 $ func (TS ts,PetscReal t,Vec u,void *ctx); 1030 1031 + t - current timestep 1032 . u - output vector 1033 - ctx - [optional] user-defined function context 1034 1035 Notes: 1036 This routine is used for testing accuracy of time integration schemes when you already know the solution. 1037 If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to 1038 create closed-form solutions with non-physical forcing terms. 1039 1040 For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 1041 1042 Level: beginner 1043 1044 .keywords: TS, timestep, set, right-hand-side, function 1045 1046 .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction() 1047 @*/ 1048 PetscErrorCode TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 1049 { 1050 PetscErrorCode ierr; 1051 DM dm; 1052 1053 PetscFunctionBegin; 1054 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1055 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1056 ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr); 1057 PetscFunctionReturn(0); 1058 } 1059 1060 #undef __FUNCT__ 1061 #define __FUNCT__ "TSSetForcingFunction" 1062 /*@C 1063 TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE 1064 1065 Logically Collective on TS 1066 1067 Input Parameters: 1068 + ts - the TS context obtained from TSCreate() 1069 . f - routine for evaluating the forcing function 1070 - ctx - [optional] user-defined context for private data for the 1071 function evaluation routine (may be NULL) 1072 1073 Calling sequence of func: 1074 $ func (TS ts,PetscReal t,Vec u,void *ctx); 1075 1076 + t - current timestep 1077 . u - output vector 1078 - ctx - [optional] user-defined function context 1079 1080 Notes: 1081 This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to 1082 create closed-form solutions with a non-physical forcing term. 1083 1084 For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 1085 1086 Level: beginner 1087 1088 .keywords: TS, timestep, set, right-hand-side, function 1089 1090 .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction() 1091 @*/ 1092 PetscErrorCode TSSetForcingFunction(TS ts,TSForcingFunction f,void *ctx) 1093 { 1094 PetscErrorCode ierr; 1095 DM dm; 1096 1097 PetscFunctionBegin; 1098 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1099 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1100 ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr); 1101 PetscFunctionReturn(0); 1102 } 1103 1104 #undef __FUNCT__ 1105 #define __FUNCT__ "TSSetRHSJacobian" 1106 /*@C 1107 TSSetRHSJacobian - Sets the function to compute the Jacobian of G, 1108 where U_t = G(U,t), as well as the location to store the matrix. 1109 1110 Logically Collective on TS 1111 1112 Input Parameters: 1113 + ts - the TS context obtained from TSCreate() 1114 . Amat - (approximate) Jacobian matrix 1115 . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1116 . f - the Jacobian evaluation routine 1117 - ctx - [optional] user-defined context for private data for the 1118 Jacobian evaluation routine (may be NULL) 1119 1120 Calling sequence of f: 1121 $ func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx); 1122 1123 + t - current timestep 1124 . u - input vector 1125 . Amat - (approximate) Jacobian matrix 1126 . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1127 - ctx - [optional] user-defined context for matrix evaluation routine 1128 1129 Notes: 1130 You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value 1131 1132 The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f() 1133 You should not assume the values are the same in the next call to f() as you set them in the previous call. 1134 1135 Level: beginner 1136 1137 .keywords: TS, timestep, set, right-hand-side, Jacobian 1138 1139 .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian() 1140 1141 @*/ 1142 PetscErrorCode TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx) 1143 { 1144 PetscErrorCode ierr; 1145 SNES snes; 1146 DM dm; 1147 TSIJacobian ijacobian; 1148 1149 PetscFunctionBegin; 1150 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1151 if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1152 if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1153 if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1154 if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 1155 1156 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1157 ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr); 1158 if (f == TSComputeRHSJacobianConstant) { 1159 /* Handle this case automatically for the user; otherwise user should call themselves. */ 1160 ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr); 1161 } 1162 ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr); 1163 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1164 if (!ijacobian) { 1165 ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1166 } 1167 if (Amat) { 1168 ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 1169 ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 1170 ts->Arhs = Amat; 1171 } 1172 if (Pmat) { 1173 ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr); 1174 ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1175 ts->Brhs = Pmat; 1176 } 1177 PetscFunctionReturn(0); 1178 } 1179 1180 1181 #undef __FUNCT__ 1182 #define __FUNCT__ "TSSetIFunction" 1183 /*@C 1184 TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved. 1185 1186 Logically Collective on TS 1187 1188 Input Parameters: 1189 + ts - the TS context obtained from TSCreate() 1190 . r - vector to hold the residual (or NULL to have it created internally) 1191 . f - the function evaluation routine 1192 - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1193 1194 Calling sequence of f: 1195 $ f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx); 1196 1197 + t - time at step/stage being solved 1198 . u - state vector 1199 . u_t - time derivative of state vector 1200 . F - function vector 1201 - ctx - [optional] user-defined context for matrix evaluation routine 1202 1203 Important: 1204 The user MUST call either this routine or TSSetRHSFunction() to define the ODE. When solving DAEs you must use this function. 1205 1206 Level: beginner 1207 1208 .keywords: TS, timestep, set, DAE, Jacobian 1209 1210 .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian() 1211 @*/ 1212 PetscErrorCode TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx) 1213 { 1214 PetscErrorCode ierr; 1215 SNES snes; 1216 Vec ralloc = NULL; 1217 DM dm; 1218 1219 PetscFunctionBegin; 1220 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1221 if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 1222 1223 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1224 ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr); 1225 1226 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1227 if (!r && !ts->dm && ts->vec_sol) { 1228 ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 1229 r = ralloc; 1230 } 1231 ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 1232 ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 1233 PetscFunctionReturn(0); 1234 } 1235 1236 #undef __FUNCT__ 1237 #define __FUNCT__ "TSGetIFunction" 1238 /*@C 1239 TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1240 1241 Not Collective 1242 1243 Input Parameter: 1244 . ts - the TS context 1245 1246 Output Parameter: 1247 + r - vector to hold residual (or NULL) 1248 . func - the function to compute residual (or NULL) 1249 - ctx - the function context (or NULL) 1250 1251 Level: advanced 1252 1253 .keywords: TS, nonlinear, get, function 1254 1255 .seealso: TSSetIFunction(), SNESGetFunction() 1256 @*/ 1257 PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx) 1258 { 1259 PetscErrorCode ierr; 1260 SNES snes; 1261 DM dm; 1262 1263 PetscFunctionBegin; 1264 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1265 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1266 ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 1267 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1268 ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr); 1269 PetscFunctionReturn(0); 1270 } 1271 1272 #undef __FUNCT__ 1273 #define __FUNCT__ "TSGetRHSFunction" 1274 /*@C 1275 TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it. 1276 1277 Not Collective 1278 1279 Input Parameter: 1280 . ts - the TS context 1281 1282 Output Parameter: 1283 + r - vector to hold computed right hand side (or NULL) 1284 . func - the function to compute right hand side (or NULL) 1285 - ctx - the function context (or NULL) 1286 1287 Level: advanced 1288 1289 .keywords: TS, nonlinear, get, function 1290 1291 .seealso: TSSetRHSFunction(), SNESGetFunction() 1292 @*/ 1293 PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx) 1294 { 1295 PetscErrorCode ierr; 1296 SNES snes; 1297 DM dm; 1298 1299 PetscFunctionBegin; 1300 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1301 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1302 ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 1303 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1304 ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr); 1305 PetscFunctionReturn(0); 1306 } 1307 1308 #undef __FUNCT__ 1309 #define __FUNCT__ "TSSetIJacobian" 1310 /*@C 1311 TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function 1312 provided with TSSetIFunction(). 1313 1314 Logically Collective on TS 1315 1316 Input Parameters: 1317 + ts - the TS context obtained from TSCreate() 1318 . Amat - (approximate) Jacobian matrix 1319 . Pmat - matrix used to compute preconditioner (usually the same as Amat) 1320 . f - the Jacobian evaluation routine 1321 - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1322 1323 Calling sequence of f: 1324 $ f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx); 1325 1326 + t - time at step/stage being solved 1327 . U - state vector 1328 . U_t - time derivative of state vector 1329 . a - shift 1330 . Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t 1331 . Pmat - matrix used for constructing preconditioner, usually the same as Amat 1332 - ctx - [optional] user-defined context for matrix evaluation routine 1333 1334 Notes: 1335 The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve. 1336 1337 If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null 1338 space to Amat and the KSP solvers will automatically use that null space as needed during the solution process. 1339 1340 The matrix dF/dU + a*dF/dU_t you provide turns out to be 1341 the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved. 1342 The time integrator internally approximates U_t by W+a*U where the positive "shift" 1343 a and vector W depend on the integration method, step size, and past states. For example with 1344 the backward Euler method a = 1/dt and W = -a*U(previous timestep) so 1345 W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt 1346 1347 You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value 1348 1349 The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f() 1350 You should not assume the values are the same in the next call to f() as you set them in the previous call. 1351 1352 Level: beginner 1353 1354 .keywords: TS, timestep, DAE, Jacobian 1355 1356 .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction() 1357 1358 @*/ 1359 PetscErrorCode TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx) 1360 { 1361 PetscErrorCode ierr; 1362 SNES snes; 1363 DM dm; 1364 1365 PetscFunctionBegin; 1366 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1367 if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1368 if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1369 if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1370 if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 1371 1372 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1373 ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr); 1374 1375 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1376 ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1377 PetscFunctionReturn(0); 1378 } 1379 1380 #undef __FUNCT__ 1381 #define __FUNCT__ "TSRHSJacobianSetReuse" 1382 /*@ 1383 TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating. Without this flag, TS will change the sign and 1384 shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute 1385 the entire Jacobian. The reuse flag must be set if the evaluation function will assume that the matrix entries have 1386 not been changed by the TS. 1387 1388 Logically Collective 1389 1390 Input Arguments: 1391 + ts - TS context obtained from TSCreate() 1392 - reuse - PETSC_TRUE if the RHS Jacobian 1393 1394 Level: intermediate 1395 1396 .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 1397 @*/ 1398 PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse) 1399 { 1400 PetscFunctionBegin; 1401 ts->rhsjacobian.reuse = reuse; 1402 PetscFunctionReturn(0); 1403 } 1404 1405 #undef __FUNCT__ 1406 #define __FUNCT__ "TSSetI2Function" 1407 /*@C 1408 TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved. 1409 1410 Logically Collective on TS 1411 1412 Input Parameters: 1413 + ts - the TS context obtained from TSCreate() 1414 . F - vector to hold the residual (or NULL to have it created internally) 1415 . fun - the function evaluation routine 1416 - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1417 1418 Calling sequence of fun: 1419 $ fun(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,Vec F,ctx); 1420 1421 + t - time at step/stage being solved 1422 . U - state vector 1423 . U_t - time derivative of state vector 1424 . U_tt - second time derivative of state vector 1425 . F - function vector 1426 - ctx - [optional] user-defined context for matrix evaluation routine (may be NULL) 1427 1428 Level: beginner 1429 1430 .keywords: TS, timestep, set, ODE, DAE, Function 1431 1432 .seealso: TSSetI2Jacobian() 1433 @*/ 1434 PetscErrorCode TSSetI2Function(TS ts,Vec F,TSI2Function fun,void *ctx) 1435 { 1436 DM dm; 1437 PetscErrorCode ierr; 1438 1439 PetscFunctionBegin; 1440 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1441 if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,2); 1442 ierr = TSSetIFunction(ts,F,NULL,NULL);CHKERRQ(ierr); 1443 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1444 ierr = DMTSSetI2Function(dm,fun,ctx);CHKERRQ(ierr); 1445 PetscFunctionReturn(0); 1446 } 1447 1448 #undef __FUNCT__ 1449 #define __FUNCT__ "TSGetI2Function" 1450 /*@C 1451 TSGetI2Function - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1452 1453 Not Collective 1454 1455 Input Parameter: 1456 . ts - the TS context 1457 1458 Output Parameter: 1459 + r - vector to hold residual (or NULL) 1460 . fun - the function to compute residual (or NULL) 1461 - ctx - the function context (or NULL) 1462 1463 Level: advanced 1464 1465 .keywords: TS, nonlinear, get, function 1466 1467 .seealso: TSSetI2Function(), SNESGetFunction() 1468 @*/ 1469 PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx) 1470 { 1471 PetscErrorCode ierr; 1472 SNES snes; 1473 DM dm; 1474 1475 PetscFunctionBegin; 1476 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1477 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1478 ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 1479 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1480 ierr = DMTSGetI2Function(dm,fun,ctx);CHKERRQ(ierr); 1481 PetscFunctionReturn(0); 1482 } 1483 1484 #undef __FUNCT__ 1485 #define __FUNCT__ "TSSetI2Jacobian" 1486 /*@C 1487 TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t + a*dF/dU_tt 1488 where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function(). 1489 1490 Logically Collective on TS 1491 1492 Input Parameters: 1493 + ts - the TS context obtained from TSCreate() 1494 . J - Jacobian matrix 1495 . P - preconditioning matrix for J (may be same as J) 1496 . jac - the Jacobian evaluation routine 1497 - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1498 1499 Calling sequence of jac: 1500 $ jac(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,PetscReal v,PetscReal a,Mat J,Mat P,void *ctx); 1501 1502 + t - time at step/stage being solved 1503 . U - state vector 1504 . U_t - time derivative of state vector 1505 . U_tt - second time derivative of state vector 1506 . v - shift for U_t 1507 . a - shift for U_tt 1508 . J - Jacobian of G(U) = F(t,U,W+v*U,W'+a*U), equivalent to dF/dU + v*dF/dU_t + a*dF/dU_tt 1509 . P - preconditioning matrix for J, may be same as J 1510 - ctx - [optional] user-defined context for matrix evaluation routine 1511 1512 Notes: 1513 The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve. 1514 1515 The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be 1516 the Jacobian of G(U) = F(t,U,W+v*U,W'+a*U) where F(t,U,U_t,U_tt) = 0 is the DAE to be solved. 1517 The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U where the positive "shift" 1518 parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states. 1519 1520 Level: beginner 1521 1522 .keywords: TS, timestep, set, ODE, DAE, Jacobian 1523 1524 .seealso: TSSetI2Function() 1525 @*/ 1526 PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx) 1527 { 1528 DM dm; 1529 PetscErrorCode ierr; 1530 1531 PetscFunctionBegin; 1532 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1533 if (J) PetscValidHeaderSpecific(J,MAT_CLASSID,2); 1534 if (P) PetscValidHeaderSpecific(P,MAT_CLASSID,3); 1535 ierr = TSSetIJacobian(ts,J,P,NULL,NULL);CHKERRQ(ierr); 1536 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1537 ierr = DMTSSetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr); 1538 PetscFunctionReturn(0); 1539 } 1540 1541 #undef __FUNCT__ 1542 #define __FUNCT__ "TSGetI2Jacobian" 1543 /*@C 1544 TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep. 1545 1546 Not Collective, but parallel objects are returned if TS is parallel 1547 1548 Input Parameter: 1549 . ts - The TS context obtained from TSCreate() 1550 1551 Output Parameters: 1552 + J - The (approximate) Jacobian of F(t,U,U_t,U_tt) 1553 . P - The matrix from which the preconditioner is constructed, often the same as J 1554 . jac - The function to compute the Jacobian matrices 1555 - ctx - User-defined context for Jacobian evaluation routine 1556 1557 Notes: You can pass in NULL for any return argument you do not need. 1558 1559 Level: advanced 1560 1561 .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 1562 1563 .keywords: TS, timestep, get, matrix, Jacobian 1564 @*/ 1565 PetscErrorCode TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx) 1566 { 1567 PetscErrorCode ierr; 1568 SNES snes; 1569 DM dm; 1570 1571 PetscFunctionBegin; 1572 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1573 ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 1574 ierr = SNESGetJacobian(snes,J,P,NULL,NULL);CHKERRQ(ierr); 1575 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1576 ierr = DMTSGetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr); 1577 PetscFunctionReturn(0); 1578 } 1579 1580 #undef __FUNCT__ 1581 #define __FUNCT__ "TSComputeI2Function" 1582 /*@ 1583 TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0 1584 1585 Collective on TS and Vec 1586 1587 Input Parameters: 1588 + ts - the TS context 1589 . t - current time 1590 . U - state vector 1591 . V - time derivative of state vector (U_t) 1592 - A - second time derivative of state vector (U_tt) 1593 1594 Output Parameter: 1595 . F - the residual vector 1596 1597 Note: 1598 Most users should not need to explicitly call this routine, as it 1599 is used internally within the nonlinear solvers. 1600 1601 Level: developer 1602 1603 .keywords: TS, compute, function, vector 1604 1605 .seealso: TSSetI2Function() 1606 @*/ 1607 PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F) 1608 { 1609 DM dm; 1610 TSI2Function I2Function; 1611 void *ctx; 1612 TSRHSFunction rhsfunction; 1613 PetscErrorCode ierr; 1614 1615 PetscFunctionBegin; 1616 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1617 PetscValidHeaderSpecific(U,VEC_CLASSID,3); 1618 PetscValidHeaderSpecific(V,VEC_CLASSID,4); 1619 PetscValidHeaderSpecific(A,VEC_CLASSID,5); 1620 PetscValidHeaderSpecific(F,VEC_CLASSID,6); 1621 1622 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1623 ierr = DMTSGetI2Function(dm,&I2Function,&ctx);CHKERRQ(ierr); 1624 ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 1625 1626 if (!I2Function) { 1627 ierr = TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE);CHKERRQ(ierr); 1628 PetscFunctionReturn(0); 1629 } 1630 1631 ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr); 1632 1633 PetscStackPush("TS user implicit function"); 1634 ierr = I2Function(ts,t,U,V,A,F,ctx);CHKERRQ(ierr); 1635 PetscStackPop; 1636 1637 if (rhsfunction) { 1638 Vec Frhs; 1639 ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 1640 ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 1641 ierr = VecAXPY(F,-1,Frhs);CHKERRQ(ierr); 1642 } 1643 1644 ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr); 1645 PetscFunctionReturn(0); 1646 } 1647 1648 #undef __FUNCT__ 1649 #define __FUNCT__ "TSComputeI2Jacobian" 1650 /*@ 1651 TSComputeI2Jacobian - Evaluates the Jacobian of the DAE 1652 1653 Collective on TS and Vec 1654 1655 Input Parameters: 1656 + ts - the TS context 1657 . t - current timestep 1658 . U - state vector 1659 . V - time derivative of state vector 1660 . A - second time derivative of state vector 1661 . shiftV - shift to apply, see note below 1662 - shiftA - shift to apply, see note below 1663 1664 Output Parameters: 1665 + J - Jacobian matrix 1666 - P - optional preconditioning matrix 1667 1668 Notes: 1669 If F(t,U,V,A)=0 is the DAE, the required Jacobian is 1670 1671 dF/dU + shiftV*dF/dV + shiftA*dF/dA 1672 1673 Most users should not need to explicitly call this routine, as it 1674 is used internally within the nonlinear solvers. 1675 1676 Level: developer 1677 1678 .keywords: TS, compute, Jacobian, matrix 1679 1680 .seealso: TSSetI2Jacobian() 1681 @*/ 1682 PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P) 1683 { 1684 DM dm; 1685 TSI2Jacobian I2Jacobian; 1686 void *ctx; 1687 TSRHSJacobian rhsjacobian; 1688 PetscErrorCode ierr; 1689 1690 PetscFunctionBegin; 1691 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1692 PetscValidHeaderSpecific(U,VEC_CLASSID,3); 1693 PetscValidHeaderSpecific(V,VEC_CLASSID,4); 1694 PetscValidHeaderSpecific(A,VEC_CLASSID,5); 1695 PetscValidHeaderSpecific(J,MAT_CLASSID,8); 1696 PetscValidHeaderSpecific(P,MAT_CLASSID,9); 1697 1698 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1699 ierr = DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx);CHKERRQ(ierr); 1700 ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 1701 1702 if (!I2Jacobian) { 1703 ierr = TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE);CHKERRQ(ierr); 1704 PetscFunctionReturn(0); 1705 } 1706 1707 ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr); 1708 1709 PetscStackPush("TS user implicit Jacobian"); 1710 ierr = I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx);CHKERRQ(ierr); 1711 PetscStackPop; 1712 1713 if (rhsjacobian) { 1714 Mat Jrhs,Prhs; MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 1715 ierr = TSGetRHSMats_Private(ts,&Jrhs,&Prhs);CHKERRQ(ierr); 1716 ierr = TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs);CHKERRQ(ierr); 1717 ierr = MatAXPY(J,-1,Jrhs,axpy);CHKERRQ(ierr); 1718 if (P != J) {ierr = MatAXPY(P,-1,Prhs,axpy);CHKERRQ(ierr);} 1719 } 1720 1721 ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr); 1722 PetscFunctionReturn(0); 1723 } 1724 1725 #undef __FUNCT__ 1726 #define __FUNCT__ "TS2SetSolution" 1727 /*@ 1728 TS2SetSolution - Sets the initial solution and time derivative vectors 1729 for use by the TS routines handling second order equations. 1730 1731 Logically Collective on TS and Vec 1732 1733 Input Parameters: 1734 + ts - the TS context obtained from TSCreate() 1735 . u - the solution vector 1736 - v - the time derivative vector 1737 1738 Level: beginner 1739 1740 .keywords: TS, timestep, set, solution, initial conditions 1741 @*/ 1742 PetscErrorCode TS2SetSolution(TS ts,Vec u,Vec v) 1743 { 1744 PetscErrorCode ierr; 1745 1746 PetscFunctionBegin; 1747 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1748 PetscValidHeaderSpecific(u,VEC_CLASSID,2); 1749 PetscValidHeaderSpecific(v,VEC_CLASSID,3); 1750 ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 1751 ierr = PetscObjectReference((PetscObject)v);CHKERRQ(ierr); 1752 ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr); 1753 ts->vec_dot = v; 1754 PetscFunctionReturn(0); 1755 } 1756 1757 #undef __FUNCT__ 1758 #define __FUNCT__ "TS2GetSolution" 1759 /*@ 1760 TS2GetSolution - Returns the solution and time derivative at the present timestep 1761 for second order equations. It is valid to call this routine inside the function 1762 that you are evaluating in order to move to the new timestep. This vector not 1763 changed until the solution at the next timestep has been calculated. 1764 1765 Not Collective, but Vec returned is parallel if TS is parallel 1766 1767 Input Parameter: 1768 . ts - the TS context obtained from TSCreate() 1769 1770 Output Parameter: 1771 + u - the vector containing the solution 1772 - v - the vector containing the time derivative 1773 1774 Level: intermediate 1775 1776 .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime() 1777 1778 .keywords: TS, timestep, get, solution 1779 @*/ 1780 PetscErrorCode TS2GetSolution(TS ts,Vec *u,Vec *v) 1781 { 1782 PetscFunctionBegin; 1783 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1784 if (u) PetscValidPointer(u,2); 1785 if (v) PetscValidPointer(v,3); 1786 if (u) *u = ts->vec_sol; 1787 if (v) *v = ts->vec_dot; 1788 PetscFunctionReturn(0); 1789 } 1790 1791 #undef __FUNCT__ 1792 #define __FUNCT__ "TSLoad" 1793 /*@C 1794 TSLoad - Loads a KSP that has been stored in binary with KSPView(). 1795 1796 Collective on PetscViewer 1797 1798 Input Parameters: 1799 + newdm - the newly loaded TS, this needs to have been created with TSCreate() or 1800 some related function before a call to TSLoad(). 1801 - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() 1802 1803 Level: intermediate 1804 1805 Notes: 1806 The type is determined by the data in the file, any type set into the TS before this call is ignored. 1807 1808 Notes for advanced users: 1809 Most users should not need to know the details of the binary storage 1810 format, since TSLoad() and TSView() completely hide these details. 1811 But for anyone who's interested, the standard binary matrix storage 1812 format is 1813 .vb 1814 has not yet been determined 1815 .ve 1816 1817 .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad() 1818 @*/ 1819 PetscErrorCode TSLoad(TS ts, PetscViewer viewer) 1820 { 1821 PetscErrorCode ierr; 1822 PetscBool isbinary; 1823 PetscInt classid; 1824 char type[256]; 1825 DMTS sdm; 1826 DM dm; 1827 1828 PetscFunctionBegin; 1829 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1830 PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1831 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 1832 if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()"); 1833 1834 ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr); 1835 if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file"); 1836 ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr); 1837 ierr = TSSetType(ts, type);CHKERRQ(ierr); 1838 if (ts->ops->load) { 1839 ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr); 1840 } 1841 ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr); 1842 ierr = DMLoad(dm,viewer);CHKERRQ(ierr); 1843 ierr = TSSetDM(ts,dm);CHKERRQ(ierr); 1844 ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr); 1845 ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr); 1846 ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 1847 ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr); 1848 PetscFunctionReturn(0); 1849 } 1850 1851 #include <petscdraw.h> 1852 #if defined(PETSC_HAVE_SAWS) 1853 #include <petscviewersaws.h> 1854 #endif 1855 #undef __FUNCT__ 1856 #define __FUNCT__ "TSView" 1857 /*@C 1858 TSView - Prints the TS data structure. 1859 1860 Collective on TS 1861 1862 Input Parameters: 1863 + ts - the TS context obtained from TSCreate() 1864 - viewer - visualization context 1865 1866 Options Database Key: 1867 . -ts_view - calls TSView() at end of TSStep() 1868 1869 Notes: 1870 The available visualization contexts include 1871 + PETSC_VIEWER_STDOUT_SELF - standard output (default) 1872 - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 1873 output where only the first processor opens 1874 the file. All other processors send their 1875 data to the first processor to print. 1876 1877 The user can open an alternative visualization context with 1878 PetscViewerASCIIOpen() - output to a specified file. 1879 1880 Level: beginner 1881 1882 .keywords: TS, timestep, view 1883 1884 .seealso: PetscViewerASCIIOpen() 1885 @*/ 1886 PetscErrorCode TSView(TS ts,PetscViewer viewer) 1887 { 1888 PetscErrorCode ierr; 1889 TSType type; 1890 PetscBool iascii,isstring,isundials,isbinary,isdraw; 1891 DMTS sdm; 1892 #if defined(PETSC_HAVE_SAWS) 1893 PetscBool issaws; 1894 #endif 1895 1896 PetscFunctionBegin; 1897 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1898 if (!viewer) { 1899 ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr); 1900 } 1901 PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1902 PetscCheckSameComm(ts,1,viewer,2); 1903 1904 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1905 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 1906 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 1907 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 1908 #if defined(PETSC_HAVE_SAWS) 1909 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr); 1910 #endif 1911 if (iascii) { 1912 ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr); 1913 ierr = PetscViewerASCIIPrintf(viewer," maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr); 1914 ierr = PetscViewerASCIIPrintf(viewer," maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr); 1915 if (ts->problem_type == TS_NONLINEAR) { 1916 ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr); 1917 ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr); 1918 } 1919 ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr); 1920 ierr = PetscViewerASCIIPrintf(viewer," total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr); 1921 if (ts->vrtol) { 1922 ierr = PetscViewerASCIIPrintf(viewer," using vector of relative error tolerances, ");CHKERRQ(ierr); 1923 } else { 1924 ierr = PetscViewerASCIIPrintf(viewer," using relative error tolerance of %g, ",(double)ts->rtol);CHKERRQ(ierr); 1925 } 1926 if (ts->vatol) { 1927 ierr = PetscViewerASCIIPrintf(viewer," using vector of absolute error tolerances\n");CHKERRQ(ierr); 1928 } else { 1929 ierr = PetscViewerASCIIPrintf(viewer," using absolute error tolerance of %g\n",(double)ts->atol);CHKERRQ(ierr); 1930 } 1931 ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 1932 ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 1933 if (ts->ops->view) { 1934 ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1935 ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1936 ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1937 } 1938 } else if (isstring) { 1939 ierr = TSGetType(ts,&type);CHKERRQ(ierr); 1940 ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr); 1941 } else if (isbinary) { 1942 PetscInt classid = TS_FILE_CLASSID; 1943 MPI_Comm comm; 1944 PetscMPIInt rank; 1945 char type[256]; 1946 1947 ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 1948 ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 1949 if (!rank) { 1950 ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 1951 ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr); 1952 ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 1953 } 1954 if (ts->ops->view) { 1955 ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1956 } 1957 ierr = DMView(ts->dm,viewer);CHKERRQ(ierr); 1958 ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr); 1959 ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 1960 ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 1961 } else if (isdraw) { 1962 PetscDraw draw; 1963 char str[36]; 1964 PetscReal x,y,bottom,h; 1965 1966 ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 1967 ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 1968 ierr = PetscStrcpy(str,"TS: ");CHKERRQ(ierr); 1969 ierr = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr); 1970 ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 1971 bottom = y - h; 1972 ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 1973 if (ts->ops->view) { 1974 ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1975 } 1976 ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 1977 #if defined(PETSC_HAVE_SAWS) 1978 } else if (issaws) { 1979 PetscMPIInt rank; 1980 const char *name; 1981 1982 ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr); 1983 ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 1984 if (!((PetscObject)ts)->amsmem && !rank) { 1985 char dir[1024]; 1986 1987 ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr); 1988 ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr); 1989 PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT)); 1990 ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr); 1991 PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE)); 1992 } 1993 if (ts->ops->view) { 1994 ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1995 } 1996 #endif 1997 } 1998 1999 ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 2000 ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr); 2001 ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2002 PetscFunctionReturn(0); 2003 } 2004 2005 2006 #undef __FUNCT__ 2007 #define __FUNCT__ "TSSetApplicationContext" 2008 /*@ 2009 TSSetApplicationContext - Sets an optional user-defined context for 2010 the timesteppers. 2011 2012 Logically Collective on TS 2013 2014 Input Parameters: 2015 + ts - the TS context obtained from TSCreate() 2016 - usrP - optional user context 2017 2018 Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this 2019 function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 2020 2021 Level: intermediate 2022 2023 .keywords: TS, timestep, set, application, context 2024 2025 .seealso: TSGetApplicationContext() 2026 @*/ 2027 PetscErrorCode TSSetApplicationContext(TS ts,void *usrP) 2028 { 2029 PetscFunctionBegin; 2030 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2031 ts->user = usrP; 2032 PetscFunctionReturn(0); 2033 } 2034 2035 #undef __FUNCT__ 2036 #define __FUNCT__ "TSGetApplicationContext" 2037 /*@ 2038 TSGetApplicationContext - Gets the user-defined context for the 2039 timestepper. 2040 2041 Not Collective 2042 2043 Input Parameter: 2044 . ts - the TS context obtained from TSCreate() 2045 2046 Output Parameter: 2047 . usrP - user context 2048 2049 Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this 2050 function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 2051 2052 Level: intermediate 2053 2054 .keywords: TS, timestep, get, application, context 2055 2056 .seealso: TSSetApplicationContext() 2057 @*/ 2058 PetscErrorCode TSGetApplicationContext(TS ts,void *usrP) 2059 { 2060 PetscFunctionBegin; 2061 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2062 *(void**)usrP = ts->user; 2063 PetscFunctionReturn(0); 2064 } 2065 2066 #undef __FUNCT__ 2067 #define __FUNCT__ "TSGetTimeStepNumber" 2068 /*@ 2069 TSGetTimeStepNumber - Gets the number of time steps completed. 2070 2071 Not Collective 2072 2073 Input Parameter: 2074 . ts - the TS context obtained from TSCreate() 2075 2076 Output Parameter: 2077 . iter - number of steps completed so far 2078 2079 Level: intermediate 2080 2081 .keywords: TS, timestep, get, iteration, number 2082 .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep() 2083 @*/ 2084 PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *iter) 2085 { 2086 PetscFunctionBegin; 2087 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2088 PetscValidIntPointer(iter,2); 2089 *iter = ts->steps; 2090 PetscFunctionReturn(0); 2091 } 2092 2093 #undef __FUNCT__ 2094 #define __FUNCT__ "TSSetInitialTimeStep" 2095 /*@ 2096 TSSetInitialTimeStep - Sets the initial timestep to be used, 2097 as well as the initial time. 2098 2099 Logically Collective on TS 2100 2101 Input Parameters: 2102 + ts - the TS context obtained from TSCreate() 2103 . initial_time - the initial time 2104 - time_step - the size of the timestep 2105 2106 Level: intermediate 2107 2108 .seealso: TSSetTimeStep(), TSGetTimeStep() 2109 2110 .keywords: TS, set, initial, timestep 2111 @*/ 2112 PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step) 2113 { 2114 PetscErrorCode ierr; 2115 2116 PetscFunctionBegin; 2117 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2118 ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 2119 ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr); 2120 PetscFunctionReturn(0); 2121 } 2122 2123 #undef __FUNCT__ 2124 #define __FUNCT__ "TSSetTimeStep" 2125 /*@ 2126 TSSetTimeStep - Allows one to reset the timestep at any time, 2127 useful for simple pseudo-timestepping codes. 2128 2129 Logically Collective on TS 2130 2131 Input Parameters: 2132 + ts - the TS context obtained from TSCreate() 2133 - time_step - the size of the timestep 2134 2135 Level: intermediate 2136 2137 .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 2138 2139 .keywords: TS, set, timestep 2140 @*/ 2141 PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step) 2142 { 2143 PetscFunctionBegin; 2144 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2145 PetscValidLogicalCollectiveReal(ts,time_step,2); 2146 ts->time_step = time_step; 2147 PetscFunctionReturn(0); 2148 } 2149 2150 #undef __FUNCT__ 2151 #define __FUNCT__ "TSSetExactFinalTime" 2152 /*@ 2153 TSSetExactFinalTime - Determines whether to adapt the final time step to 2154 match the exact final time, interpolate solution to the exact final time, 2155 or just return at the final time TS computed. 2156 2157 Logically Collective on TS 2158 2159 Input Parameter: 2160 + ts - the time-step context 2161 - eftopt - exact final time option 2162 2163 $ TS_EXACTFINALTIME_STEPOVER - Don't do anything if final time is exceeded 2164 $ TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time 2165 $ TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time 2166 2167 Options Database: 2168 . -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime 2169 2170 Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time 2171 then the final time you selected. 2172 2173 Level: beginner 2174 2175 .seealso: TSExactFinalTimeOption 2176 @*/ 2177 PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt) 2178 { 2179 PetscFunctionBegin; 2180 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2181 PetscValidLogicalCollectiveEnum(ts,eftopt,2); 2182 ts->exact_final_time = eftopt; 2183 PetscFunctionReturn(0); 2184 } 2185 2186 #undef __FUNCT__ 2187 #define __FUNCT__ "TSGetTimeStep" 2188 /*@ 2189 TSGetTimeStep - Gets the current timestep size. 2190 2191 Not Collective 2192 2193 Input Parameter: 2194 . ts - the TS context obtained from TSCreate() 2195 2196 Output Parameter: 2197 . dt - the current timestep size 2198 2199 Level: intermediate 2200 2201 .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 2202 2203 .keywords: TS, get, timestep 2204 @*/ 2205 PetscErrorCode TSGetTimeStep(TS ts,PetscReal *dt) 2206 { 2207 PetscFunctionBegin; 2208 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2209 PetscValidRealPointer(dt,2); 2210 *dt = ts->time_step; 2211 PetscFunctionReturn(0); 2212 } 2213 2214 #undef __FUNCT__ 2215 #define __FUNCT__ "TSGetSolution" 2216 /*@ 2217 TSGetSolution - Returns the solution at the present timestep. It 2218 is valid to call this routine inside the function that you are evaluating 2219 in order to move to the new timestep. This vector not changed until 2220 the solution at the next timestep has been calculated. 2221 2222 Not Collective, but Vec returned is parallel if TS is parallel 2223 2224 Input Parameter: 2225 . ts - the TS context obtained from TSCreate() 2226 2227 Output Parameter: 2228 . v - the vector containing the solution 2229 2230 Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested 2231 final time. It returns the solution at the next timestep. 2232 2233 Level: intermediate 2234 2235 .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime() 2236 2237 .keywords: TS, timestep, get, solution 2238 @*/ 2239 PetscErrorCode TSGetSolution(TS ts,Vec *v) 2240 { 2241 PetscFunctionBegin; 2242 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2243 PetscValidPointer(v,2); 2244 *v = ts->vec_sol; 2245 PetscFunctionReturn(0); 2246 } 2247 2248 #undef __FUNCT__ 2249 #define __FUNCT__ "TSGetCostGradients" 2250 /*@ 2251 TSGetCostGradients - Returns the gradients from the TSAdjointSolve() 2252 2253 Not Collective, but Vec returned is parallel if TS is parallel 2254 2255 Input Parameter: 2256 . ts - the TS context obtained from TSCreate() 2257 2258 Output Parameter: 2259 + lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables 2260 - mu - vectors containing the gradients of the cost functions with respect to the problem parameters 2261 2262 Level: intermediate 2263 2264 .seealso: TSGetTimeStep() 2265 2266 .keywords: TS, timestep, get, sensitivity 2267 @*/ 2268 PetscErrorCode TSGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu) 2269 { 2270 PetscFunctionBegin; 2271 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2272 if (numcost) *numcost = ts->numcost; 2273 if (lambda) *lambda = ts->vecs_sensi; 2274 if (mu) *mu = ts->vecs_sensip; 2275 PetscFunctionReturn(0); 2276 } 2277 2278 /* ----- Routines to initialize and destroy a timestepper ---- */ 2279 #undef __FUNCT__ 2280 #define __FUNCT__ "TSSetProblemType" 2281 /*@ 2282 TSSetProblemType - Sets the type of problem to be solved. 2283 2284 Not collective 2285 2286 Input Parameters: 2287 + ts - The TS 2288 - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 2289 .vb 2290 U_t - A U = 0 (linear) 2291 U_t - A(t) U = 0 (linear) 2292 F(t,U,U_t) = 0 (nonlinear) 2293 .ve 2294 2295 Level: beginner 2296 2297 .keywords: TS, problem type 2298 .seealso: TSSetUp(), TSProblemType, TS 2299 @*/ 2300 PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 2301 { 2302 PetscErrorCode ierr; 2303 2304 PetscFunctionBegin; 2305 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2306 ts->problem_type = type; 2307 if (type == TS_LINEAR) { 2308 SNES snes; 2309 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2310 ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr); 2311 } 2312 PetscFunctionReturn(0); 2313 } 2314 2315 #undef __FUNCT__ 2316 #define __FUNCT__ "TSGetProblemType" 2317 /*@C 2318 TSGetProblemType - Gets the type of problem to be solved. 2319 2320 Not collective 2321 2322 Input Parameter: 2323 . ts - The TS 2324 2325 Output Parameter: 2326 . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 2327 .vb 2328 M U_t = A U 2329 M(t) U_t = A(t) U 2330 F(t,U,U_t) 2331 .ve 2332 2333 Level: beginner 2334 2335 .keywords: TS, problem type 2336 .seealso: TSSetUp(), TSProblemType, TS 2337 @*/ 2338 PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 2339 { 2340 PetscFunctionBegin; 2341 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2342 PetscValidIntPointer(type,2); 2343 *type = ts->problem_type; 2344 PetscFunctionReturn(0); 2345 } 2346 2347 #undef __FUNCT__ 2348 #define __FUNCT__ "TSSetUp" 2349 /*@ 2350 TSSetUp - Sets up the internal data structures for the later use 2351 of a timestepper. 2352 2353 Collective on TS 2354 2355 Input Parameter: 2356 . ts - the TS context obtained from TSCreate() 2357 2358 Notes: 2359 For basic use of the TS solvers the user need not explicitly call 2360 TSSetUp(), since these actions will automatically occur during 2361 the call to TSStep(). However, if one wishes to control this 2362 phase separately, TSSetUp() should be called after TSCreate() 2363 and optional routines of the form TSSetXXX(), but before TSStep(). 2364 2365 Level: advanced 2366 2367 .keywords: TS, timestep, setup 2368 2369 .seealso: TSCreate(), TSStep(), TSDestroy() 2370 @*/ 2371 PetscErrorCode TSSetUp(TS ts) 2372 { 2373 PetscErrorCode ierr; 2374 DM dm; 2375 PetscErrorCode (*func)(SNES,Vec,Vec,void*); 2376 PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*); 2377 TSIFunction ifun; 2378 TSIJacobian ijac; 2379 TSI2Jacobian i2jac; 2380 TSRHSJacobian rhsjac; 2381 2382 PetscFunctionBegin; 2383 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2384 if (ts->setupcalled) PetscFunctionReturn(0); 2385 2386 ts->total_steps = 0; 2387 if (!((PetscObject)ts)->type_name) { 2388 ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr); 2389 ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr); 2390 } 2391 2392 if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first"); 2393 2394 if (ts->rhsjacobian.reuse) { 2395 Mat Amat,Pmat; 2396 SNES snes; 2397 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2398 ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr); 2399 /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would 2400 * have displaced the RHS matrix */ 2401 if (Amat == ts->Arhs) { 2402 ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr); 2403 ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr); 2404 ierr = MatDestroy(&Amat);CHKERRQ(ierr); 2405 } 2406 if (Pmat == ts->Brhs) { 2407 ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr); 2408 ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr); 2409 ierr = MatDestroy(&Pmat);CHKERRQ(ierr); 2410 } 2411 } 2412 if (ts->ops->setup) { 2413 ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr); 2414 } 2415 2416 /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction 2417 to be set right but can't do it elsewhere due to the overreliance on ctx=ts. 2418 */ 2419 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 2420 ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr); 2421 if (!func) { 2422 ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr); 2423 } 2424 /* If the SNES doesn't have a jacobian set and the TS has an ijacobian or rhsjacobian set, set the SNES to use it. 2425 Otherwise, the SNES will use coloring internally to form the Jacobian. 2426 */ 2427 ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr); 2428 ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr); 2429 ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr); 2430 ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr); 2431 if (!jac && (ijac || i2jac || rhsjac)) { 2432 ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr); 2433 } 2434 ts->setupcalled = PETSC_TRUE; 2435 PetscFunctionReturn(0); 2436 } 2437 2438 #undef __FUNCT__ 2439 #define __FUNCT__ "TSAdjointSetUp" 2440 /*@ 2441 TSAdjointSetUp - Sets up the internal data structures for the later use 2442 of an adjoint solver 2443 2444 Collective on TS 2445 2446 Input Parameter: 2447 . ts - the TS context obtained from TSCreate() 2448 2449 Level: advanced 2450 2451 .keywords: TS, timestep, setup 2452 2453 .seealso: TSCreate(), TSAdjointStep(), TSSetCostGradients() 2454 @*/ 2455 PetscErrorCode TSAdjointSetUp(TS ts) 2456 { 2457 PetscErrorCode ierr; 2458 2459 PetscFunctionBegin; 2460 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2461 if (ts->adjointsetupcalled) PetscFunctionReturn(0); 2462 if (!ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetCostGradients() first"); 2463 2464 if (ts->vec_costintegral) { /* if there is integral in the cost function*/ 2465 ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr); 2466 if (ts->vecs_sensip){ 2467 ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr); 2468 } 2469 } 2470 2471 if (ts->ops->adjointsetup) { 2472 ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr); 2473 } 2474 ts->adjointsetupcalled = PETSC_TRUE; 2475 PetscFunctionReturn(0); 2476 } 2477 2478 #undef __FUNCT__ 2479 #define __FUNCT__ "TSReset" 2480 /*@ 2481 TSReset - Resets a TS context and removes any allocated Vecs and Mats. 2482 2483 Collective on TS 2484 2485 Input Parameter: 2486 . ts - the TS context obtained from TSCreate() 2487 2488 Level: beginner 2489 2490 .keywords: TS, timestep, reset 2491 2492 .seealso: TSCreate(), TSSetup(), TSDestroy() 2493 @*/ 2494 PetscErrorCode TSReset(TS ts) 2495 { 2496 PetscErrorCode ierr; 2497 2498 PetscFunctionBegin; 2499 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2500 2501 if (ts->ops->reset) { 2502 ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr); 2503 } 2504 if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);} 2505 if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);} 2506 2507 ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 2508 ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 2509 ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr); 2510 ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 2511 ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr); 2512 ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 2513 ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 2514 ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr); 2515 2516 if (ts->vec_costintegral) { 2517 ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr); 2518 if (ts->vecs_drdp){ 2519 ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr); 2520 } 2521 } 2522 ts->vecs_sensi = NULL; 2523 ts->vecs_sensip = NULL; 2524 ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 2525 ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr); 2526 ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr); 2527 ts->setupcalled = PETSC_FALSE; 2528 PetscFunctionReturn(0); 2529 } 2530 2531 #undef __FUNCT__ 2532 #define __FUNCT__ "TSDestroy" 2533 /*@ 2534 TSDestroy - Destroys the timestepper context that was created 2535 with TSCreate(). 2536 2537 Collective on TS 2538 2539 Input Parameter: 2540 . ts - the TS context obtained from TSCreate() 2541 2542 Level: beginner 2543 2544 .keywords: TS, timestepper, destroy 2545 2546 .seealso: TSCreate(), TSSetUp(), TSSolve() 2547 @*/ 2548 PetscErrorCode TSDestroy(TS *ts) 2549 { 2550 PetscErrorCode ierr; 2551 2552 PetscFunctionBegin; 2553 if (!*ts) PetscFunctionReturn(0); 2554 PetscValidHeaderSpecific((*ts),TS_CLASSID,1); 2555 if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);} 2556 2557 ierr = TSReset((*ts));CHKERRQ(ierr); 2558 2559 /* if memory was published with SAWs then destroy it */ 2560 ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr); 2561 if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);} 2562 2563 ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr); 2564 2565 ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr); 2566 ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr); 2567 2568 ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr); 2569 ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr); 2570 ierr = TSMonitorCancel((*ts));CHKERRQ(ierr); 2571 ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr); 2572 2573 ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr); 2574 PetscFunctionReturn(0); 2575 } 2576 2577 #undef __FUNCT__ 2578 #define __FUNCT__ "TSGetSNES" 2579 /*@ 2580 TSGetSNES - Returns the SNES (nonlinear solver) associated with 2581 a TS (timestepper) context. Valid only for nonlinear problems. 2582 2583 Not Collective, but SNES is parallel if TS is parallel 2584 2585 Input Parameter: 2586 . ts - the TS context obtained from TSCreate() 2587 2588 Output Parameter: 2589 . snes - the nonlinear solver context 2590 2591 Notes: 2592 The user can then directly manipulate the SNES context to set various 2593 options, etc. Likewise, the user can then extract and manipulate the 2594 KSP, KSP, and PC contexts as well. 2595 2596 TSGetSNES() does not work for integrators that do not use SNES; in 2597 this case TSGetSNES() returns NULL in snes. 2598 2599 Level: beginner 2600 2601 .keywords: timestep, get, SNES 2602 @*/ 2603 PetscErrorCode TSGetSNES(TS ts,SNES *snes) 2604 { 2605 PetscErrorCode ierr; 2606 2607 PetscFunctionBegin; 2608 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2609 PetscValidPointer(snes,2); 2610 if (!ts->snes) { 2611 ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr); 2612 ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 2613 ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr); 2614 ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr); 2615 if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 2616 if (ts->problem_type == TS_LINEAR) { 2617 ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); 2618 } 2619 } 2620 *snes = ts->snes; 2621 PetscFunctionReturn(0); 2622 } 2623 2624 #undef __FUNCT__ 2625 #define __FUNCT__ "TSSetSNES" 2626 /*@ 2627 TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context 2628 2629 Collective 2630 2631 Input Parameter: 2632 + ts - the TS context obtained from TSCreate() 2633 - snes - the nonlinear solver context 2634 2635 Notes: 2636 Most users should have the TS created by calling TSGetSNES() 2637 2638 Level: developer 2639 2640 .keywords: timestep, set, SNES 2641 @*/ 2642 PetscErrorCode TSSetSNES(TS ts,SNES snes) 2643 { 2644 PetscErrorCode ierr; 2645 PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*); 2646 2647 PetscFunctionBegin; 2648 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2649 PetscValidHeaderSpecific(snes,SNES_CLASSID,2); 2650 ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr); 2651 ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr); 2652 2653 ts->snes = snes; 2654 2655 ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 2656 ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr); 2657 if (func == SNESTSFormJacobian) { 2658 ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr); 2659 } 2660 PetscFunctionReturn(0); 2661 } 2662 2663 #undef __FUNCT__ 2664 #define __FUNCT__ "TSGetKSP" 2665 /*@ 2666 TSGetKSP - Returns the KSP (linear solver) associated with 2667 a TS (timestepper) context. 2668 2669 Not Collective, but KSP is parallel if TS is parallel 2670 2671 Input Parameter: 2672 . ts - the TS context obtained from TSCreate() 2673 2674 Output Parameter: 2675 . ksp - the nonlinear solver context 2676 2677 Notes: 2678 The user can then directly manipulate the KSP context to set various 2679 options, etc. Likewise, the user can then extract and manipulate the 2680 KSP and PC contexts as well. 2681 2682 TSGetKSP() does not work for integrators that do not use KSP; 2683 in this case TSGetKSP() returns NULL in ksp. 2684 2685 Level: beginner 2686 2687 .keywords: timestep, get, KSP 2688 @*/ 2689 PetscErrorCode TSGetKSP(TS ts,KSP *ksp) 2690 { 2691 PetscErrorCode ierr; 2692 SNES snes; 2693 2694 PetscFunctionBegin; 2695 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2696 PetscValidPointer(ksp,2); 2697 if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first"); 2698 if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()"); 2699 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2700 ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr); 2701 PetscFunctionReturn(0); 2702 } 2703 2704 /* ----------- Routines to set solver parameters ---------- */ 2705 2706 #undef __FUNCT__ 2707 #define __FUNCT__ "TSGetDuration" 2708 /*@ 2709 TSGetDuration - Gets the maximum number of timesteps to use and 2710 maximum time for iteration. 2711 2712 Not Collective 2713 2714 Input Parameters: 2715 + ts - the TS context obtained from TSCreate() 2716 . maxsteps - maximum number of iterations to use, or NULL 2717 - maxtime - final time to iterate to, or NULL 2718 2719 Level: intermediate 2720 2721 .keywords: TS, timestep, get, maximum, iterations, time 2722 @*/ 2723 PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 2724 { 2725 PetscFunctionBegin; 2726 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2727 if (maxsteps) { 2728 PetscValidIntPointer(maxsteps,2); 2729 *maxsteps = ts->max_steps; 2730 } 2731 if (maxtime) { 2732 PetscValidScalarPointer(maxtime,3); 2733 *maxtime = ts->max_time; 2734 } 2735 PetscFunctionReturn(0); 2736 } 2737 2738 #undef __FUNCT__ 2739 #define __FUNCT__ "TSSetDuration" 2740 /*@ 2741 TSSetDuration - Sets the maximum number of timesteps to use and 2742 maximum time for iteration. 2743 2744 Logically Collective on TS 2745 2746 Input Parameters: 2747 + ts - the TS context obtained from TSCreate() 2748 . maxsteps - maximum number of iterations to use 2749 - maxtime - final time to iterate to 2750 2751 Options Database Keys: 2752 . -ts_max_steps <maxsteps> - Sets maxsteps 2753 . -ts_final_time <maxtime> - Sets maxtime 2754 2755 Notes: 2756 The default maximum number of iterations is 5000. Default time is 5.0 2757 2758 Level: intermediate 2759 2760 .keywords: TS, timestep, set, maximum, iterations 2761 2762 .seealso: TSSetExactFinalTime() 2763 @*/ 2764 PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime) 2765 { 2766 PetscFunctionBegin; 2767 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2768 PetscValidLogicalCollectiveInt(ts,maxsteps,2); 2769 PetscValidLogicalCollectiveReal(ts,maxtime,2); 2770 if (maxsteps >= 0) ts->max_steps = maxsteps; 2771 if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime; 2772 PetscFunctionReturn(0); 2773 } 2774 2775 #undef __FUNCT__ 2776 #define __FUNCT__ "TSSetSolution" 2777 /*@ 2778 TSSetSolution - Sets the initial solution vector 2779 for use by the TS routines. 2780 2781 Logically Collective on TS and Vec 2782 2783 Input Parameters: 2784 + ts - the TS context obtained from TSCreate() 2785 - u - the solution vector 2786 2787 Level: beginner 2788 2789 .keywords: TS, timestep, set, solution, initial conditions 2790 @*/ 2791 PetscErrorCode TSSetSolution(TS ts,Vec u) 2792 { 2793 PetscErrorCode ierr; 2794 DM dm; 2795 2796 PetscFunctionBegin; 2797 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2798 PetscValidHeaderSpecific(u,VEC_CLASSID,2); 2799 ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr); 2800 ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 2801 ts->vec_sol = u; 2802 2803 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 2804 ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr); 2805 PetscFunctionReturn(0); 2806 } 2807 2808 #undef __FUNCT__ 2809 #define __FUNCT__ "TSAdjointSetSteps" 2810 /*@ 2811 TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time 2812 2813 Logically Collective on TS 2814 2815 Input Parameters: 2816 + ts - the TS context obtained from TSCreate() 2817 . steps - number of steps to use 2818 2819 Level: intermediate 2820 2821 Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this 2822 so as to integrate back to less than the original timestep 2823 2824 .keywords: TS, timestep, set, maximum, iterations 2825 2826 .seealso: TSSetExactFinalTime() 2827 @*/ 2828 PetscErrorCode TSAdjointSetSteps(TS ts,PetscInt steps) 2829 { 2830 PetscFunctionBegin; 2831 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2832 PetscValidLogicalCollectiveInt(ts,steps,2); 2833 if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps"); 2834 if (steps > ts->total_steps) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back more than the total number of forward steps"); 2835 ts->adjoint_max_steps = steps; 2836 PetscFunctionReturn(0); 2837 } 2838 2839 #undef __FUNCT__ 2840 #define __FUNCT__ "TSSetCostGradients" 2841 /*@ 2842 TSSetCostGradients - Sets the initial value of the gradients of the cost function w.r.t. initial conditions and w.r.t. the problem parameters 2843 for use by the TSAdjoint routines. 2844 2845 Logically Collective on TS and Vec 2846 2847 Input Parameters: 2848 + ts - the TS context obtained from TSCreate() 2849 . lambda - gradients with respect to the initial condition variables, the dimension and parallel layout of these vectors is the same as the ODE solution vector 2850 - mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters 2851 2852 Level: beginner 2853 2854 Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime mu_i = df/dp|finaltime 2855 2856 .keywords: TS, timestep, set, sensitivity, initial conditions 2857 @*/ 2858 PetscErrorCode TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu) 2859 { 2860 PetscFunctionBegin; 2861 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2862 PetscValidPointer(lambda,2); 2863 ts->vecs_sensi = lambda; 2864 ts->vecs_sensip = mu; 2865 if (ts->numcost && ts->numcost!=numcost) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions (2rd parameter of TSSetCostIntegrand()) is inconsistent with the one set by TSSetCostIntegrand"); 2866 ts->numcost = numcost; 2867 PetscFunctionReturn(0); 2868 } 2869 2870 #undef __FUNCT__ 2871 #define __FUNCT__ "TSAdjointSetRHSJacobian" 2872 /*@C 2873 TSAdjointSetRHSJacobian - Sets the function that computes the Jacobian of G w.r.t. the parameters p where y_t = G(y,p,t), as well as the location to store the matrix. 2874 2875 Logically Collective on TS 2876 2877 Input Parameters: 2878 + ts - The TS context obtained from TSCreate() 2879 - func - The function 2880 2881 Calling sequence of func: 2882 $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx); 2883 + t - current timestep 2884 . y - input vector (current ODE solution) 2885 . A - output matrix 2886 - ctx - [optional] user-defined function context 2887 2888 Level: intermediate 2889 2890 Notes: Amat has the same number of rows and the same row parallel layout as u, Amat has the same number of columns and parallel layout as p 2891 2892 .keywords: TS, sensitivity 2893 .seealso: 2894 @*/ 2895 PetscErrorCode TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx) 2896 { 2897 PetscErrorCode ierr; 2898 2899 PetscFunctionBegin; 2900 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2901 if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 2902 2903 ts->rhsjacobianp = func; 2904 ts->rhsjacobianpctx = ctx; 2905 if(Amat) { 2906 ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 2907 ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 2908 ts->Jacp = Amat; 2909 } 2910 PetscFunctionReturn(0); 2911 } 2912 2913 #undef __FUNCT__ 2914 #define __FUNCT__ "TSAdjointComputeRHSJacobian" 2915 /*@C 2916 TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function. 2917 2918 Collective on TS 2919 2920 Input Parameters: 2921 . ts - The TS context obtained from TSCreate() 2922 2923 Level: developer 2924 2925 .keywords: TS, sensitivity 2926 .seealso: TSAdjointSetRHSJacobian() 2927 @*/ 2928 PetscErrorCode TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat) 2929 { 2930 PetscErrorCode ierr; 2931 2932 PetscFunctionBegin; 2933 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2934 PetscValidHeaderSpecific(X,VEC_CLASSID,3); 2935 PetscValidPointer(Amat,4); 2936 2937 PetscStackPush("TS user JacobianP function for sensitivity analysis"); 2938 ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr); 2939 PetscStackPop; 2940 PetscFunctionReturn(0); 2941 } 2942 2943 #undef __FUNCT__ 2944 #define __FUNCT__ "TSSetCostIntegrand" 2945 /*@C 2946 TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions 2947 2948 Logically Collective on TS 2949 2950 Input Parameters: 2951 + ts - the TS context obtained from TSCreate() 2952 . numcost - number of gradients to be computed, this is the number of cost functions 2953 . rf - routine for evaluating the integrand function 2954 . drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y 2955 . drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p 2956 . fwd - flag indicating whether to evaluate cost integral in the forward run or the adjoint run 2957 - ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL) 2958 2959 Calling sequence of rf: 2960 $ rf(TS ts,PetscReal t,Vec y,Vec f[],void *ctx); 2961 2962 + t - current timestep 2963 . y - input vector 2964 . f - function result; one vector entry for each cost function 2965 - ctx - [optional] user-defined function context 2966 2967 Calling sequence of drdyf: 2968 $ PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx); 2969 2970 Calling sequence of drdpf: 2971 $ PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx); 2972 2973 Level: intermediate 2974 2975 Notes: For optimization there is generally a single cost function, numcost = 1. For sensitivities there may be multiple cost functions 2976 2977 .keywords: TS, sensitivity analysis, timestep, set, quadrature, function 2978 2979 .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients() 2980 @*/ 2981 PetscErrorCode TSSetCostIntegrand(TS ts,PetscInt numcost,PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*), 2982 PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*), 2983 PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*), 2984 PetscBool fwd,void *ctx) 2985 { 2986 PetscErrorCode ierr; 2987 2988 PetscFunctionBegin; 2989 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2990 if (ts->numcost && ts->numcost!=numcost) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions (2rd parameter of TSSetCostIntegrand()) is inconsistent with the one set by TSSetCostGradients()"); 2991 if (!ts->numcost) ts->numcost=numcost; 2992 2993 ts->costintegralfwd = fwd; /* Evaluate the cost integral in forward run if fwd is true */ 2994 ierr = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr); 2995 ierr = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr); 2996 ts->costintegrand = rf; 2997 ts->costintegrandctx = ctx; 2998 ts->drdyfunction = drdyf; 2999 ts->drdpfunction = drdpf; 3000 PetscFunctionReturn(0); 3001 } 3002 3003 #undef __FUNCT__ 3004 #define __FUNCT__ "TSGetCostIntegral" 3005 /*@ 3006 TSGetCostIntegral - Returns the values of the integral term in the cost functions. 3007 It is valid to call the routine after a backward run. 3008 3009 Not Collective 3010 3011 Input Parameter: 3012 . ts - the TS context obtained from TSCreate() 3013 3014 Output Parameter: 3015 . v - the vector containing the integrals for each cost function 3016 3017 Level: intermediate 3018 3019 .seealso: TSSetCostIntegrand() 3020 3021 .keywords: TS, sensitivity analysis 3022 @*/ 3023 PetscErrorCode TSGetCostIntegral(TS ts,Vec *v) 3024 { 3025 PetscFunctionBegin; 3026 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3027 PetscValidPointer(v,2); 3028 *v = ts->vec_costintegral; 3029 PetscFunctionReturn(0); 3030 } 3031 3032 #undef __FUNCT__ 3033 #define __FUNCT__ "TSAdjointComputeCostIntegrand" 3034 /*@ 3035 TSAdjointComputeCostIntegrand - Evaluates the integral function in the cost functions. 3036 3037 Input Parameters: 3038 + ts - the TS context 3039 . t - current time 3040 - y - state vector, i.e. current solution 3041 3042 Output Parameter: 3043 . q - vector of size numcost to hold the outputs 3044 3045 Note: 3046 Most users should not need to explicitly call this routine, as it 3047 is used internally within the sensitivity analysis context. 3048 3049 Level: developer 3050 3051 .keywords: TS, compute 3052 3053 .seealso: TSSetCostIntegrand() 3054 @*/ 3055 PetscErrorCode TSAdjointComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q) 3056 { 3057 PetscErrorCode ierr; 3058 3059 PetscFunctionBegin; 3060 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3061 PetscValidHeaderSpecific(y,VEC_CLASSID,3); 3062 PetscValidHeaderSpecific(q,VEC_CLASSID,4); 3063 3064 ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr); 3065 if (ts->costintegrand) { 3066 PetscStackPush("TS user integrand in the cost function"); 3067 ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr); 3068 PetscStackPop; 3069 } else { 3070 ierr = VecZeroEntries(q);CHKERRQ(ierr); 3071 } 3072 3073 ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr); 3074 PetscFunctionReturn(0); 3075 } 3076 3077 #undef __FUNCT__ 3078 #define __FUNCT__ "TSAdjointComputeDRDYFunction" 3079 /*@ 3080 TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function. 3081 3082 Collective on TS 3083 3084 Input Parameters: 3085 . ts - The TS context obtained from TSCreate() 3086 3087 Notes: 3088 TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation, 3089 so most users would not generally call this routine themselves. 3090 3091 Level: developer 3092 3093 .keywords: TS, sensitivity 3094 .seealso: TSAdjointComputeDRDYFunction() 3095 @*/ 3096 PetscErrorCode TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy) 3097 { 3098 PetscErrorCode ierr; 3099 3100 PetscFunctionBegin; 3101 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3102 PetscValidHeaderSpecific(y,VEC_CLASSID,3); 3103 3104 PetscStackPush("TS user DRDY function for sensitivity analysis"); 3105 ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr); 3106 PetscStackPop; 3107 PetscFunctionReturn(0); 3108 } 3109 3110 #undef __FUNCT__ 3111 #define __FUNCT__ "TSAdjointComputeDRDPFunction" 3112 /*@ 3113 TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function. 3114 3115 Collective on TS 3116 3117 Input Parameters: 3118 . ts - The TS context obtained from TSCreate() 3119 3120 Notes: 3121 TSDRDPFunction() is typically used for sensitivity implementation, 3122 so most users would not generally call this routine themselves. 3123 3124 Level: developer 3125 3126 .keywords: TS, sensitivity 3127 .seealso: TSAdjointSetDRDPFunction() 3128 @*/ 3129 PetscErrorCode TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp) 3130 { 3131 PetscErrorCode ierr; 3132 3133 PetscFunctionBegin; 3134 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3135 PetscValidHeaderSpecific(y,VEC_CLASSID,3); 3136 3137 PetscStackPush("TS user DRDP function for sensitivity analysis"); 3138 ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr); 3139 PetscStackPop; 3140 PetscFunctionReturn(0); 3141 } 3142 3143 #undef __FUNCT__ 3144 #define __FUNCT__ "TSSetPreStep" 3145 /*@C 3146 TSSetPreStep - Sets the general-purpose function 3147 called once at the beginning of each time step. 3148 3149 Logically Collective on TS 3150 3151 Input Parameters: 3152 + ts - The TS context obtained from TSCreate() 3153 - func - The function 3154 3155 Calling sequence of func: 3156 . func (TS ts); 3157 3158 Level: intermediate 3159 3160 Note: 3161 If a step is rejected, TSStep() will call this routine again before each attempt. 3162 The last completed time step number can be queried using TSGetTimeStepNumber(), the 3163 size of the step being attempted can be obtained using TSGetTimeStep(). 3164 3165 .keywords: TS, timestep 3166 .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep() 3167 @*/ 3168 PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS)) 3169 { 3170 PetscFunctionBegin; 3171 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3172 ts->prestep = func; 3173 PetscFunctionReturn(0); 3174 } 3175 3176 #undef __FUNCT__ 3177 #define __FUNCT__ "TSPreStep" 3178 /*@ 3179 TSPreStep - Runs the user-defined pre-step function. 3180 3181 Collective on TS 3182 3183 Input Parameters: 3184 . ts - The TS context obtained from TSCreate() 3185 3186 Notes: 3187 TSPreStep() is typically used within time stepping implementations, 3188 so most users would not generally call this routine themselves. 3189 3190 Level: developer 3191 3192 .keywords: TS, timestep 3193 .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep() 3194 @*/ 3195 PetscErrorCode TSPreStep(TS ts) 3196 { 3197 PetscErrorCode ierr; 3198 3199 PetscFunctionBegin; 3200 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3201 if (ts->prestep) { 3202 PetscStackCallStandard((*ts->prestep),(ts)); 3203 } 3204 PetscFunctionReturn(0); 3205 } 3206 3207 #undef __FUNCT__ 3208 #define __FUNCT__ "TSSetPreStage" 3209 /*@C 3210 TSSetPreStage - Sets the general-purpose function 3211 called once at the beginning of each stage. 3212 3213 Logically Collective on TS 3214 3215 Input Parameters: 3216 + ts - The TS context obtained from TSCreate() 3217 - func - The function 3218 3219 Calling sequence of func: 3220 . PetscErrorCode func(TS ts, PetscReal stagetime); 3221 3222 Level: intermediate 3223 3224 Note: 3225 There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 3226 The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 3227 attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 3228 3229 .keywords: TS, timestep 3230 .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3231 @*/ 3232 PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal)) 3233 { 3234 PetscFunctionBegin; 3235 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3236 ts->prestage = func; 3237 PetscFunctionReturn(0); 3238 } 3239 3240 #undef __FUNCT__ 3241 #define __FUNCT__ "TSSetPostStage" 3242 /*@C 3243 TSSetPostStage - Sets the general-purpose function 3244 called once at the end of each stage. 3245 3246 Logically Collective on TS 3247 3248 Input Parameters: 3249 + ts - The TS context obtained from TSCreate() 3250 - func - The function 3251 3252 Calling sequence of func: 3253 . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y); 3254 3255 Level: intermediate 3256 3257 Note: 3258 There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 3259 The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 3260 attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 3261 3262 .keywords: TS, timestep 3263 .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3264 @*/ 3265 PetscErrorCode TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*)) 3266 { 3267 PetscFunctionBegin; 3268 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3269 ts->poststage = func; 3270 PetscFunctionReturn(0); 3271 } 3272 3273 #undef __FUNCT__ 3274 #define __FUNCT__ "TSSetPostEvaluate" 3275 /*@C 3276 TSSetPostEvaluate - Sets the general-purpose function 3277 called once at the end of each step evaluation. 3278 3279 Logically Collective on TS 3280 3281 Input Parameters: 3282 + ts - The TS context obtained from TSCreate() 3283 - func - The function 3284 3285 Calling sequence of func: 3286 . PetscErrorCode func(TS ts); 3287 3288 Level: intermediate 3289 3290 Note: 3291 Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling 3292 thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep() 3293 may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime() 3294 3295 .keywords: TS, timestep 3296 .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3297 @*/ 3298 PetscErrorCode TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS)) 3299 { 3300 PetscFunctionBegin; 3301 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3302 ts->postevaluate = func; 3303 PetscFunctionReturn(0); 3304 } 3305 3306 #undef __FUNCT__ 3307 #define __FUNCT__ "TSPreStage" 3308 /*@ 3309 TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage() 3310 3311 Collective on TS 3312 3313 Input Parameters: 3314 . ts - The TS context obtained from TSCreate() 3315 stagetime - The absolute time of the current stage 3316 3317 Notes: 3318 TSPreStage() is typically used within time stepping implementations, 3319 most users would not generally call this routine themselves. 3320 3321 Level: developer 3322 3323 .keywords: TS, timestep 3324 .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 3325 @*/ 3326 PetscErrorCode TSPreStage(TS ts, PetscReal stagetime) 3327 { 3328 PetscErrorCode ierr; 3329 3330 PetscFunctionBegin; 3331 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3332 if (ts->prestage) { 3333 PetscStackCallStandard((*ts->prestage),(ts,stagetime)); 3334 } 3335 PetscFunctionReturn(0); 3336 } 3337 3338 #undef __FUNCT__ 3339 #define __FUNCT__ "TSPostStage" 3340 /*@ 3341 TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage() 3342 3343 Collective on TS 3344 3345 Input Parameters: 3346 . ts - The TS context obtained from TSCreate() 3347 stagetime - The absolute time of the current stage 3348 stageindex - Stage number 3349 Y - Array of vectors (of size = total number 3350 of stages) with the stage solutions 3351 3352 Notes: 3353 TSPostStage() is typically used within time stepping implementations, 3354 most users would not generally call this routine themselves. 3355 3356 Level: developer 3357 3358 .keywords: TS, timestep 3359 .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 3360 @*/ 3361 PetscErrorCode TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y) 3362 { 3363 PetscErrorCode ierr; 3364 3365 PetscFunctionBegin; 3366 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3367 if (ts->poststage) { 3368 PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y)); 3369 } 3370 PetscFunctionReturn(0); 3371 } 3372 3373 #undef __FUNCT__ 3374 #define __FUNCT__ "TSPostEvaluate" 3375 /*@ 3376 TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate() 3377 3378 Collective on TS 3379 3380 Input Parameters: 3381 . ts - The TS context obtained from TSCreate() 3382 3383 Notes: 3384 TSPostEvaluate() is typically used within time stepping implementations, 3385 most users would not generally call this routine themselves. 3386 3387 Level: developer 3388 3389 .keywords: TS, timestep 3390 .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep() 3391 @*/ 3392 PetscErrorCode TSPostEvaluate(TS ts) 3393 { 3394 PetscErrorCode ierr; 3395 3396 PetscFunctionBegin; 3397 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3398 if (ts->postevaluate) { 3399 PetscStackCallStandard((*ts->postevaluate),(ts)); 3400 } 3401 PetscFunctionReturn(0); 3402 } 3403 3404 #undef __FUNCT__ 3405 #define __FUNCT__ "TSSetPostStep" 3406 /*@C 3407 TSSetPostStep - Sets the general-purpose function 3408 called once at the end of each time step. 3409 3410 Logically Collective on TS 3411 3412 Input Parameters: 3413 + ts - The TS context obtained from TSCreate() 3414 - func - The function 3415 3416 Calling sequence of func: 3417 $ func (TS ts); 3418 3419 Notes: 3420 The function set by TSSetPostStep() is called after each successful step. The solution vector X 3421 obtained by TSGetSolution() may be different than that computed at the step end if the event handler 3422 locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead. 3423 3424 Level: intermediate 3425 3426 .keywords: TS, timestep 3427 .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime() 3428 @*/ 3429 PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS)) 3430 { 3431 PetscFunctionBegin; 3432 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3433 ts->poststep = func; 3434 PetscFunctionReturn(0); 3435 } 3436 3437 #undef __FUNCT__ 3438 #define __FUNCT__ "TSPostStep" 3439 /*@ 3440 TSPostStep - Runs the user-defined post-step function. 3441 3442 Collective on TS 3443 3444 Input Parameters: 3445 . ts - The TS context obtained from TSCreate() 3446 3447 Notes: 3448 TSPostStep() is typically used within time stepping implementations, 3449 so most users would not generally call this routine themselves. 3450 3451 Level: developer 3452 3453 .keywords: TS, timestep 3454 @*/ 3455 PetscErrorCode TSPostStep(TS ts) 3456 { 3457 PetscErrorCode ierr; 3458 3459 PetscFunctionBegin; 3460 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3461 if (ts->poststep) { 3462 PetscStackCallStandard((*ts->poststep),(ts)); 3463 } 3464 PetscFunctionReturn(0); 3465 } 3466 3467 /* ------------ Routines to set performance monitoring options ----------- */ 3468 3469 #undef __FUNCT__ 3470 #define __FUNCT__ "TSMonitorSet" 3471 /*@C 3472 TSMonitorSet - Sets an ADDITIONAL function that is to be used at every 3473 timestep to display the iteration's progress. 3474 3475 Logically Collective on TS 3476 3477 Input Parameters: 3478 + ts - the TS context obtained from TSCreate() 3479 . monitor - monitoring routine 3480 . mctx - [optional] user-defined context for private data for the 3481 monitor routine (use NULL if no context is desired) 3482 - monitordestroy - [optional] routine that frees monitor context 3483 (may be NULL) 3484 3485 Calling sequence of monitor: 3486 $ int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx) 3487 3488 + ts - the TS context 3489 . steps - iteration number (after the final time step the monitor routine may be called with a step of -1, this indicates the solution has been interpolated to this time) 3490 . time - current time 3491 . u - current iterate 3492 - mctx - [optional] monitoring context 3493 3494 Notes: 3495 This routine adds an additional monitor to the list of monitors that 3496 already has been loaded. 3497 3498 Fortran notes: Only a single monitor function can be set for each TS object 3499 3500 Level: intermediate 3501 3502 .keywords: TS, timestep, set, monitor 3503 3504 .seealso: TSMonitorDefault(), TSMonitorCancel() 3505 @*/ 3506 PetscErrorCode TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**)) 3507 { 3508 PetscErrorCode ierr; 3509 PetscInt i; 3510 PetscBool identical; 3511 3512 PetscFunctionBegin; 3513 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3514 for (i=0; i<ts->numbermonitors;i++) { 3515 ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr); 3516 if (identical) PetscFunctionReturn(0); 3517 } 3518 if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 3519 ts->monitor[ts->numbermonitors] = monitor; 3520 ts->monitordestroy[ts->numbermonitors] = mdestroy; 3521 ts->monitorcontext[ts->numbermonitors++] = (void*)mctx; 3522 PetscFunctionReturn(0); 3523 } 3524 3525 #undef __FUNCT__ 3526 #define __FUNCT__ "TSMonitorCancel" 3527 /*@C 3528 TSMonitorCancel - Clears all the monitors that have been set on a time-step object. 3529 3530 Logically Collective on TS 3531 3532 Input Parameters: 3533 . ts - the TS context obtained from TSCreate() 3534 3535 Notes: 3536 There is no way to remove a single, specific monitor. 3537 3538 Level: intermediate 3539 3540 .keywords: TS, timestep, set, monitor 3541 3542 .seealso: TSMonitorDefault(), TSMonitorSet() 3543 @*/ 3544 PetscErrorCode TSMonitorCancel(TS ts) 3545 { 3546 PetscErrorCode ierr; 3547 PetscInt i; 3548 3549 PetscFunctionBegin; 3550 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3551 for (i=0; i<ts->numbermonitors; i++) { 3552 if (ts->monitordestroy[i]) { 3553 ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr); 3554 } 3555 } 3556 ts->numbermonitors = 0; 3557 PetscFunctionReturn(0); 3558 } 3559 3560 #undef __FUNCT__ 3561 #define __FUNCT__ "TSMonitorDefault" 3562 /*@C 3563 TSMonitorDefault - The Default monitor, prints the timestep and time for each step 3564 3565 Level: intermediate 3566 3567 .keywords: TS, set, monitor 3568 3569 .seealso: TSMonitorSet() 3570 @*/ 3571 PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf) 3572 { 3573 PetscErrorCode ierr; 3574 PetscViewer viewer = vf->viewer; 3575 PetscBool iascii,ibinary; 3576 3577 PetscFunctionBegin; 3578 PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4); 3579 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 3580 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr); 3581 ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr); 3582 if (iascii) { 3583 ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3584 if (step == -1){ /* this indicates it is an interpolated solution */ 3585 ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr); 3586 } else { 3587 ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)\n" : "\n");CHKERRQ(ierr); 3588 } 3589 ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3590 } else if (ibinary) { 3591 PetscMPIInt rank; 3592 ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr); 3593 if (!rank) { 3594 PetscBool skipHeader; 3595 PetscInt classid = REAL_FILE_CLASSID; 3596 3597 ierr = PetscViewerBinaryGetSkipHeader(viewer,&skipHeader);CHKERRQ(ierr); 3598 if (!skipHeader) { 3599 ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 3600 } 3601 ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr); 3602 } else { 3603 ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr); 3604 } 3605 } 3606 ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3607 PetscFunctionReturn(0); 3608 } 3609 3610 #undef __FUNCT__ 3611 #define __FUNCT__ "TSAdjointMonitorSet" 3612 /*@C 3613 TSAdjointMonitorSet - Sets an ADDITIONAL function that is to be used at every 3614 timestep to display the iteration's progress. 3615 3616 Logically Collective on TS 3617 3618 Input Parameters: 3619 + ts - the TS context obtained from TSCreate() 3620 . adjointmonitor - monitoring routine 3621 . adjointmctx - [optional] user-defined context for private data for the 3622 monitor routine (use NULL if no context is desired) 3623 - adjointmonitordestroy - [optional] routine that frees monitor context 3624 (may be NULL) 3625 3626 Calling sequence of monitor: 3627 $ int adjointmonitor(TS ts,PetscInt steps,PetscReal time,Vec u,PetscInt numcost,Vec *lambda, Vec *mu,void *adjointmctx) 3628 3629 + ts - the TS context 3630 . 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 3631 been interpolated to) 3632 . time - current time 3633 . u - current iterate 3634 . numcost - number of cost functionos 3635 . lambda - sensitivities to initial conditions 3636 . mu - sensitivities to parameters 3637 - adjointmctx - [optional] adjoint monitoring context 3638 3639 Notes: 3640 This routine adds an additional monitor to the list of monitors that 3641 already has been loaded. 3642 3643 Fortran notes: Only a single monitor function can be set for each TS object 3644 3645 Level: intermediate 3646 3647 .keywords: TS, timestep, set, adjoint, monitor 3648 3649 .seealso: TSAdjointMonitorCancel() 3650 @*/ 3651 PetscErrorCode TSAdjointMonitorSet(TS ts,PetscErrorCode (*adjointmonitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *adjointmctx,PetscErrorCode (*adjointmdestroy)(void**)) 3652 { 3653 PetscErrorCode ierr; 3654 PetscInt i; 3655 PetscBool identical; 3656 3657 PetscFunctionBegin; 3658 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3659 for (i=0; i<ts->numbermonitors;i++) { 3660 ierr = PetscMonitorCompare((PetscErrorCode (*)(void))adjointmonitor,adjointmctx,adjointmdestroy,(PetscErrorCode (*)(void))ts->adjointmonitor[i],ts->adjointmonitorcontext[i],ts->adjointmonitordestroy[i],&identical);CHKERRQ(ierr); 3661 if (identical) PetscFunctionReturn(0); 3662 } 3663 if (ts->numberadjointmonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many adjoint monitors set"); 3664 ts->adjointmonitor[ts->numberadjointmonitors] = adjointmonitor; 3665 ts->adjointmonitordestroy[ts->numberadjointmonitors] = adjointmdestroy; 3666 ts->adjointmonitorcontext[ts->numberadjointmonitors++] = (void*)adjointmctx; 3667 PetscFunctionReturn(0); 3668 } 3669 3670 #undef __FUNCT__ 3671 #define __FUNCT__ "TSAdjointMonitorCancel" 3672 /*@C 3673 TSAdjointMonitorCancel - Clears all the adjoint monitors that have been set on a time-step object. 3674 3675 Logically Collective on TS 3676 3677 Input Parameters: 3678 . ts - the TS context obtained from TSCreate() 3679 3680 Notes: 3681 There is no way to remove a single, specific monitor. 3682 3683 Level: intermediate 3684 3685 .keywords: TS, timestep, set, adjoint, monitor 3686 3687 .seealso: TSAdjointMonitorSet() 3688 @*/ 3689 PetscErrorCode TSAdjointMonitorCancel(TS ts) 3690 { 3691 PetscErrorCode ierr; 3692 PetscInt i; 3693 3694 PetscFunctionBegin; 3695 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3696 for (i=0; i<ts->numberadjointmonitors; i++) { 3697 if (ts->adjointmonitordestroy[i]) { 3698 ierr = (*ts->adjointmonitordestroy[i])(&ts->adjointmonitorcontext[i]);CHKERRQ(ierr); 3699 } 3700 } 3701 ts->numberadjointmonitors = 0; 3702 PetscFunctionReturn(0); 3703 } 3704 3705 #undef __FUNCT__ 3706 #define __FUNCT__ "TSAdjointMonitorDefault" 3707 /*@C 3708 TSAdjointMonitorDefault - the default monitor of adjoint computations 3709 3710 Level: intermediate 3711 3712 .keywords: TS, set, monitor 3713 3714 .seealso: TSAdjointMonitorSet() 3715 @*/ 3716 PetscErrorCode TSAdjointMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,PetscViewerAndFormat *vf) 3717 { 3718 PetscErrorCode ierr; 3719 PetscViewer viewer = vf->viewer; 3720 3721 PetscFunctionBegin; 3722 PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4); 3723 ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr); 3724 ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3725 ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)\n" : "\n");CHKERRQ(ierr); 3726 ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3727 ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3728 PetscFunctionReturn(0); 3729 } 3730 3731 #undef __FUNCT__ 3732 #define __FUNCT__ "TSInterpolate" 3733 /*@ 3734 TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval 3735 3736 Collective on TS 3737 3738 Input Argument: 3739 + ts - time stepping context 3740 - t - time to interpolate to 3741 3742 Output Argument: 3743 . U - state at given time 3744 3745 Level: intermediate 3746 3747 Developer Notes: 3748 TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints. 3749 3750 .keywords: TS, set 3751 3752 .seealso: TSSetExactFinalTime(), TSSolve() 3753 @*/ 3754 PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U) 3755 { 3756 PetscErrorCode ierr; 3757 3758 PetscFunctionBegin; 3759 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3760 PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3761 if (t < ts->ptime_prev || t > ts->ptime) SETERRQ3(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Requested time %g not in last time steps [%g,%g]",t,(double)ts->ptime_prev,(double)ts->ptime); 3762 if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name); 3763 ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr); 3764 PetscFunctionReturn(0); 3765 } 3766 3767 #undef __FUNCT__ 3768 #define __FUNCT__ "TSStep" 3769 /*@ 3770 TSStep - Steps one time step 3771 3772 Collective on TS 3773 3774 Input Parameter: 3775 . ts - the TS context obtained from TSCreate() 3776 3777 Level: developer 3778 3779 Notes: 3780 The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine. 3781 3782 The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may 3783 be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages. 3784 3785 This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the 3786 time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep. 3787 3788 .keywords: TS, timestep, solve 3789 3790 .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate() 3791 @*/ 3792 PetscErrorCode TSStep(TS ts) 3793 { 3794 PetscErrorCode ierr; 3795 static PetscBool cite = PETSC_FALSE; 3796 PetscReal ptime; 3797 3798 PetscFunctionBegin; 3799 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3800 ierr = PetscCitationsRegister("@techreport{tspaper,\n" 3801 " title = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n" 3802 " author = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n" 3803 " type = {Preprint},\n" 3804 " number = {ANL/MCS-P5061-0114},\n" 3805 " institution = {Argonne National Laboratory},\n" 3806 " year = {2014}\n}\n",&cite);CHKERRQ(ierr); 3807 3808 ierr = TSSetUp(ts);CHKERRQ(ierr); 3809 ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr); 3810 3811 if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSStep()"); 3812 if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP && !ts->adapt) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE"); 3813 3814 if (!ts->steps) ts->ptime_prev = ts->ptime; 3815 ts->reason = TS_CONVERGED_ITERATING; 3816 ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev; 3817 if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name); 3818 ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3819 ierr = (*ts->ops->step)(ts);CHKERRQ(ierr); 3820 ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3821 ts->ptime_prev = ptime; 3822 ts->steps++; ts->total_steps++; 3823 ts->steprollback = PETSC_FALSE; 3824 ts->steprestart = PETSC_FALSE; 3825 3826 if (ts->reason < 0) { 3827 if (ts->errorifstepfailed) { 3828 if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_snes_failures or make negative to attempt recovery",TSConvergedReasons[ts->reason]); 3829 else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 3830 } 3831 } else if (!ts->reason) { 3832 if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 3833 else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 3834 } 3835 PetscFunctionReturn(0); 3836 } 3837 3838 #undef __FUNCT__ 3839 #define __FUNCT__ "TSAdjointStep" 3840 /*@ 3841 TSAdjointStep - Steps one time step backward in the adjoint run 3842 3843 Collective on TS 3844 3845 Input Parameter: 3846 . ts - the TS context obtained from TSCreate() 3847 3848 Level: intermediate 3849 3850 .keywords: TS, adjoint, step 3851 3852 .seealso: TSAdjointSetUp(), TSAdjointSolve() 3853 @*/ 3854 PetscErrorCode TSAdjointStep(TS ts) 3855 { 3856 DM dm; 3857 PetscErrorCode ierr; 3858 3859 PetscFunctionBegin; 3860 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3861 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 3862 ierr = TSAdjointSetUp(ts);CHKERRQ(ierr); 3863 3864 ierr = VecViewFromOptions(ts->vec_sol,(PetscObject)ts,"-ts_view_solution");CHKERRQ(ierr); 3865 3866 ts->reason = TS_CONVERGED_ITERATING; 3867 ts->ptime_prev = ts->ptime; 3868 if (!ts->ops->adjointstep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed because the adjoint of %s has not been implemented, try other time stepping methods for adjoint sensitivity analysis",((PetscObject)ts)->type_name); 3869 ierr = PetscLogEventBegin(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr); 3870 ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr); 3871 ierr = PetscLogEventEnd(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr); 3872 ts->steps++; ts->total_steps--; 3873 3874 if (ts->reason < 0) { 3875 if (ts->errorifstepfailed) { 3876 if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_snes_failures or make negative to attempt recovery",TSConvergedReasons[ts->reason]); 3877 else if (ts->reason == TS_DIVERGED_STEP_REJECTED) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_reject or make negative to attempt recovery",TSConvergedReasons[ts->reason]); 3878 else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 3879 } 3880 } else if (!ts->reason) { 3881 if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS; 3882 } 3883 PetscFunctionReturn(0); 3884 } 3885 3886 #undef __FUNCT__ 3887 #define __FUNCT__ "TSEvaluateWLTE" 3888 /*@ 3889 TSEvaluateWLTE - Evaluate the weighted local truncation error norm 3890 at the end of a time step with a given order of accuracy. 3891 3892 Collective on TS 3893 3894 Input Arguments: 3895 + ts - time stepping context 3896 . wnormtype - norm type, either NORM_2 or NORM_INFINITY 3897 - order - optional, desired order for the error evaluation or PETSC_DECIDE 3898 3899 Output Arguments: 3900 + order - optional, the actual order of the error evaluation 3901 - wlte - the weighted local truncation error norm 3902 3903 Level: advanced 3904 3905 Notes: 3906 If the timestepper cannot evaluate the error in a particular step 3907 (eg. in the first step or restart steps after event handling), 3908 this routine returns wlte=-1.0 . 3909 3910 .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm() 3911 @*/ 3912 PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte) 3913 { 3914 PetscErrorCode ierr; 3915 3916 PetscFunctionBegin; 3917 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3918 PetscValidType(ts,1); 3919 PetscValidLogicalCollectiveEnum(ts,wnormtype,4); 3920 if (order) PetscValidIntPointer(order,3); 3921 if (order) PetscValidLogicalCollectiveInt(ts,*order,3); 3922 PetscValidRealPointer(wlte,4); 3923 if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 3924 if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name); 3925 ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr); 3926 PetscFunctionReturn(0); 3927 } 3928 3929 #undef __FUNCT__ 3930 #define __FUNCT__ "TSEvaluateStep" 3931 /*@ 3932 TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy. 3933 3934 Collective on TS 3935 3936 Input Arguments: 3937 + ts - time stepping context 3938 . order - desired order of accuracy 3939 - done - whether the step was evaluated at this order (pass NULL to generate an error if not available) 3940 3941 Output Arguments: 3942 . U - state at the end of the current step 3943 3944 Level: advanced 3945 3946 Notes: 3947 This function cannot be called until all stages have been evaluated. 3948 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. 3949 3950 .seealso: TSStep(), TSAdapt 3951 @*/ 3952 PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done) 3953 { 3954 PetscErrorCode ierr; 3955 3956 PetscFunctionBegin; 3957 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3958 PetscValidType(ts,1); 3959 PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3960 if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name); 3961 ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr); 3962 PetscFunctionReturn(0); 3963 } 3964 3965 #undef __FUNCT__ 3966 #define __FUNCT__ "TSForwardCostIntegral" 3967 /*@ 3968 TSForwardCostIntegral - Evaluate the cost integral in the forward run. 3969 3970 Collective on TS 3971 3972 Input Arguments: 3973 . ts - time stepping context 3974 3975 Level: advanced 3976 3977 Notes: 3978 This function cannot be called until TSStep() has been completed. 3979 3980 .seealso: TSSolve(), TSAdjointCostIntegral() 3981 @*/ 3982 PetscErrorCode TSForwardCostIntegral(TS ts) 3983 { 3984 PetscErrorCode ierr; 3985 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3986 if (!ts->ops->forwardintegral) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide integral evaluation in the forward run",((PetscObject)ts)->type_name); 3987 ierr = (*ts->ops->forwardintegral)(ts);CHKERRQ(ierr); 3988 PetscFunctionReturn(0); 3989 } 3990 3991 #undef __FUNCT__ 3992 #define __FUNCT__ "TSSolve" 3993 /*@ 3994 TSSolve - Steps the requested number of timesteps. 3995 3996 Collective on TS 3997 3998 Input Parameter: 3999 + ts - the TS context obtained from TSCreate() 4000 - u - the solution vector (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used, 4001 otherwise must contain the initial conditions and will contain the solution at the final requested time 4002 4003 Level: beginner 4004 4005 Notes: 4006 The final time returned by this function may be different from the time of the internally 4007 held state accessible by TSGetSolution() and TSGetTime() because the method may have 4008 stepped over the final time. 4009 4010 .keywords: TS, timestep, solve 4011 4012 .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime() 4013 @*/ 4014 PetscErrorCode TSSolve(TS ts,Vec u) 4015 { 4016 Vec solution; 4017 PetscErrorCode ierr; 4018 4019 PetscFunctionBegin; 4020 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4021 if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2); 4022 4023 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 */ 4024 PetscValidHeaderSpecific(u,VEC_CLASSID,2); 4025 if (!ts->vec_sol || u == ts->vec_sol) { 4026 ierr = VecDuplicate(u,&solution);CHKERRQ(ierr); 4027 ierr = TSSetSolution(ts,solution);CHKERRQ(ierr); 4028 ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */ 4029 } 4030 ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr); 4031 } else if (u) { 4032 ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 4033 } 4034 ierr = TSSetUp(ts);CHKERRQ(ierr); 4035 ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr); 4036 4037 if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSSolve()"); 4038 if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP && !ts->adapt) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE"); 4039 4040 /* reset time step and iteration counters */ 4041 ts->steps = 0; 4042 ts->ksp_its = 0; 4043 ts->snes_its = 0; 4044 ts->num_snes_failures = 0; 4045 ts->reject = 0; 4046 ts->reason = TS_CONVERGED_ITERATING; 4047 4048 ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr); 4049 4050 if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 4051 ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr); 4052 if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 4053 ts->solvetime = ts->ptime; 4054 solution = ts->vec_sol; 4055 } else { /* Step the requested number of timesteps. */ 4056 if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 4057 else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 4058 ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 4059 ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 4060 ts->steprollback = PETSC_FALSE; 4061 ts->steprestart = PETSC_TRUE; 4062 4063 while (!ts->reason) { 4064 ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 4065 if (!ts->steprollback) { 4066 ierr = TSPreStep(ts);CHKERRQ(ierr); 4067 } 4068 ierr = TSStep(ts);CHKERRQ(ierr); 4069 if (ts->vec_costintegral && ts->costintegralfwd) { /* Must evaluate the cost integral before event is handled. The cost integral value can also be rolled back. */ 4070 ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr); 4071 } 4072 ierr = TSEventHandler(ts);CHKERRQ(ierr); /* The right-hand side may be changed due to event. Be careful with Any computation using the RHS information after this point. */ 4073 if (!ts->steprollback) { 4074 ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 4075 ierr = TSPostStep(ts);CHKERRQ(ierr); 4076 } 4077 } 4078 ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 4079 4080 if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) { 4081 ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr); 4082 ts->solvetime = ts->max_time; 4083 solution = u; 4084 ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr); 4085 } else { 4086 if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 4087 ts->solvetime = ts->ptime; 4088 solution = ts->vec_sol; 4089 } 4090 } 4091 4092 ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr); 4093 ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr); 4094 ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr); 4095 if (ts->adjoint_solve) { 4096 ierr = TSAdjointSolve(ts);CHKERRQ(ierr); 4097 } 4098 PetscFunctionReturn(0); 4099 } 4100 4101 #undef __FUNCT__ 4102 #define __FUNCT__ "TSAdjointCostIntegral" 4103 /*@ 4104 TSAdjointCostIntegral - Evaluate the cost integral in the adjoint run. 4105 4106 Collective on TS 4107 4108 Input Arguments: 4109 . ts - time stepping context 4110 4111 Level: advanced 4112 4113 Notes: 4114 This function cannot be called until TSAdjointStep() has been completed. 4115 4116 .seealso: TSAdjointSolve(), TSAdjointStep 4117 @*/ 4118 PetscErrorCode TSAdjointCostIntegral(TS ts) 4119 { 4120 PetscErrorCode ierr; 4121 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4122 if (!ts->ops->adjointintegral) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide integral evaluation in the adjoint run",((PetscObject)ts)->type_name); 4123 ierr = (*ts->ops->adjointintegral)(ts);CHKERRQ(ierr); 4124 PetscFunctionReturn(0); 4125 } 4126 4127 #undef __FUNCT__ 4128 #define __FUNCT__ "TSAdjointSolve" 4129 /*@ 4130 TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE 4131 4132 Collective on TS 4133 4134 Input Parameter: 4135 . ts - the TS context obtained from TSCreate() 4136 4137 Options Database: 4138 . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial conditions 4139 4140 Level: intermediate 4141 4142 Notes: 4143 This must be called after a call to TSSolve() that solves the forward problem 4144 4145 By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time 4146 4147 .keywords: TS, timestep, solve 4148 4149 .seealso: TSCreate(), TSSetCostGradients(), TSSetSolution(), TSAdjointStep() 4150 @*/ 4151 PetscErrorCode TSAdjointSolve(TS ts) 4152 { 4153 PetscErrorCode ierr; 4154 4155 PetscFunctionBegin; 4156 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4157 ierr = TSAdjointSetUp(ts);CHKERRQ(ierr); 4158 4159 /* reset time step and iteration counters */ 4160 ts->steps = 0; 4161 ts->ksp_its = 0; 4162 ts->snes_its = 0; 4163 ts->num_snes_failures = 0; 4164 ts->reject = 0; 4165 ts->reason = TS_CONVERGED_ITERATING; 4166 4167 if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps; 4168 4169 if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS; 4170 while (!ts->reason) { 4171 ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr); 4172 ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr); 4173 ierr = TSAdjointEventHandler(ts);CHKERRQ(ierr); 4174 ierr = TSAdjointStep(ts);CHKERRQ(ierr); 4175 if (ts->vec_costintegral && !ts->costintegralfwd) { 4176 ierr = TSAdjointCostIntegral(ts);CHKERRQ(ierr); 4177 } 4178 } 4179 ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr); 4180 ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr); 4181 ts->solvetime = ts->ptime; 4182 ierr = TSTrajectoryViewFromOptions(ts->trajectory,NULL,"-ts_trajectory_view");CHKERRQ(ierr); 4183 ierr = VecViewFromOptions(ts->vecs_sensi[0],(PetscObject) ts, "-ts_adjoint_view_solution");CHKERRQ(ierr); 4184 PetscFunctionReturn(0); 4185 } 4186 4187 #undef __FUNCT__ 4188 #define __FUNCT__ "TSMonitor" 4189 /*@C 4190 TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet() 4191 4192 Collective on TS 4193 4194 Input Parameters: 4195 + ts - time stepping context obtained from TSCreate() 4196 . step - step number that has just completed 4197 . ptime - model time of the state 4198 - u - state at the current model time 4199 4200 Notes: 4201 TSMonitor() is typically used automatically within the time stepping implementations. 4202 Users would almost never call this routine directly. 4203 4204 A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions 4205 4206 Level: developer 4207 4208 .keywords: TS, timestep 4209 @*/ 4210 PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u) 4211 { 4212 DM dm; 4213 PetscInt i,n = ts->numbermonitors; 4214 PetscErrorCode ierr; 4215 4216 PetscFunctionBegin; 4217 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4218 PetscValidHeaderSpecific(u,VEC_CLASSID,4); 4219 4220 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 4221 ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr); 4222 4223 ierr = VecLockPush(u);CHKERRQ(ierr); 4224 for (i=0; i<n; i++) { 4225 ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr); 4226 } 4227 ierr = VecLockPop(u);CHKERRQ(ierr); 4228 PetscFunctionReturn(0); 4229 } 4230 4231 #undef __FUNCT__ 4232 #define __FUNCT__ "TSAdjointMonitor" 4233 /*@C 4234 TSAdjointMonitor - Runs all user-provided adjoint monitor routines set using TSAdjointMonitorSet() 4235 4236 Collective on TS 4237 4238 Input Parameters: 4239 + ts - time stepping context obtained from TSCreate() 4240 . step - step number that has just completed 4241 . ptime - model time of the state 4242 . u - state at the current model time 4243 . numcost - number of cost functions (dimension of lambda or mu) 4244 . lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables 4245 - mu - vectors containing the gradients of the cost functions with respect to the problem parameters 4246 4247 Notes: 4248 TSAdjointMonitor() is typically used automatically within the time stepping implementations. 4249 Users would almost never call this routine directly. 4250 4251 Level: developer 4252 4253 .keywords: TS, timestep 4254 @*/ 4255 PetscErrorCode TSAdjointMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda, Vec *mu) 4256 { 4257 PetscErrorCode ierr; 4258 PetscInt i,n = ts->numberadjointmonitors; 4259 4260 PetscFunctionBegin; 4261 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4262 PetscValidHeaderSpecific(u,VEC_CLASSID,4); 4263 ierr = VecLockPush(u);CHKERRQ(ierr); 4264 for (i=0; i<n; i++) { 4265 ierr = (*ts->adjointmonitor[i])(ts,step,ptime,u,numcost,lambda,mu,ts->adjointmonitorcontext[i]);CHKERRQ(ierr); 4266 } 4267 ierr = VecLockPop(u);CHKERRQ(ierr); 4268 PetscFunctionReturn(0); 4269 } 4270 4271 /* ------------------------------------------------------------------------*/ 4272 #undef __FUNCT__ 4273 #define __FUNCT__ "TSMonitorLGCtxCreate" 4274 /*@C 4275 TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with 4276 TS to monitor the solution process graphically in various ways 4277 4278 Collective on TS 4279 4280 Input Parameters: 4281 + host - the X display to open, or null for the local machine 4282 . label - the title to put in the title bar 4283 . x, y - the screen coordinates of the upper left coordinate of the window 4284 . m, n - the screen width and height in pixels 4285 - howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time 4286 4287 Output Parameter: 4288 . ctx - the context 4289 4290 Options Database Key: 4291 + -ts_monitor_lg_timestep - automatically sets line graph monitor 4292 . -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables()) 4293 . -ts_monitor_lg_error - monitor the error 4294 . -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep 4295 . -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep 4296 - -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true 4297 4298 Notes: 4299 Use TSMonitorLGCtxDestroy() to destroy. 4300 4301 One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform() 4302 4303 Many of the functions that control the monitoring have two forms: TSMonitorLGSet/GetXXXX() and TSMonitorLGCtxSet/GetXXXX() the first take a TS object as the 4304 first argument (if that TS object does not have a TSMonitorLGCtx associated with it the function call is ignored) and the second takes a TSMonitorLGCtx object 4305 as the first argument. 4306 4307 One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames() 4308 4309 4310 Level: intermediate 4311 4312 .keywords: TS, monitor, line graph, residual 4313 4314 .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(), 4315 TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(), 4316 TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(), 4317 TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(), 4318 TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop() 4319 4320 @*/ 4321 PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx) 4322 { 4323 PetscDraw draw; 4324 PetscErrorCode ierr; 4325 4326 PetscFunctionBegin; 4327 ierr = PetscNew(ctx);CHKERRQ(ierr); 4328 ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr); 4329 ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr); 4330 ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr); 4331 ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr); 4332 ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 4333 (*ctx)->howoften = howoften; 4334 PetscFunctionReturn(0); 4335 } 4336 4337 #undef __FUNCT__ 4338 #define __FUNCT__ "TSMonitorLGTimeStep" 4339 PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx) 4340 { 4341 TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 4342 PetscReal x = ptime,y; 4343 PetscErrorCode ierr; 4344 4345 PetscFunctionBegin; 4346 if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */ 4347 if (!step) { 4348 PetscDrawAxis axis; 4349 ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 4350 ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time Step");CHKERRQ(ierr); 4351 ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4352 } 4353 ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr); 4354 ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 4355 if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 4356 ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 4357 ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 4358 } 4359 PetscFunctionReturn(0); 4360 } 4361 4362 #undef __FUNCT__ 4363 #define __FUNCT__ "TSMonitorLGCtxDestroy" 4364 /*@C 4365 TSMonitorLGCtxDestroy - Destroys a line graph context that was created 4366 with TSMonitorLGCtxCreate(). 4367 4368 Collective on TSMonitorLGCtx 4369 4370 Input Parameter: 4371 . ctx - the monitor context 4372 4373 Level: intermediate 4374 4375 .keywords: TS, monitor, line graph, destroy 4376 4377 .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep(); 4378 @*/ 4379 PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx) 4380 { 4381 PetscErrorCode ierr; 4382 4383 PetscFunctionBegin; 4384 if ((*ctx)->transformdestroy) { 4385 ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr); 4386 } 4387 ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr); 4388 ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr); 4389 ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr); 4390 ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr); 4391 ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr); 4392 ierr = PetscFree(*ctx);CHKERRQ(ierr); 4393 PetscFunctionReturn(0); 4394 } 4395 4396 #undef __FUNCT__ 4397 #define __FUNCT__ "TSGetTime" 4398 /*@ 4399 TSGetTime - Gets the time of the most recently completed step. 4400 4401 Not Collective 4402 4403 Input Parameter: 4404 . ts - the TS context obtained from TSCreate() 4405 4406 Output Parameter: 4407 . t - the current time. This time may not corresponds to the final time set with TSSetDuration(), use TSGetSolveTime(). 4408 4409 Level: beginner 4410 4411 Note: 4412 When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(), 4413 TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated. 4414 4415 .seealso: TSSetInitialTimeStep(), TSGetTimeStep(), TSGetSolveTime() 4416 4417 .keywords: TS, get, time 4418 @*/ 4419 PetscErrorCode TSGetTime(TS ts,PetscReal *t) 4420 { 4421 PetscFunctionBegin; 4422 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4423 PetscValidRealPointer(t,2); 4424 *t = ts->ptime; 4425 PetscFunctionReturn(0); 4426 } 4427 4428 #undef __FUNCT__ 4429 #define __FUNCT__ "TSGetPrevTime" 4430 /*@ 4431 TSGetPrevTime - Gets the starting time of the previously completed step. 4432 4433 Not Collective 4434 4435 Input Parameter: 4436 . ts - the TS context obtained from TSCreate() 4437 4438 Output Parameter: 4439 . t - the previous time 4440 4441 Level: beginner 4442 4443 .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 4444 4445 .keywords: TS, get, time 4446 @*/ 4447 PetscErrorCode TSGetPrevTime(TS ts,PetscReal *t) 4448 { 4449 PetscFunctionBegin; 4450 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4451 PetscValidRealPointer(t,2); 4452 *t = ts->ptime_prev; 4453 PetscFunctionReturn(0); 4454 } 4455 4456 #undef __FUNCT__ 4457 #define __FUNCT__ "TSSetTime" 4458 /*@ 4459 TSSetTime - Allows one to reset the time. 4460 4461 Logically Collective on TS 4462 4463 Input Parameters: 4464 + ts - the TS context obtained from TSCreate() 4465 - time - the time 4466 4467 Level: intermediate 4468 4469 .seealso: TSGetTime(), TSSetDuration() 4470 4471 .keywords: TS, set, time 4472 @*/ 4473 PetscErrorCode TSSetTime(TS ts, PetscReal t) 4474 { 4475 PetscFunctionBegin; 4476 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4477 PetscValidLogicalCollectiveReal(ts,t,2); 4478 ts->ptime = t; 4479 PetscFunctionReturn(0); 4480 } 4481 4482 #undef __FUNCT__ 4483 #define __FUNCT__ "TSSetOptionsPrefix" 4484 /*@C 4485 TSSetOptionsPrefix - Sets the prefix used for searching for all 4486 TS options in the database. 4487 4488 Logically Collective on TS 4489 4490 Input Parameter: 4491 + ts - The TS context 4492 - prefix - The prefix to prepend to all option names 4493 4494 Notes: 4495 A hyphen (-) must NOT be given at the beginning of the prefix name. 4496 The first character of all runtime options is AUTOMATICALLY the 4497 hyphen. 4498 4499 Level: advanced 4500 4501 .keywords: TS, set, options, prefix, database 4502 4503 .seealso: TSSetFromOptions() 4504 4505 @*/ 4506 PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[]) 4507 { 4508 PetscErrorCode ierr; 4509 SNES snes; 4510 4511 PetscFunctionBegin; 4512 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4513 ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4514 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4515 ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr); 4516 PetscFunctionReturn(0); 4517 } 4518 4519 4520 #undef __FUNCT__ 4521 #define __FUNCT__ "TSAppendOptionsPrefix" 4522 /*@C 4523 TSAppendOptionsPrefix - Appends to the prefix used for searching for all 4524 TS options in the database. 4525 4526 Logically Collective on TS 4527 4528 Input Parameter: 4529 + ts - The TS context 4530 - prefix - The prefix to prepend to all option names 4531 4532 Notes: 4533 A hyphen (-) must NOT be given at the beginning of the prefix name. 4534 The first character of all runtime options is AUTOMATICALLY the 4535 hyphen. 4536 4537 Level: advanced 4538 4539 .keywords: TS, append, options, prefix, database 4540 4541 .seealso: TSGetOptionsPrefix() 4542 4543 @*/ 4544 PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[]) 4545 { 4546 PetscErrorCode ierr; 4547 SNES snes; 4548 4549 PetscFunctionBegin; 4550 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4551 ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4552 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4553 ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr); 4554 PetscFunctionReturn(0); 4555 } 4556 4557 #undef __FUNCT__ 4558 #define __FUNCT__ "TSGetOptionsPrefix" 4559 /*@C 4560 TSGetOptionsPrefix - Sets the prefix used for searching for all 4561 TS options in the database. 4562 4563 Not Collective 4564 4565 Input Parameter: 4566 . ts - The TS context 4567 4568 Output Parameter: 4569 . prefix - A pointer to the prefix string used 4570 4571 Notes: On the fortran side, the user should pass in a string 'prifix' of 4572 sufficient length to hold the prefix. 4573 4574 Level: intermediate 4575 4576 .keywords: TS, get, options, prefix, database 4577 4578 .seealso: TSAppendOptionsPrefix() 4579 @*/ 4580 PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[]) 4581 { 4582 PetscErrorCode ierr; 4583 4584 PetscFunctionBegin; 4585 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4586 PetscValidPointer(prefix,2); 4587 ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4588 PetscFunctionReturn(0); 4589 } 4590 4591 #undef __FUNCT__ 4592 #define __FUNCT__ "TSGetRHSJacobian" 4593 /*@C 4594 TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 4595 4596 Not Collective, but parallel objects are returned if TS is parallel 4597 4598 Input Parameter: 4599 . ts - The TS context obtained from TSCreate() 4600 4601 Output Parameters: 4602 + Amat - The (approximate) Jacobian J of G, where U_t = G(U,t) (or NULL) 4603 . Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat (or NULL) 4604 . func - Function to compute the Jacobian of the RHS (or NULL) 4605 - ctx - User-defined context for Jacobian evaluation routine (or NULL) 4606 4607 Notes: You can pass in NULL for any return argument you do not need. 4608 4609 Level: intermediate 4610 4611 .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 4612 4613 .keywords: TS, timestep, get, matrix, Jacobian 4614 @*/ 4615 PetscErrorCode TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx) 4616 { 4617 PetscErrorCode ierr; 4618 SNES snes; 4619 DM dm; 4620 4621 PetscFunctionBegin; 4622 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4623 ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 4624 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 4625 ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr); 4626 PetscFunctionReturn(0); 4627 } 4628 4629 #undef __FUNCT__ 4630 #define __FUNCT__ "TSGetIJacobian" 4631 /*@C 4632 TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 4633 4634 Not Collective, but parallel objects are returned if TS is parallel 4635 4636 Input Parameter: 4637 . ts - The TS context obtained from TSCreate() 4638 4639 Output Parameters: 4640 + Amat - The (approximate) Jacobian of F(t,U,U_t) 4641 . Pmat - The matrix from which the preconditioner is constructed, often the same as Amat 4642 . f - The function to compute the matrices 4643 - ctx - User-defined context for Jacobian evaluation routine 4644 4645 Notes: You can pass in NULL for any return argument you do not need. 4646 4647 Level: advanced 4648 4649 .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 4650 4651 .keywords: TS, timestep, get, matrix, Jacobian 4652 @*/ 4653 PetscErrorCode TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx) 4654 { 4655 PetscErrorCode ierr; 4656 SNES snes; 4657 DM dm; 4658 4659 PetscFunctionBegin; 4660 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4661 ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 4662 ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 4663 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 4664 ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr); 4665 PetscFunctionReturn(0); 4666 } 4667 4668 4669 #undef __FUNCT__ 4670 #define __FUNCT__ "TSMonitorDrawSolution" 4671 /*@C 4672 TSMonitorDrawSolution - Monitors progress of the TS solvers by calling 4673 VecView() for the solution at each timestep 4674 4675 Collective on TS 4676 4677 Input Parameters: 4678 + ts - the TS context 4679 . step - current time-step 4680 . ptime - current time 4681 - dummy - either a viewer or NULL 4682 4683 Options Database: 4684 . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 4685 4686 Notes: the initial solution and current solution are not display with a common axis scaling so generally the option -ts_monitor_draw_solution_initial 4687 will look bad 4688 4689 Level: intermediate 4690 4691 .keywords: TS, vector, monitor, view 4692 4693 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 4694 @*/ 4695 PetscErrorCode TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 4696 { 4697 PetscErrorCode ierr; 4698 TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 4699 PetscDraw draw; 4700 4701 PetscFunctionBegin; 4702 if (!step && ictx->showinitial) { 4703 if (!ictx->initialsolution) { 4704 ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr); 4705 } 4706 ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr); 4707 } 4708 if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 4709 4710 if (ictx->showinitial) { 4711 PetscReal pause; 4712 ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr); 4713 ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr); 4714 ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr); 4715 ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr); 4716 ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr); 4717 } 4718 ierr = VecView(u,ictx->viewer);CHKERRQ(ierr); 4719 if (ictx->showtimestepandtime) { 4720 PetscReal xl,yl,xr,yr,h; 4721 char time[32]; 4722 4723 ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 4724 ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 4725 ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 4726 h = yl + .95*(yr - yl); 4727 ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 4728 ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 4729 } 4730 4731 if (ictx->showinitial) { 4732 ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr); 4733 } 4734 PetscFunctionReturn(0); 4735 } 4736 4737 #undef __FUNCT__ 4738 #define __FUNCT__ "TSAdjointMonitorDrawSensi" 4739 /*@C 4740 TSAdjointMonitorDrawSensi - Monitors progress of the adjoint TS solvers by calling 4741 VecView() for the sensitivities to initial states at each timestep 4742 4743 Collective on TS 4744 4745 Input Parameters: 4746 + ts - the TS context 4747 . step - current time-step 4748 . ptime - current time 4749 . u - current state 4750 . numcost - number of cost functions 4751 . lambda - sensitivities to initial conditions 4752 . mu - sensitivities to parameters 4753 - dummy - either a viewer or NULL 4754 4755 Level: intermediate 4756 4757 .keywords: TS, vector, adjoint, monitor, view 4758 4759 .seealso: TSAdjointMonitorSet(), TSAdjointMonitorDefault(), VecView() 4760 @*/ 4761 PetscErrorCode TSAdjointMonitorDrawSensi(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy) 4762 { 4763 PetscErrorCode ierr; 4764 TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 4765 PetscDraw draw; 4766 PetscReal xl,yl,xr,yr,h; 4767 char time[32]; 4768 4769 PetscFunctionBegin; 4770 if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 4771 4772 ierr = VecView(lambda[0],ictx->viewer);CHKERRQ(ierr); 4773 ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 4774 ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 4775 ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 4776 h = yl + .95*(yr - yl); 4777 ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 4778 ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 4779 PetscFunctionReturn(0); 4780 } 4781 4782 #undef __FUNCT__ 4783 #define __FUNCT__ "TSMonitorDrawSolutionPhase" 4784 /*@C 4785 TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram 4786 4787 Collective on TS 4788 4789 Input Parameters: 4790 + ts - the TS context 4791 . step - current time-step 4792 . ptime - current time 4793 - dummy - either a viewer or NULL 4794 4795 Level: intermediate 4796 4797 .keywords: TS, vector, monitor, view 4798 4799 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 4800 @*/ 4801 PetscErrorCode TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 4802 { 4803 PetscErrorCode ierr; 4804 TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 4805 PetscDraw draw; 4806 PetscDrawAxis axis; 4807 PetscInt n; 4808 PetscMPIInt size; 4809 PetscReal U0,U1,xl,yl,xr,yr,h; 4810 char time[32]; 4811 const PetscScalar *U; 4812 4813 PetscFunctionBegin; 4814 ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr); 4815 if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs"); 4816 ierr = VecGetSize(u,&n);CHKERRQ(ierr); 4817 if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns"); 4818 4819 ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 4820 ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr); 4821 ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr); 4822 if (!step) { 4823 ierr = PetscDrawClear(draw);CHKERRQ(ierr); 4824 ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr); 4825 } 4826 4827 ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr); 4828 U0 = PetscRealPart(U[0]); 4829 U1 = PetscRealPart(U[1]); 4830 ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 4831 if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0); 4832 4833 ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr); 4834 ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr); 4835 if (ictx->showtimestepandtime) { 4836 ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 4837 ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 4838 h = yl + .95*(yr - yl); 4839 ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 4840 } 4841 ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr); 4842 ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 4843 ierr = PetscDrawSave(draw);CHKERRQ(ierr); 4844 PetscFunctionReturn(0); 4845 } 4846 4847 4848 #undef __FUNCT__ 4849 #define __FUNCT__ "TSMonitorDrawCtxDestroy" 4850 /*@C 4851 TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution() 4852 4853 Collective on TS 4854 4855 Input Parameters: 4856 . ctx - the monitor context 4857 4858 Level: intermediate 4859 4860 .keywords: TS, vector, monitor, view 4861 4862 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError() 4863 @*/ 4864 PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx) 4865 { 4866 PetscErrorCode ierr; 4867 4868 PetscFunctionBegin; 4869 ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr); 4870 ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr); 4871 ierr = PetscFree(*ictx);CHKERRQ(ierr); 4872 PetscFunctionReturn(0); 4873 } 4874 4875 #undef __FUNCT__ 4876 #define __FUNCT__ "TSMonitorDrawCtxCreate" 4877 /*@C 4878 TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx 4879 4880 Collective on TS 4881 4882 Input Parameter: 4883 . ts - time-step context 4884 4885 Output Patameter: 4886 . ctx - the monitor context 4887 4888 Options Database: 4889 . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 4890 4891 Level: intermediate 4892 4893 .keywords: TS, vector, monitor, view 4894 4895 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx() 4896 @*/ 4897 PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx) 4898 { 4899 PetscErrorCode ierr; 4900 4901 PetscFunctionBegin; 4902 ierr = PetscNew(ctx);CHKERRQ(ierr); 4903 ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr); 4904 ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr); 4905 4906 (*ctx)->howoften = howoften; 4907 (*ctx)->showinitial = PETSC_FALSE; 4908 ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr); 4909 4910 (*ctx)->showtimestepandtime = PETSC_FALSE; 4911 ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr); 4912 PetscFunctionReturn(0); 4913 } 4914 4915 #undef __FUNCT__ 4916 #define __FUNCT__ "TSMonitorDrawError" 4917 /*@C 4918 TSMonitorDrawError - Monitors progress of the TS solvers by calling 4919 VecView() for the error at each timestep 4920 4921 Collective on TS 4922 4923 Input Parameters: 4924 + ts - the TS context 4925 . step - current time-step 4926 . ptime - current time 4927 - dummy - either a viewer or NULL 4928 4929 Level: intermediate 4930 4931 .keywords: TS, vector, monitor, view 4932 4933 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 4934 @*/ 4935 PetscErrorCode TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 4936 { 4937 PetscErrorCode ierr; 4938 TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy; 4939 PetscViewer viewer = ctx->viewer; 4940 Vec work; 4941 4942 PetscFunctionBegin; 4943 if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 4944 ierr = VecDuplicate(u,&work);CHKERRQ(ierr); 4945 ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr); 4946 ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr); 4947 ierr = VecView(work,viewer);CHKERRQ(ierr); 4948 ierr = VecDestroy(&work);CHKERRQ(ierr); 4949 PetscFunctionReturn(0); 4950 } 4951 4952 #include <petsc/private/dmimpl.h> 4953 #undef __FUNCT__ 4954 #define __FUNCT__ "TSSetDM" 4955 /*@ 4956 TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS 4957 4958 Logically Collective on TS and DM 4959 4960 Input Parameters: 4961 + ts - the ODE integrator object 4962 - dm - the dm, cannot be NULL 4963 4964 Level: intermediate 4965 4966 4967 .seealso: TSGetDM(), SNESSetDM(), SNESGetDM() 4968 @*/ 4969 PetscErrorCode TSSetDM(TS ts,DM dm) 4970 { 4971 PetscErrorCode ierr; 4972 SNES snes; 4973 DMTS tsdm; 4974 4975 PetscFunctionBegin; 4976 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4977 PetscValidHeaderSpecific(dm,DM_CLASSID,2); 4978 ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr); 4979 if (ts->dm) { /* Move the DMTS context over to the new DM unless the new DM already has one */ 4980 if (ts->dm->dmts && !dm->dmts) { 4981 ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr); 4982 ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr); 4983 if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */ 4984 tsdm->originaldm = dm; 4985 } 4986 } 4987 ierr = DMDestroy(&ts->dm);CHKERRQ(ierr); 4988 } 4989 ts->dm = dm; 4990 4991 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4992 ierr = SNESSetDM(snes,dm);CHKERRQ(ierr); 4993 PetscFunctionReturn(0); 4994 } 4995 4996 #undef __FUNCT__ 4997 #define __FUNCT__ "TSGetDM" 4998 /*@ 4999 TSGetDM - Gets the DM that may be used by some preconditioners 5000 5001 Not Collective 5002 5003 Input Parameter: 5004 . ts - the preconditioner context 5005 5006 Output Parameter: 5007 . dm - the dm 5008 5009 Level: intermediate 5010 5011 5012 .seealso: TSSetDM(), SNESSetDM(), SNESGetDM() 5013 @*/ 5014 PetscErrorCode TSGetDM(TS ts,DM *dm) 5015 { 5016 PetscErrorCode ierr; 5017 5018 PetscFunctionBegin; 5019 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5020 if (!ts->dm) { 5021 ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr); 5022 if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 5023 } 5024 *dm = ts->dm; 5025 PetscFunctionReturn(0); 5026 } 5027 5028 #undef __FUNCT__ 5029 #define __FUNCT__ "SNESTSFormFunction" 5030 /*@ 5031 SNESTSFormFunction - Function to evaluate nonlinear residual 5032 5033 Logically Collective on SNES 5034 5035 Input Parameter: 5036 + snes - nonlinear solver 5037 . U - the current state at which to evaluate the residual 5038 - ctx - user context, must be a TS 5039 5040 Output Parameter: 5041 . F - the nonlinear residual 5042 5043 Notes: 5044 This function is not normally called by users and is automatically registered with the SNES used by TS. 5045 It is most frequently passed to MatFDColoringSetFunction(). 5046 5047 Level: advanced 5048 5049 .seealso: SNESSetFunction(), MatFDColoringSetFunction() 5050 @*/ 5051 PetscErrorCode SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx) 5052 { 5053 TS ts = (TS)ctx; 5054 PetscErrorCode ierr; 5055 5056 PetscFunctionBegin; 5057 PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 5058 PetscValidHeaderSpecific(U,VEC_CLASSID,2); 5059 PetscValidHeaderSpecific(F,VEC_CLASSID,3); 5060 PetscValidHeaderSpecific(ts,TS_CLASSID,4); 5061 ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr); 5062 PetscFunctionReturn(0); 5063 } 5064 5065 #undef __FUNCT__ 5066 #define __FUNCT__ "SNESTSFormJacobian" 5067 /*@ 5068 SNESTSFormJacobian - Function to evaluate the Jacobian 5069 5070 Collective on SNES 5071 5072 Input Parameter: 5073 + snes - nonlinear solver 5074 . U - the current state at which to evaluate the residual 5075 - ctx - user context, must be a TS 5076 5077 Output Parameter: 5078 + A - the Jacobian 5079 . B - the preconditioning matrix (may be the same as A) 5080 - flag - indicates any structure change in the matrix 5081 5082 Notes: 5083 This function is not normally called by users and is automatically registered with the SNES used by TS. 5084 5085 Level: developer 5086 5087 .seealso: SNESSetJacobian() 5088 @*/ 5089 PetscErrorCode SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx) 5090 { 5091 TS ts = (TS)ctx; 5092 PetscErrorCode ierr; 5093 5094 PetscFunctionBegin; 5095 PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 5096 PetscValidHeaderSpecific(U,VEC_CLASSID,2); 5097 PetscValidPointer(A,3); 5098 PetscValidHeaderSpecific(A,MAT_CLASSID,3); 5099 PetscValidPointer(B,4); 5100 PetscValidHeaderSpecific(B,MAT_CLASSID,4); 5101 PetscValidHeaderSpecific(ts,TS_CLASSID,6); 5102 ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr); 5103 PetscFunctionReturn(0); 5104 } 5105 5106 #undef __FUNCT__ 5107 #define __FUNCT__ "TSComputeRHSFunctionLinear" 5108 /*@C 5109 TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only 5110 5111 Collective on TS 5112 5113 Input Arguments: 5114 + ts - time stepping context 5115 . t - time at which to evaluate 5116 . U - state at which to evaluate 5117 - ctx - context 5118 5119 Output Arguments: 5120 . F - right hand side 5121 5122 Level: intermediate 5123 5124 Notes: 5125 This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems. 5126 The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian(). 5127 5128 .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 5129 @*/ 5130 PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx) 5131 { 5132 PetscErrorCode ierr; 5133 Mat Arhs,Brhs; 5134 5135 PetscFunctionBegin; 5136 ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 5137 ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 5138 ierr = MatMult(Arhs,U,F);CHKERRQ(ierr); 5139 PetscFunctionReturn(0); 5140 } 5141 5142 #undef __FUNCT__ 5143 #define __FUNCT__ "TSComputeRHSJacobianConstant" 5144 /*@C 5145 TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 5146 5147 Collective on TS 5148 5149 Input Arguments: 5150 + ts - time stepping context 5151 . t - time at which to evaluate 5152 . U - state at which to evaluate 5153 - ctx - context 5154 5155 Output Arguments: 5156 + A - pointer to operator 5157 . B - pointer to preconditioning matrix 5158 - flg - matrix structure flag 5159 5160 Level: intermediate 5161 5162 Notes: 5163 This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems. 5164 5165 .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear() 5166 @*/ 5167 PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx) 5168 { 5169 PetscFunctionBegin; 5170 PetscFunctionReturn(0); 5171 } 5172 5173 #undef __FUNCT__ 5174 #define __FUNCT__ "TSComputeIFunctionLinear" 5175 /*@C 5176 TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 5177 5178 Collective on TS 5179 5180 Input Arguments: 5181 + ts - time stepping context 5182 . t - time at which to evaluate 5183 . U - state at which to evaluate 5184 . Udot - time derivative of state vector 5185 - ctx - context 5186 5187 Output Arguments: 5188 . F - left hand side 5189 5190 Level: intermediate 5191 5192 Notes: 5193 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 5194 user is required to write their own TSComputeIFunction. 5195 This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems. 5196 The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian(). 5197 5198 Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U 5199 5200 .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear() 5201 @*/ 5202 PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx) 5203 { 5204 PetscErrorCode ierr; 5205 Mat A,B; 5206 5207 PetscFunctionBegin; 5208 ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 5209 ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr); 5210 ierr = MatMult(A,Udot,F);CHKERRQ(ierr); 5211 PetscFunctionReturn(0); 5212 } 5213 5214 #undef __FUNCT__ 5215 #define __FUNCT__ "TSComputeIJacobianConstant" 5216 /*@C 5217 TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE 5218 5219 Collective on TS 5220 5221 Input Arguments: 5222 + ts - time stepping context 5223 . t - time at which to evaluate 5224 . U - state at which to evaluate 5225 . Udot - time derivative of state vector 5226 . shift - shift to apply 5227 - ctx - context 5228 5229 Output Arguments: 5230 + A - pointer to operator 5231 . B - pointer to preconditioning matrix 5232 - flg - matrix structure flag 5233 5234 Level: advanced 5235 5236 Notes: 5237 This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems. 5238 5239 It is only appropriate for problems of the form 5240 5241 $ M Udot = F(U,t) 5242 5243 where M is constant and F is non-stiff. The user must pass M to TSSetIJacobian(). The current implementation only 5244 works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing 5245 an implicit operator of the form 5246 5247 $ shift*M + J 5248 5249 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 5250 a copy of M or reassemble it when requested. 5251 5252 .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear() 5253 @*/ 5254 PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx) 5255 { 5256 PetscErrorCode ierr; 5257 5258 PetscFunctionBegin; 5259 ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr); 5260 ts->ijacobian.shift = shift; 5261 PetscFunctionReturn(0); 5262 } 5263 5264 #undef __FUNCT__ 5265 #define __FUNCT__ "TSGetEquationType" 5266 /*@ 5267 TSGetEquationType - Gets the type of the equation that TS is solving. 5268 5269 Not Collective 5270 5271 Input Parameter: 5272 . ts - the TS context 5273 5274 Output Parameter: 5275 . equation_type - see TSEquationType 5276 5277 Level: beginner 5278 5279 .keywords: TS, equation type 5280 5281 .seealso: TSSetEquationType(), TSEquationType 5282 @*/ 5283 PetscErrorCode TSGetEquationType(TS ts,TSEquationType *equation_type) 5284 { 5285 PetscFunctionBegin; 5286 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5287 PetscValidPointer(equation_type,2); 5288 *equation_type = ts->equation_type; 5289 PetscFunctionReturn(0); 5290 } 5291 5292 #undef __FUNCT__ 5293 #define __FUNCT__ "TSSetEquationType" 5294 /*@ 5295 TSSetEquationType - Sets the type of the equation that TS is solving. 5296 5297 Not Collective 5298 5299 Input Parameter: 5300 + ts - the TS context 5301 - equation_type - see TSEquationType 5302 5303 Level: advanced 5304 5305 .keywords: TS, equation type 5306 5307 .seealso: TSGetEquationType(), TSEquationType 5308 @*/ 5309 PetscErrorCode TSSetEquationType(TS ts,TSEquationType equation_type) 5310 { 5311 PetscFunctionBegin; 5312 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5313 ts->equation_type = equation_type; 5314 PetscFunctionReturn(0); 5315 } 5316 5317 #undef __FUNCT__ 5318 #define __FUNCT__ "TSGetConvergedReason" 5319 /*@ 5320 TSGetConvergedReason - Gets the reason the TS iteration was stopped. 5321 5322 Not Collective 5323 5324 Input Parameter: 5325 . ts - the TS context 5326 5327 Output Parameter: 5328 . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 5329 manual pages for the individual convergence tests for complete lists 5330 5331 Level: beginner 5332 5333 Notes: 5334 Can only be called after the call to TSSolve() is complete. 5335 5336 .keywords: TS, nonlinear, set, convergence, test 5337 5338 .seealso: TSSetConvergenceTest(), TSConvergedReason 5339 @*/ 5340 PetscErrorCode TSGetConvergedReason(TS ts,TSConvergedReason *reason) 5341 { 5342 PetscFunctionBegin; 5343 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5344 PetscValidPointer(reason,2); 5345 *reason = ts->reason; 5346 PetscFunctionReturn(0); 5347 } 5348 5349 #undef __FUNCT__ 5350 #define __FUNCT__ "TSSetConvergedReason" 5351 /*@ 5352 TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve. 5353 5354 Not Collective 5355 5356 Input Parameter: 5357 + ts - the TS context 5358 . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 5359 manual pages for the individual convergence tests for complete lists 5360 5361 Level: advanced 5362 5363 Notes: 5364 Can only be called during TSSolve() is active. 5365 5366 .keywords: TS, nonlinear, set, convergence, test 5367 5368 .seealso: TSConvergedReason 5369 @*/ 5370 PetscErrorCode TSSetConvergedReason(TS ts,TSConvergedReason reason) 5371 { 5372 PetscFunctionBegin; 5373 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5374 ts->reason = reason; 5375 PetscFunctionReturn(0); 5376 } 5377 5378 #undef __FUNCT__ 5379 #define __FUNCT__ "TSGetSolveTime" 5380 /*@ 5381 TSGetSolveTime - Gets the time after a call to TSSolve() 5382 5383 Not Collective 5384 5385 Input Parameter: 5386 . ts - the TS context 5387 5388 Output Parameter: 5389 . ftime - the final time. This time corresponds to the final time set with TSSetDuration() 5390 5391 Level: beginner 5392 5393 Notes: 5394 Can only be called after the call to TSSolve() is complete. 5395 5396 .keywords: TS, nonlinear, set, convergence, test 5397 5398 .seealso: TSSetConvergenceTest(), TSConvergedReason 5399 @*/ 5400 PetscErrorCode TSGetSolveTime(TS ts,PetscReal *ftime) 5401 { 5402 PetscFunctionBegin; 5403 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5404 PetscValidPointer(ftime,2); 5405 *ftime = ts->solvetime; 5406 PetscFunctionReturn(0); 5407 } 5408 5409 #undef __FUNCT__ 5410 #define __FUNCT__ "TSGetTotalSteps" 5411 /*@ 5412 TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate() 5413 5414 Not Collective 5415 5416 Input Parameter: 5417 . ts - the TS context 5418 5419 Output Parameter: 5420 . steps - the number of steps 5421 5422 Level: beginner 5423 5424 Notes: 5425 Includes the number of steps for all calls to TSSolve() since TSSetUp() was called 5426 5427 .keywords: TS, nonlinear, set, convergence, test 5428 5429 .seealso: TSSetConvergenceTest(), TSConvergedReason 5430 @*/ 5431 PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps) 5432 { 5433 PetscFunctionBegin; 5434 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5435 PetscValidPointer(steps,2); 5436 *steps = ts->total_steps; 5437 PetscFunctionReturn(0); 5438 } 5439 5440 #undef __FUNCT__ 5441 #define __FUNCT__ "TSGetSNESIterations" 5442 /*@ 5443 TSGetSNESIterations - Gets the total number of nonlinear iterations 5444 used by the time integrator. 5445 5446 Not Collective 5447 5448 Input Parameter: 5449 . ts - TS context 5450 5451 Output Parameter: 5452 . nits - number of nonlinear iterations 5453 5454 Notes: 5455 This counter is reset to zero for each successive call to TSSolve(). 5456 5457 Level: intermediate 5458 5459 .keywords: TS, get, number, nonlinear, iterations 5460 5461 .seealso: TSGetKSPIterations() 5462 @*/ 5463 PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits) 5464 { 5465 PetscFunctionBegin; 5466 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5467 PetscValidIntPointer(nits,2); 5468 *nits = ts->snes_its; 5469 PetscFunctionReturn(0); 5470 } 5471 5472 #undef __FUNCT__ 5473 #define __FUNCT__ "TSGetKSPIterations" 5474 /*@ 5475 TSGetKSPIterations - Gets the total number of linear iterations 5476 used by the time integrator. 5477 5478 Not Collective 5479 5480 Input Parameter: 5481 . ts - TS context 5482 5483 Output Parameter: 5484 . lits - number of linear iterations 5485 5486 Notes: 5487 This counter is reset to zero for each successive call to TSSolve(). 5488 5489 Level: intermediate 5490 5491 .keywords: TS, get, number, linear, iterations 5492 5493 .seealso: TSGetSNESIterations(), SNESGetKSPIterations() 5494 @*/ 5495 PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits) 5496 { 5497 PetscFunctionBegin; 5498 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5499 PetscValidIntPointer(lits,2); 5500 *lits = ts->ksp_its; 5501 PetscFunctionReturn(0); 5502 } 5503 5504 #undef __FUNCT__ 5505 #define __FUNCT__ "TSGetStepRejections" 5506 /*@ 5507 TSGetStepRejections - Gets the total number of rejected steps. 5508 5509 Not Collective 5510 5511 Input Parameter: 5512 . ts - TS context 5513 5514 Output Parameter: 5515 . rejects - number of steps rejected 5516 5517 Notes: 5518 This counter is reset to zero for each successive call to TSSolve(). 5519 5520 Level: intermediate 5521 5522 .keywords: TS, get, number 5523 5524 .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails() 5525 @*/ 5526 PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects) 5527 { 5528 PetscFunctionBegin; 5529 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5530 PetscValidIntPointer(rejects,2); 5531 *rejects = ts->reject; 5532 PetscFunctionReturn(0); 5533 } 5534 5535 #undef __FUNCT__ 5536 #define __FUNCT__ "TSGetSNESFailures" 5537 /*@ 5538 TSGetSNESFailures - Gets the total number of failed SNES solves 5539 5540 Not Collective 5541 5542 Input Parameter: 5543 . ts - TS context 5544 5545 Output Parameter: 5546 . fails - number of failed nonlinear solves 5547 5548 Notes: 5549 This counter is reset to zero for each successive call to TSSolve(). 5550 5551 Level: intermediate 5552 5553 .keywords: TS, get, number 5554 5555 .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures() 5556 @*/ 5557 PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails) 5558 { 5559 PetscFunctionBegin; 5560 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5561 PetscValidIntPointer(fails,2); 5562 *fails = ts->num_snes_failures; 5563 PetscFunctionReturn(0); 5564 } 5565 5566 #undef __FUNCT__ 5567 #define __FUNCT__ "TSSetMaxStepRejections" 5568 /*@ 5569 TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails 5570 5571 Not Collective 5572 5573 Input Parameter: 5574 + ts - TS context 5575 - rejects - maximum number of rejected steps, pass -1 for unlimited 5576 5577 Notes: 5578 The counter is reset to zero for each step 5579 5580 Options Database Key: 5581 . -ts_max_reject - Maximum number of step rejections before a step fails 5582 5583 Level: intermediate 5584 5585 .keywords: TS, set, maximum, number 5586 5587 .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 5588 @*/ 5589 PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects) 5590 { 5591 PetscFunctionBegin; 5592 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5593 ts->max_reject = rejects; 5594 PetscFunctionReturn(0); 5595 } 5596 5597 #undef __FUNCT__ 5598 #define __FUNCT__ "TSSetMaxSNESFailures" 5599 /*@ 5600 TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves 5601 5602 Not Collective 5603 5604 Input Parameter: 5605 + ts - TS context 5606 - fails - maximum number of failed nonlinear solves, pass -1 for unlimited 5607 5608 Notes: 5609 The counter is reset to zero for each successive call to TSSolve(). 5610 5611 Options Database Key: 5612 . -ts_max_snes_failures - Maximum number of nonlinear solve failures 5613 5614 Level: intermediate 5615 5616 .keywords: TS, set, maximum, number 5617 5618 .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason() 5619 @*/ 5620 PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails) 5621 { 5622 PetscFunctionBegin; 5623 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5624 ts->max_snes_failures = fails; 5625 PetscFunctionReturn(0); 5626 } 5627 5628 #undef __FUNCT__ 5629 #define __FUNCT__ "TSSetErrorIfStepFails" 5630 /*@ 5631 TSSetErrorIfStepFails - Error if no step succeeds 5632 5633 Not Collective 5634 5635 Input Parameter: 5636 + ts - TS context 5637 - err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure 5638 5639 Options Database Key: 5640 . -ts_error_if_step_fails - Error if no step succeeds 5641 5642 Level: intermediate 5643 5644 .keywords: TS, set, error 5645 5646 .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 5647 @*/ 5648 PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err) 5649 { 5650 PetscFunctionBegin; 5651 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5652 ts->errorifstepfailed = err; 5653 PetscFunctionReturn(0); 5654 } 5655 5656 #undef __FUNCT__ 5657 #define __FUNCT__ "TSMonitorSolution" 5658 /*@C 5659 TSMonitorSolution - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file or a PetscDraw object 5660 5661 Collective on TS 5662 5663 Input Parameters: 5664 + ts - the TS context 5665 . step - current time-step 5666 . ptime - current time 5667 . u - current state 5668 - vf - viewer and its format 5669 5670 Level: intermediate 5671 5672 .keywords: TS, vector, monitor, view 5673 5674 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5675 @*/ 5676 PetscErrorCode TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf) 5677 { 5678 PetscErrorCode ierr; 5679 5680 PetscFunctionBegin; 5681 ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr); 5682 ierr = VecView(u,vf->viewer);CHKERRQ(ierr); 5683 ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr); 5684 PetscFunctionReturn(0); 5685 } 5686 5687 #undef __FUNCT__ 5688 #define __FUNCT__ "TSMonitorSolutionVTK" 5689 /*@C 5690 TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep. 5691 5692 Collective on TS 5693 5694 Input Parameters: 5695 + ts - the TS context 5696 . step - current time-step 5697 . ptime - current time 5698 . u - current state 5699 - filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 5700 5701 Level: intermediate 5702 5703 Notes: 5704 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. 5705 These are named according to the file name template. 5706 5707 This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy(). 5708 5709 .keywords: TS, vector, monitor, view 5710 5711 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5712 @*/ 5713 PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate) 5714 { 5715 PetscErrorCode ierr; 5716 char filename[PETSC_MAX_PATH_LEN]; 5717 PetscViewer viewer; 5718 5719 PetscFunctionBegin; 5720 if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 5721 ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr); 5722 ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr); 5723 ierr = VecView(u,viewer);CHKERRQ(ierr); 5724 ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 5725 PetscFunctionReturn(0); 5726 } 5727 5728 #undef __FUNCT__ 5729 #define __FUNCT__ "TSMonitorSolutionVTKDestroy" 5730 /*@C 5731 TSMonitorSolutionVTKDestroy - Destroy context for monitoring 5732 5733 Collective on TS 5734 5735 Input Parameters: 5736 . filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 5737 5738 Level: intermediate 5739 5740 Note: 5741 This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK(). 5742 5743 .keywords: TS, vector, monitor, view 5744 5745 .seealso: TSMonitorSet(), TSMonitorSolutionVTK() 5746 @*/ 5747 PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate) 5748 { 5749 PetscErrorCode ierr; 5750 5751 PetscFunctionBegin; 5752 ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr); 5753 PetscFunctionReturn(0); 5754 } 5755 5756 #undef __FUNCT__ 5757 #define __FUNCT__ "TSGetAdapt" 5758 /*@ 5759 TSGetAdapt - Get the adaptive controller context for the current method 5760 5761 Collective on TS if controller has not been created yet 5762 5763 Input Arguments: 5764 . ts - time stepping context 5765 5766 Output Arguments: 5767 . adapt - adaptive controller 5768 5769 Level: intermediate 5770 5771 .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose() 5772 @*/ 5773 PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt) 5774 { 5775 PetscErrorCode ierr; 5776 5777 PetscFunctionBegin; 5778 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5779 PetscValidPointer(adapt,2); 5780 if (!ts->adapt) { 5781 ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr); 5782 ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr); 5783 ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr); 5784 } 5785 *adapt = ts->adapt; 5786 PetscFunctionReturn(0); 5787 } 5788 5789 #undef __FUNCT__ 5790 #define __FUNCT__ "TSSetTolerances" 5791 /*@ 5792 TSSetTolerances - Set tolerances for local truncation error when using adaptive controller 5793 5794 Logically Collective 5795 5796 Input Arguments: 5797 + ts - time integration context 5798 . atol - scalar absolute tolerances, PETSC_DECIDE to leave current value 5799 . vatol - vector of absolute tolerances or NULL, used in preference to atol if present 5800 . rtol - scalar relative tolerances, PETSC_DECIDE to leave current value 5801 - vrtol - vector of relative tolerances or NULL, used in preference to atol if present 5802 5803 Options Database keys: 5804 + -ts_rtol <rtol> - relative tolerance for local truncation error 5805 - -ts_atol <atol> Absolute tolerance for local truncation error 5806 5807 Notes: 5808 With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error 5809 (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be 5810 computed only for the differential or the algebraic part then this can be done using the vector of 5811 tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the 5812 differential part and infinity for the algebraic part, the LTE calculation will include only the 5813 differential variables. 5814 5815 Level: beginner 5816 5817 .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances() 5818 @*/ 5819 PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol) 5820 { 5821 PetscErrorCode ierr; 5822 5823 PetscFunctionBegin; 5824 if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol; 5825 if (vatol) { 5826 ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr); 5827 ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 5828 ts->vatol = vatol; 5829 } 5830 if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol; 5831 if (vrtol) { 5832 ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr); 5833 ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 5834 ts->vrtol = vrtol; 5835 } 5836 PetscFunctionReturn(0); 5837 } 5838 5839 #undef __FUNCT__ 5840 #define __FUNCT__ "TSGetTolerances" 5841 /*@ 5842 TSGetTolerances - Get tolerances for local truncation error when using adaptive controller 5843 5844 Logically Collective 5845 5846 Input Arguments: 5847 . ts - time integration context 5848 5849 Output Arguments: 5850 + atol - scalar absolute tolerances, NULL to ignore 5851 . vatol - vector of absolute tolerances, NULL to ignore 5852 . rtol - scalar relative tolerances, NULL to ignore 5853 - vrtol - vector of relative tolerances, NULL to ignore 5854 5855 Level: beginner 5856 5857 .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances() 5858 @*/ 5859 PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol) 5860 { 5861 PetscFunctionBegin; 5862 if (atol) *atol = ts->atol; 5863 if (vatol) *vatol = ts->vatol; 5864 if (rtol) *rtol = ts->rtol; 5865 if (vrtol) *vrtol = ts->vrtol; 5866 PetscFunctionReturn(0); 5867 } 5868 5869 #undef __FUNCT__ 5870 #define __FUNCT__ "TSErrorWeightedNorm2" 5871 /*@ 5872 TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors 5873 5874 Collective on TS 5875 5876 Input Arguments: 5877 + ts - time stepping context 5878 . U - state vector, usually ts->vec_sol 5879 - Y - state vector to be compared to U 5880 5881 Output Arguments: 5882 . norm - weighted norm, a value of 1.0 is considered small 5883 5884 Level: developer 5885 5886 .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity() 5887 @*/ 5888 PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm) 5889 { 5890 PetscErrorCode ierr; 5891 PetscInt i,n,N,rstart; 5892 const PetscScalar *u,*y; 5893 PetscReal sum,gsum; 5894 PetscReal tol; 5895 5896 PetscFunctionBegin; 5897 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5898 PetscValidHeaderSpecific(U,VEC_CLASSID,2); 5899 PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 5900 PetscValidType(U,2); 5901 PetscValidType(Y,3); 5902 PetscCheckSameComm(U,2,Y,3); 5903 PetscValidPointer(norm,4); 5904 if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 5905 5906 ierr = VecGetSize(U,&N);CHKERRQ(ierr); 5907 ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 5908 ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 5909 ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 5910 ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 5911 sum = 0.; 5912 if (ts->vatol && ts->vrtol) { 5913 const PetscScalar *atol,*rtol; 5914 ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 5915 ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 5916 for (i=0; i<n; i++) { 5917 tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 5918 sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 5919 } 5920 ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 5921 ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 5922 } else if (ts->vatol) { /* vector atol, scalar rtol */ 5923 const PetscScalar *atol; 5924 ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 5925 for (i=0; i<n; i++) { 5926 tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 5927 sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 5928 } 5929 ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 5930 } else if (ts->vrtol) { /* scalar atol, vector rtol */ 5931 const PetscScalar *rtol; 5932 ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 5933 for (i=0; i<n; i++) { 5934 tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 5935 sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 5936 } 5937 ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 5938 } else { /* scalar atol, scalar rtol */ 5939 for (i=0; i<n; i++) { 5940 tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 5941 sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 5942 } 5943 } 5944 ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 5945 ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 5946 5947 ierr = MPIU_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 5948 *norm = PetscSqrtReal(gsum / N); 5949 5950 if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 5951 PetscFunctionReturn(0); 5952 } 5953 5954 #undef __FUNCT__ 5955 #define __FUNCT__ "TSErrorWeightedNormInfinity" 5956 /*@ 5957 TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors 5958 5959 Collective on TS 5960 5961 Input Arguments: 5962 + ts - time stepping context 5963 . U - state vector, usually ts->vec_sol 5964 - Y - state vector to be compared to U 5965 5966 Output Arguments: 5967 . norm - weighted norm, a value of 1.0 is considered small 5968 5969 Level: developer 5970 5971 .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2() 5972 @*/ 5973 PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm) 5974 { 5975 PetscErrorCode ierr; 5976 PetscInt i,n,N,rstart,k; 5977 const PetscScalar *u,*y; 5978 PetscReal max,gmax; 5979 PetscReal tol; 5980 5981 PetscFunctionBegin; 5982 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5983 PetscValidHeaderSpecific(U,VEC_CLASSID,2); 5984 PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 5985 PetscValidType(U,2); 5986 PetscValidType(Y,3); 5987 PetscCheckSameComm(U,2,Y,3); 5988 PetscValidPointer(norm,4); 5989 if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 5990 5991 ierr = VecGetSize(U,&N);CHKERRQ(ierr); 5992 ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 5993 ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 5994 ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 5995 ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 5996 if (ts->vatol && ts->vrtol) { 5997 const PetscScalar *atol,*rtol; 5998 ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 5999 ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 6000 k = 0; 6001 tol = PetscRealPart(atol[k]) + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k])); 6002 max = PetscAbsScalar(y[k] - u[k]) / tol; 6003 for (i=1; i<n; i++) { 6004 tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 6005 max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol); 6006 } 6007 ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 6008 ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 6009 } else if (ts->vatol) { /* vector atol, scalar rtol */ 6010 const PetscScalar *atol; 6011 ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 6012 k = 0; 6013 tol = PetscRealPart(atol[k]) + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k])); 6014 max = PetscAbsScalar(y[k] - u[k]) / tol; 6015 for (i=1; i<n; i++) { 6016 tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 6017 max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol); 6018 } 6019 ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 6020 } else if (ts->vrtol) { /* scalar atol, vector rtol */ 6021 const PetscScalar *rtol; 6022 ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 6023 k = 0; 6024 tol = ts->atol + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k])); 6025 max = PetscAbsScalar(y[k] - u[k]) / tol; 6026 for (i=1; i<n; i++) { 6027 tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 6028 max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol); 6029 } 6030 ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 6031 } else { /* scalar atol, scalar rtol */ 6032 k = 0; 6033 tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k])); 6034 max = PetscAbsScalar(y[k] - u[k]) / tol; 6035 for (i=1; i<n; i++) { 6036 tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 6037 max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol); 6038 } 6039 } 6040 ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 6041 ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 6042 6043 ierr = MPIU_Allreduce(&max,&gmax,1,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 6044 *norm = gmax; 6045 6046 if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 6047 PetscFunctionReturn(0); 6048 } 6049 6050 #undef __FUNCT__ 6051 #define __FUNCT__ "TSErrorWeightedNorm" 6052 /*@ 6053 TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors 6054 6055 Collective on TS 6056 6057 Input Arguments: 6058 + ts - time stepping context 6059 . U - state vector, usually ts->vec_sol 6060 . Y - state vector to be compared to U 6061 - wnormtype - norm type, either NORM_2 or NORM_INFINITY 6062 6063 Output Arguments: 6064 . norm - weighted norm, a value of 1.0 is considered small 6065 6066 6067 Options Database Keys: 6068 . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 6069 6070 Level: developer 6071 6072 .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2() 6073 @*/ 6074 PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm) 6075 { 6076 PetscErrorCode ierr; 6077 6078 PetscFunctionBegin; 6079 if (wnormtype == NORM_2) { 6080 ierr = TSErrorWeightedNorm2(ts,U,Y,norm);CHKERRQ(ierr); 6081 } else if(wnormtype == NORM_INFINITY) { 6082 ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm);CHKERRQ(ierr); 6083 } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 6084 PetscFunctionReturn(0); 6085 } 6086 6087 #undef __FUNCT__ 6088 #define __FUNCT__ "TSSetCFLTimeLocal" 6089 /*@ 6090 TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler 6091 6092 Logically Collective on TS 6093 6094 Input Arguments: 6095 + ts - time stepping context 6096 - cfltime - maximum stable time step if using forward Euler (value can be different on each process) 6097 6098 Note: 6099 After calling this function, the global CFL time can be obtained by calling TSGetCFLTime() 6100 6101 Level: intermediate 6102 6103 .seealso: TSGetCFLTime(), TSADAPTCFL 6104 @*/ 6105 PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime) 6106 { 6107 PetscFunctionBegin; 6108 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6109 ts->cfltime_local = cfltime; 6110 ts->cfltime = -1.; 6111 PetscFunctionReturn(0); 6112 } 6113 6114 #undef __FUNCT__ 6115 #define __FUNCT__ "TSGetCFLTime" 6116 /*@ 6117 TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler 6118 6119 Collective on TS 6120 6121 Input Arguments: 6122 . ts - time stepping context 6123 6124 Output Arguments: 6125 . cfltime - maximum stable time step for forward Euler 6126 6127 Level: advanced 6128 6129 .seealso: TSSetCFLTimeLocal() 6130 @*/ 6131 PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime) 6132 { 6133 PetscErrorCode ierr; 6134 6135 PetscFunctionBegin; 6136 if (ts->cfltime < 0) { 6137 ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 6138 } 6139 *cfltime = ts->cfltime; 6140 PetscFunctionReturn(0); 6141 } 6142 6143 #undef __FUNCT__ 6144 #define __FUNCT__ "TSVISetVariableBounds" 6145 /*@ 6146 TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu 6147 6148 Input Parameters: 6149 . ts - the TS context. 6150 . xl - lower bound. 6151 . xu - upper bound. 6152 6153 Notes: 6154 If this routine is not called then the lower and upper bounds are set to 6155 PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp(). 6156 6157 Level: advanced 6158 6159 @*/ 6160 PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu) 6161 { 6162 PetscErrorCode ierr; 6163 SNES snes; 6164 6165 PetscFunctionBegin; 6166 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 6167 ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr); 6168 PetscFunctionReturn(0); 6169 } 6170 6171 #if defined(PETSC_HAVE_MATLAB_ENGINE) 6172 #include <mex.h> 6173 6174 typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext; 6175 6176 #undef __FUNCT__ 6177 #define __FUNCT__ "TSComputeFunction_Matlab" 6178 /* 6179 TSComputeFunction_Matlab - Calls the function that has been set with 6180 TSSetFunctionMatlab(). 6181 6182 Collective on TS 6183 6184 Input Parameters: 6185 + snes - the TS context 6186 - u - input vector 6187 6188 Output Parameter: 6189 . y - function vector, as set by TSSetFunction() 6190 6191 Notes: 6192 TSComputeFunction() is typically used within nonlinear solvers 6193 implementations, so most users would not generally call this routine 6194 themselves. 6195 6196 Level: developer 6197 6198 .keywords: TS, nonlinear, compute, function 6199 6200 .seealso: TSSetFunction(), TSGetFunction() 6201 */ 6202 PetscErrorCode TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx) 6203 { 6204 PetscErrorCode ierr; 6205 TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6206 int nlhs = 1,nrhs = 7; 6207 mxArray *plhs[1],*prhs[7]; 6208 long long int lx = 0,lxdot = 0,ly = 0,ls = 0; 6209 6210 PetscFunctionBegin; 6211 PetscValidHeaderSpecific(snes,TS_CLASSID,1); 6212 PetscValidHeaderSpecific(u,VEC_CLASSID,3); 6213 PetscValidHeaderSpecific(udot,VEC_CLASSID,4); 6214 PetscValidHeaderSpecific(y,VEC_CLASSID,5); 6215 PetscCheckSameComm(snes,1,u,3); 6216 PetscCheckSameComm(snes,1,y,5); 6217 6218 ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 6219 ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 6220 ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr); 6221 ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr); 6222 6223 prhs[0] = mxCreateDoubleScalar((double)ls); 6224 prhs[1] = mxCreateDoubleScalar(time); 6225 prhs[2] = mxCreateDoubleScalar((double)lx); 6226 prhs[3] = mxCreateDoubleScalar((double)lxdot); 6227 prhs[4] = mxCreateDoubleScalar((double)ly); 6228 prhs[5] = mxCreateString(sctx->funcname); 6229 prhs[6] = sctx->ctx; 6230 ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr); 6231 ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6232 mxDestroyArray(prhs[0]); 6233 mxDestroyArray(prhs[1]); 6234 mxDestroyArray(prhs[2]); 6235 mxDestroyArray(prhs[3]); 6236 mxDestroyArray(prhs[4]); 6237 mxDestroyArray(prhs[5]); 6238 mxDestroyArray(plhs[0]); 6239 PetscFunctionReturn(0); 6240 } 6241 6242 6243 #undef __FUNCT__ 6244 #define __FUNCT__ "TSSetFunctionMatlab" 6245 /* 6246 TSSetFunctionMatlab - Sets the function evaluation routine and function 6247 vector for use by the TS routines in solving ODEs 6248 equations from MATLAB. Here the function is a string containing the name of a MATLAB function 6249 6250 Logically Collective on TS 6251 6252 Input Parameters: 6253 + ts - the TS context 6254 - func - function evaluation routine 6255 6256 Calling sequence of func: 6257 $ func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx); 6258 6259 Level: beginner 6260 6261 .keywords: TS, nonlinear, set, function 6262 6263 .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6264 */ 6265 PetscErrorCode TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx) 6266 { 6267 PetscErrorCode ierr; 6268 TSMatlabContext *sctx; 6269 6270 PetscFunctionBegin; 6271 /* currently sctx is memory bleed */ 6272 ierr = PetscNew(&sctx);CHKERRQ(ierr); 6273 ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6274 /* 6275 This should work, but it doesn't 6276 sctx->ctx = ctx; 6277 mexMakeArrayPersistent(sctx->ctx); 6278 */ 6279 sctx->ctx = mxDuplicateArray(ctx); 6280 6281 ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr); 6282 PetscFunctionReturn(0); 6283 } 6284 6285 #undef __FUNCT__ 6286 #define __FUNCT__ "TSComputeJacobian_Matlab" 6287 /* 6288 TSComputeJacobian_Matlab - Calls the function that has been set with 6289 TSSetJacobianMatlab(). 6290 6291 Collective on TS 6292 6293 Input Parameters: 6294 + ts - the TS context 6295 . u - input vector 6296 . A, B - the matrices 6297 - ctx - user context 6298 6299 Level: developer 6300 6301 .keywords: TS, nonlinear, compute, function 6302 6303 .seealso: TSSetFunction(), TSGetFunction() 6304 @*/ 6305 PetscErrorCode TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx) 6306 { 6307 PetscErrorCode ierr; 6308 TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6309 int nlhs = 2,nrhs = 9; 6310 mxArray *plhs[2],*prhs[9]; 6311 long long int lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0; 6312 6313 PetscFunctionBegin; 6314 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6315 PetscValidHeaderSpecific(u,VEC_CLASSID,3); 6316 6317 /* call Matlab function in ctx with arguments u and y */ 6318 6319 ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 6320 ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 6321 ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr); 6322 ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr); 6323 ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr); 6324 6325 prhs[0] = mxCreateDoubleScalar((double)ls); 6326 prhs[1] = mxCreateDoubleScalar((double)time); 6327 prhs[2] = mxCreateDoubleScalar((double)lx); 6328 prhs[3] = mxCreateDoubleScalar((double)lxdot); 6329 prhs[4] = mxCreateDoubleScalar((double)shift); 6330 prhs[5] = mxCreateDoubleScalar((double)lA); 6331 prhs[6] = mxCreateDoubleScalar((double)lB); 6332 prhs[7] = mxCreateString(sctx->funcname); 6333 prhs[8] = sctx->ctx; 6334 ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr); 6335 ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6336 mxDestroyArray(prhs[0]); 6337 mxDestroyArray(prhs[1]); 6338 mxDestroyArray(prhs[2]); 6339 mxDestroyArray(prhs[3]); 6340 mxDestroyArray(prhs[4]); 6341 mxDestroyArray(prhs[5]); 6342 mxDestroyArray(prhs[6]); 6343 mxDestroyArray(prhs[7]); 6344 mxDestroyArray(plhs[0]); 6345 mxDestroyArray(plhs[1]); 6346 PetscFunctionReturn(0); 6347 } 6348 6349 6350 #undef __FUNCT__ 6351 #define __FUNCT__ "TSSetJacobianMatlab" 6352 /* 6353 TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 6354 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 6355 6356 Logically Collective on TS 6357 6358 Input Parameters: 6359 + ts - the TS context 6360 . A,B - Jacobian matrices 6361 . func - function evaluation routine 6362 - ctx - user context 6363 6364 Calling sequence of func: 6365 $ flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx); 6366 6367 6368 Level: developer 6369 6370 .keywords: TS, nonlinear, set, function 6371 6372 .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6373 */ 6374 PetscErrorCode TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx) 6375 { 6376 PetscErrorCode ierr; 6377 TSMatlabContext *sctx; 6378 6379 PetscFunctionBegin; 6380 /* currently sctx is memory bleed */ 6381 ierr = PetscNew(&sctx);CHKERRQ(ierr); 6382 ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6383 /* 6384 This should work, but it doesn't 6385 sctx->ctx = ctx; 6386 mexMakeArrayPersistent(sctx->ctx); 6387 */ 6388 sctx->ctx = mxDuplicateArray(ctx); 6389 6390 ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 6391 PetscFunctionReturn(0); 6392 } 6393 6394 #undef __FUNCT__ 6395 #define __FUNCT__ "TSMonitor_Matlab" 6396 /* 6397 TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab(). 6398 6399 Collective on TS 6400 6401 .seealso: TSSetFunction(), TSGetFunction() 6402 @*/ 6403 PetscErrorCode TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx) 6404 { 6405 PetscErrorCode ierr; 6406 TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6407 int nlhs = 1,nrhs = 6; 6408 mxArray *plhs[1],*prhs[6]; 6409 long long int lx = 0,ls = 0; 6410 6411 PetscFunctionBegin; 6412 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6413 PetscValidHeaderSpecific(u,VEC_CLASSID,4); 6414 6415 ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 6416 ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 6417 6418 prhs[0] = mxCreateDoubleScalar((double)ls); 6419 prhs[1] = mxCreateDoubleScalar((double)it); 6420 prhs[2] = mxCreateDoubleScalar((double)time); 6421 prhs[3] = mxCreateDoubleScalar((double)lx); 6422 prhs[4] = mxCreateString(sctx->funcname); 6423 prhs[5] = sctx->ctx; 6424 ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr); 6425 ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6426 mxDestroyArray(prhs[0]); 6427 mxDestroyArray(prhs[1]); 6428 mxDestroyArray(prhs[2]); 6429 mxDestroyArray(prhs[3]); 6430 mxDestroyArray(prhs[4]); 6431 mxDestroyArray(plhs[0]); 6432 PetscFunctionReturn(0); 6433 } 6434 6435 6436 #undef __FUNCT__ 6437 #define __FUNCT__ "TSMonitorSetMatlab" 6438 /* 6439 TSMonitorSetMatlab - Sets the monitor function from Matlab 6440 6441 Level: developer 6442 6443 .keywords: TS, nonlinear, set, function 6444 6445 .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6446 */ 6447 PetscErrorCode TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx) 6448 { 6449 PetscErrorCode ierr; 6450 TSMatlabContext *sctx; 6451 6452 PetscFunctionBegin; 6453 /* currently sctx is memory bleed */ 6454 ierr = PetscNew(&sctx);CHKERRQ(ierr); 6455 ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6456 /* 6457 This should work, but it doesn't 6458 sctx->ctx = ctx; 6459 mexMakeArrayPersistent(sctx->ctx); 6460 */ 6461 sctx->ctx = mxDuplicateArray(ctx); 6462 6463 ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr); 6464 PetscFunctionReturn(0); 6465 } 6466 #endif 6467 6468 #undef __FUNCT__ 6469 #define __FUNCT__ "TSMonitorLGSolution" 6470 /*@C 6471 TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector 6472 in a time based line graph 6473 6474 Collective on TS 6475 6476 Input Parameters: 6477 + ts - the TS context 6478 . step - current time-step 6479 . ptime - current time 6480 . u - current solution 6481 - dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate() 6482 6483 Options Database: 6484 . -ts_monitor_lg_solution_variables 6485 6486 Level: intermediate 6487 6488 Notes: Each process in a parallel run displays its component solutions in a separate window 6489 6490 .keywords: TS, vector, monitor, view 6491 6492 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(), 6493 TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(), 6494 TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(), 6495 TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop() 6496 @*/ 6497 PetscErrorCode TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 6498 { 6499 PetscErrorCode ierr; 6500 TSMonitorLGCtx ctx = (TSMonitorLGCtx)dctx; 6501 const PetscScalar *yy; 6502 Vec v; 6503 6504 PetscFunctionBegin; 6505 if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 6506 if (!step) { 6507 PetscDrawAxis axis; 6508 PetscInt dim; 6509 ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 6510 ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr); 6511 if (!ctx->names) { 6512 PetscBool flg; 6513 /* user provides names of variables to plot but no names has been set so assume names are integer values */ 6514 ierr = PetscOptionsHasName(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",&flg);CHKERRQ(ierr); 6515 if (flg) { 6516 PetscInt i,n; 6517 char **names; 6518 ierr = VecGetSize(u,&n);CHKERRQ(ierr); 6519 ierr = PetscMalloc1(n+1,&names);CHKERRQ(ierr); 6520 for (i=0; i<n; i++) { 6521 ierr = PetscMalloc1(5,&names[i]);CHKERRQ(ierr); 6522 ierr = PetscSNPrintf(names[i],5,"%D",i);CHKERRQ(ierr); 6523 } 6524 names[n] = NULL; 6525 ctx->names = names; 6526 } 6527 } 6528 if (ctx->names && !ctx->displaynames) { 6529 char **displaynames; 6530 PetscBool flg; 6531 ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 6532 ierr = PetscMalloc1(dim+1,&displaynames);CHKERRQ(ierr); 6533 ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr); 6534 ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr); 6535 if (flg) { 6536 ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr); 6537 } 6538 ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr); 6539 } 6540 if (ctx->displaynames) { 6541 ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr); 6542 ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr); 6543 } else if (ctx->names) { 6544 ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 6545 ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6546 ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr); 6547 } else { 6548 ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 6549 ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6550 } 6551 ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 6552 } 6553 6554 if (!ctx->transform) v = u; 6555 else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);} 6556 ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr); 6557 if (ctx->displaynames) { 6558 PetscInt i; 6559 for (i=0; i<ctx->ndisplayvariables; i++) 6560 ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]); 6561 ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr); 6562 } else { 6563 #if defined(PETSC_USE_COMPLEX) 6564 PetscInt i,n; 6565 PetscReal *yreal; 6566 ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr); 6567 ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 6568 for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 6569 ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 6570 ierr = PetscFree(yreal);CHKERRQ(ierr); 6571 #else 6572 ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 6573 #endif 6574 } 6575 ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr); 6576 if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);} 6577 6578 if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 6579 ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 6580 ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 6581 } 6582 PetscFunctionReturn(0); 6583 } 6584 6585 6586 #undef __FUNCT__ 6587 #define __FUNCT__ "TSMonitorLGSetVariableNames" 6588 /*@C 6589 TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot 6590 6591 Collective on TS 6592 6593 Input Parameters: 6594 + ts - the TS context 6595 - names - the names of the components, final string must be NULL 6596 6597 Level: intermediate 6598 6599 Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 6600 6601 .keywords: TS, vector, monitor, view 6602 6603 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames() 6604 @*/ 6605 PetscErrorCode TSMonitorLGSetVariableNames(TS ts,const char * const *names) 6606 { 6607 PetscErrorCode ierr; 6608 PetscInt i; 6609 6610 PetscFunctionBegin; 6611 for (i=0; i<ts->numbermonitors; i++) { 6612 if (ts->monitor[i] == TSMonitorLGSolution) { 6613 ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr); 6614 break; 6615 } 6616 } 6617 PetscFunctionReturn(0); 6618 } 6619 6620 #undef __FUNCT__ 6621 #define __FUNCT__ "TSMonitorLGCtxSetVariableNames" 6622 /*@C 6623 TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot 6624 6625 Collective on TS 6626 6627 Input Parameters: 6628 + ts - the TS context 6629 - names - the names of the components, final string must be NULL 6630 6631 Level: intermediate 6632 6633 .keywords: TS, vector, monitor, view 6634 6635 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames() 6636 @*/ 6637 PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names) 6638 { 6639 PetscErrorCode ierr; 6640 6641 PetscFunctionBegin; 6642 ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr); 6643 ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr); 6644 PetscFunctionReturn(0); 6645 } 6646 6647 #undef __FUNCT__ 6648 #define __FUNCT__ "TSMonitorLGGetVariableNames" 6649 /*@C 6650 TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot 6651 6652 Collective on TS 6653 6654 Input Parameter: 6655 . ts - the TS context 6656 6657 Output Parameter: 6658 . names - the names of the components, final string must be NULL 6659 6660 Level: intermediate 6661 6662 Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 6663 6664 .keywords: TS, vector, monitor, view 6665 6666 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables() 6667 @*/ 6668 PetscErrorCode TSMonitorLGGetVariableNames(TS ts,const char *const **names) 6669 { 6670 PetscInt i; 6671 6672 PetscFunctionBegin; 6673 *names = NULL; 6674 for (i=0; i<ts->numbermonitors; i++) { 6675 if (ts->monitor[i] == TSMonitorLGSolution) { 6676 TSMonitorLGCtx ctx = (TSMonitorLGCtx) ts->monitorcontext[i]; 6677 *names = (const char *const *)ctx->names; 6678 break; 6679 } 6680 } 6681 PetscFunctionReturn(0); 6682 } 6683 6684 #undef __FUNCT__ 6685 #define __FUNCT__ "TSMonitorLGCtxSetDisplayVariables" 6686 /*@C 6687 TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor 6688 6689 Collective on TS 6690 6691 Input Parameters: 6692 + ctx - the TSMonitorLG context 6693 . displaynames - the names of the components, final string must be NULL 6694 6695 Level: intermediate 6696 6697 .keywords: TS, vector, monitor, view 6698 6699 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames() 6700 @*/ 6701 PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames) 6702 { 6703 PetscInt j = 0,k; 6704 PetscErrorCode ierr; 6705 6706 PetscFunctionBegin; 6707 if (!ctx->names) PetscFunctionReturn(0); 6708 ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr); 6709 ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr); 6710 while (displaynames[j]) j++; 6711 ctx->ndisplayvariables = j; 6712 ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr); 6713 ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr); 6714 j = 0; 6715 while (displaynames[j]) { 6716 k = 0; 6717 while (ctx->names[k]) { 6718 PetscBool flg; 6719 ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr); 6720 if (flg) { 6721 ctx->displayvariables[j] = k; 6722 break; 6723 } 6724 k++; 6725 } 6726 j++; 6727 } 6728 PetscFunctionReturn(0); 6729 } 6730 6731 6732 #undef __FUNCT__ 6733 #define __FUNCT__ "TSMonitorLGSetDisplayVariables" 6734 /*@C 6735 TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor 6736 6737 Collective on TS 6738 6739 Input Parameters: 6740 + ts - the TS context 6741 . displaynames - the names of the components, final string must be NULL 6742 6743 Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 6744 6745 Level: intermediate 6746 6747 .keywords: TS, vector, monitor, view 6748 6749 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames() 6750 @*/ 6751 PetscErrorCode TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames) 6752 { 6753 PetscInt i; 6754 PetscErrorCode ierr; 6755 6756 PetscFunctionBegin; 6757 for (i=0; i<ts->numbermonitors; i++) { 6758 if (ts->monitor[i] == TSMonitorLGSolution) { 6759 ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr); 6760 break; 6761 } 6762 } 6763 PetscFunctionReturn(0); 6764 } 6765 6766 #undef __FUNCT__ 6767 #define __FUNCT__ "TSMonitorLGSetTransform" 6768 /*@C 6769 TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed 6770 6771 Collective on TS 6772 6773 Input Parameters: 6774 + ts - the TS context 6775 . transform - the transform function 6776 . destroy - function to destroy the optional context 6777 - ctx - optional context used by transform function 6778 6779 Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 6780 6781 Level: intermediate 6782 6783 .keywords: TS, vector, monitor, view 6784 6785 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform() 6786 @*/ 6787 PetscErrorCode TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 6788 { 6789 PetscInt i; 6790 PetscErrorCode ierr; 6791 6792 PetscFunctionBegin; 6793 for (i=0; i<ts->numbermonitors; i++) { 6794 if (ts->monitor[i] == TSMonitorLGSolution) { 6795 ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr); 6796 } 6797 } 6798 PetscFunctionReturn(0); 6799 } 6800 6801 #undef __FUNCT__ 6802 #define __FUNCT__ "TSMonitorLGCtxSetTransform" 6803 /*@C 6804 TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed 6805 6806 Collective on TSLGCtx 6807 6808 Input Parameters: 6809 + ts - the TS context 6810 . transform - the transform function 6811 . destroy - function to destroy the optional context 6812 - ctx - optional context used by transform function 6813 6814 Level: intermediate 6815 6816 .keywords: TS, vector, monitor, view 6817 6818 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform() 6819 @*/ 6820 PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 6821 { 6822 PetscFunctionBegin; 6823 ctx->transform = transform; 6824 ctx->transformdestroy = destroy; 6825 ctx->transformctx = tctx; 6826 PetscFunctionReturn(0); 6827 } 6828 6829 #undef __FUNCT__ 6830 #define __FUNCT__ "TSMonitorLGError" 6831 /*@C 6832 TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector 6833 in a time based line graph 6834 6835 Collective on TS 6836 6837 Input Parameters: 6838 + ts - the TS context 6839 . step - current time-step 6840 . ptime - current time 6841 . u - current solution 6842 - dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate() 6843 6844 Level: intermediate 6845 6846 Notes: Each process in a parallel run displays its component errors in a separate window 6847 6848 The user must provide the solution using TSSetSolutionFunction() to use this monitor. 6849 6850 Options Database Keys: 6851 . -ts_monitor_lg_error - create a graphical monitor of error history 6852 6853 .keywords: TS, vector, monitor, view 6854 6855 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 6856 @*/ 6857 PetscErrorCode TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 6858 { 6859 PetscErrorCode ierr; 6860 TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 6861 const PetscScalar *yy; 6862 Vec y; 6863 6864 PetscFunctionBegin; 6865 if (!step) { 6866 PetscDrawAxis axis; 6867 PetscInt dim; 6868 ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 6869 ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr); 6870 ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 6871 ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6872 ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 6873 } 6874 ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 6875 ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr); 6876 ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr); 6877 ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr); 6878 #if defined(PETSC_USE_COMPLEX) 6879 { 6880 PetscReal *yreal; 6881 PetscInt i,n; 6882 ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr); 6883 ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 6884 for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 6885 ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 6886 ierr = PetscFree(yreal);CHKERRQ(ierr); 6887 } 6888 #else 6889 ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 6890 #endif 6891 ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr); 6892 ierr = VecDestroy(&y);CHKERRQ(ierr); 6893 if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 6894 ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 6895 ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 6896 } 6897 PetscFunctionReturn(0); 6898 } 6899 6900 #undef __FUNCT__ 6901 #define __FUNCT__ "TSMonitorLGSNESIterations" 6902 PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 6903 { 6904 TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 6905 PetscReal x = ptime,y; 6906 PetscErrorCode ierr; 6907 PetscInt its; 6908 6909 PetscFunctionBegin; 6910 if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 6911 if (!n) { 6912 PetscDrawAxis axis; 6913 ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 6914 ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr); 6915 ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 6916 ctx->snes_its = 0; 6917 } 6918 ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr); 6919 y = its - ctx->snes_its; 6920 ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 6921 if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 6922 ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 6923 ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 6924 } 6925 ctx->snes_its = its; 6926 PetscFunctionReturn(0); 6927 } 6928 6929 #undef __FUNCT__ 6930 #define __FUNCT__ "TSMonitorLGKSPIterations" 6931 PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 6932 { 6933 TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 6934 PetscReal x = ptime,y; 6935 PetscErrorCode ierr; 6936 PetscInt its; 6937 6938 PetscFunctionBegin; 6939 if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 6940 if (!n) { 6941 PetscDrawAxis axis; 6942 ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 6943 ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr); 6944 ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 6945 ctx->ksp_its = 0; 6946 } 6947 ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr); 6948 y = its - ctx->ksp_its; 6949 ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 6950 if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 6951 ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 6952 ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 6953 } 6954 ctx->ksp_its = its; 6955 PetscFunctionReturn(0); 6956 } 6957 6958 #undef __FUNCT__ 6959 #define __FUNCT__ "TSComputeLinearStability" 6960 /*@ 6961 TSComputeLinearStability - computes the linear stability function at a point 6962 6963 Collective on TS and Vec 6964 6965 Input Parameters: 6966 + ts - the TS context 6967 - xr,xi - real and imaginary part of input arguments 6968 6969 Output Parameters: 6970 . yr,yi - real and imaginary part of function value 6971 6972 Level: developer 6973 6974 .keywords: TS, compute 6975 6976 .seealso: TSSetRHSFunction(), TSComputeIFunction() 6977 @*/ 6978 PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi) 6979 { 6980 PetscErrorCode ierr; 6981 6982 PetscFunctionBegin; 6983 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6984 if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method"); 6985 ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr); 6986 PetscFunctionReturn(0); 6987 } 6988 6989 /* ------------------------------------------------------------------------*/ 6990 #undef __FUNCT__ 6991 #define __FUNCT__ "TSMonitorEnvelopeCtxCreate" 6992 /*@C 6993 TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope() 6994 6995 Collective on TS 6996 6997 Input Parameters: 6998 . ts - the ODE solver object 6999 7000 Output Parameter: 7001 . ctx - the context 7002 7003 Level: intermediate 7004 7005 .keywords: TS, monitor, line graph, residual, seealso 7006 7007 .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError() 7008 7009 @*/ 7010 PetscErrorCode TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx) 7011 { 7012 PetscErrorCode ierr; 7013 7014 PetscFunctionBegin; 7015 ierr = PetscNew(ctx);CHKERRQ(ierr); 7016 PetscFunctionReturn(0); 7017 } 7018 7019 #undef __FUNCT__ 7020 #define __FUNCT__ "TSMonitorEnvelope" 7021 /*@C 7022 TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution 7023 7024 Collective on TS 7025 7026 Input Parameters: 7027 + ts - the TS context 7028 . step - current time-step 7029 . ptime - current time 7030 . u - current solution 7031 - dctx - the envelope context 7032 7033 Options Database: 7034 . -ts_monitor_envelope 7035 7036 Level: intermediate 7037 7038 Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope 7039 7040 .keywords: TS, vector, monitor, view 7041 7042 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate() 7043 @*/ 7044 PetscErrorCode TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 7045 { 7046 PetscErrorCode ierr; 7047 TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx; 7048 7049 PetscFunctionBegin; 7050 if (!ctx->max) { 7051 ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr); 7052 ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr); 7053 ierr = VecCopy(u,ctx->max);CHKERRQ(ierr); 7054 ierr = VecCopy(u,ctx->min);CHKERRQ(ierr); 7055 } else { 7056 ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr); 7057 ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr); 7058 } 7059 PetscFunctionReturn(0); 7060 } 7061 7062 7063 #undef __FUNCT__ 7064 #define __FUNCT__ "TSMonitorEnvelopeGetBounds" 7065 /*@C 7066 TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution 7067 7068 Collective on TS 7069 7070 Input Parameter: 7071 . ts - the TS context 7072 7073 Output Parameter: 7074 + max - the maximum values 7075 - min - the minimum values 7076 7077 Notes: If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored 7078 7079 Level: intermediate 7080 7081 .keywords: TS, vector, monitor, view 7082 7083 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables() 7084 @*/ 7085 PetscErrorCode TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min) 7086 { 7087 PetscInt i; 7088 7089 PetscFunctionBegin; 7090 if (max) *max = NULL; 7091 if (min) *min = NULL; 7092 for (i=0; i<ts->numbermonitors; i++) { 7093 if (ts->monitor[i] == TSMonitorEnvelope) { 7094 TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i]; 7095 if (max) *max = ctx->max; 7096 if (min) *min = ctx->min; 7097 break; 7098 } 7099 } 7100 PetscFunctionReturn(0); 7101 } 7102 7103 #undef __FUNCT__ 7104 #define __FUNCT__ "TSMonitorEnvelopeCtxDestroy" 7105 /*@C 7106 TSMonitorEnvelopeCtxDestroy - Destroys a context that was created with TSMonitorEnvelopeCtxCreate(). 7107 7108 Collective on TSMonitorEnvelopeCtx 7109 7110 Input Parameter: 7111 . ctx - the monitor context 7112 7113 Level: intermediate 7114 7115 .keywords: TS, monitor, line graph, destroy 7116 7117 .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep() 7118 @*/ 7119 PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx) 7120 { 7121 PetscErrorCode ierr; 7122 7123 PetscFunctionBegin; 7124 ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr); 7125 ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr); 7126 ierr = PetscFree(*ctx);CHKERRQ(ierr); 7127 PetscFunctionReturn(0); 7128 } 7129 7130 #undef __FUNCT__ 7131 #define __FUNCT__ "TSRollBack" 7132 /*@ 7133 TSRollBack - Rolls back one time step 7134 7135 Collective on TS 7136 7137 Input Parameter: 7138 . ts - the TS context obtained from TSCreate() 7139 7140 Level: advanced 7141 7142 .keywords: TS, timestep, rollback 7143 7144 .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate() 7145 @*/ 7146 PetscErrorCode TSRollBack(TS ts) 7147 { 7148 PetscErrorCode ierr; 7149 7150 PetscFunctionBegin; 7151 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7152 if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called"); 7153 if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name); 7154 ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr); 7155 ts->time_step = ts->ptime - ts->ptime_prev; 7156 ts->ptime = ts->ptime_prev; 7157 ts->ptime_prev = ts->ptime_prev_rollback; 7158 ts->steps--; ts->total_steps--; 7159 ts->steprollback = PETSC_TRUE; 7160 PetscFunctionReturn(0); 7161 } 7162 7163 #undef __FUNCT__ 7164 #define __FUNCT__ "TSGetStages" 7165 /*@ 7166 TSGetStages - Get the number of stages and stage values 7167 7168 Input Parameter: 7169 . ts - the TS context obtained from TSCreate() 7170 7171 Level: advanced 7172 7173 .keywords: TS, getstages 7174 7175 .seealso: TSCreate() 7176 @*/ 7177 PetscErrorCode TSGetStages(TS ts,PetscInt *ns,Vec **Y) 7178 { 7179 PetscErrorCode ierr; 7180 7181 PetscFunctionBegin; 7182 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7183 PetscValidPointer(ns,2); 7184 7185 if (!ts->ops->getstages) *ns=0; 7186 else { 7187 ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr); 7188 } 7189 PetscFunctionReturn(0); 7190 } 7191 7192 #undef __FUNCT__ 7193 #define __FUNCT__ "TSComputeIJacobianDefaultColor" 7194 /*@C 7195 TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity. 7196 7197 Collective on SNES 7198 7199 Input Parameters: 7200 + ts - the TS context 7201 . t - current timestep 7202 . U - state vector 7203 . Udot - time derivative of state vector 7204 . shift - shift to apply, see note below 7205 - ctx - an optional user context 7206 7207 Output Parameters: 7208 + J - Jacobian matrix (not altered in this routine) 7209 - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J) 7210 7211 Level: intermediate 7212 7213 Notes: 7214 If F(t,U,Udot)=0 is the DAE, the required Jacobian is 7215 7216 dF/dU + shift*dF/dUdot 7217 7218 Most users should not need to explicitly call this routine, as it 7219 is used internally within the nonlinear solvers. 7220 7221 This will first try to get the coloring from the DM. If the DM type has no coloring 7222 routine, then it will try to get the coloring from the matrix. This requires that the 7223 matrix have nonzero entries precomputed. 7224 7225 .keywords: TS, finite differences, Jacobian, coloring, sparse 7226 .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction() 7227 @*/ 7228 PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx) 7229 { 7230 SNES snes; 7231 MatFDColoring color; 7232 PetscBool hascolor, matcolor = PETSC_FALSE; 7233 PetscErrorCode ierr; 7234 7235 PetscFunctionBegin; 7236 ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr); 7237 ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr); 7238 if (!color) { 7239 DM dm; 7240 ISColoring iscoloring; 7241 7242 ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 7243 ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr); 7244 if (hascolor && !matcolor) { 7245 ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr); 7246 ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 7247 ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 7248 ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 7249 ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 7250 ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 7251 } else { 7252 MatColoring mc; 7253 7254 ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr); 7255 ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr); 7256 ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr); 7257 ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr); 7258 ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr); 7259 ierr = MatColoringDestroy(&mc);CHKERRQ(ierr); 7260 ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 7261 ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 7262 ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 7263 ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 7264 ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 7265 } 7266 ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr); 7267 ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr); 7268 } 7269 ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr); 7270 ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr); 7271 if (J != B) { 7272 ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 7273 ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 7274 } 7275 PetscFunctionReturn(0); 7276 } 7277 7278 #undef __FUNCT__ 7279 #define __FUNCT__ "TSSetFunctionDomainError" 7280 /*@ 7281 TSSetFunctionDomainError - Set the function testing if the current state vector is valid 7282 7283 Input Parameters: 7284 ts - the TS context 7285 func - function called within TSFunctionDomainError 7286 7287 Level: intermediate 7288 7289 .keywords: TS, state, domain 7290 .seealso: TSAdaptCheckStage(), TSFunctionDomainError() 7291 @*/ 7292 7293 PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*)) 7294 { 7295 PetscFunctionBegin; 7296 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7297 ts->functiondomainerror = func; 7298 PetscFunctionReturn(0); 7299 } 7300 7301 #undef __FUNCT__ 7302 #define __FUNCT__ "TSFunctionDomainError" 7303 /*@ 7304 TSFunctionDomainError - Check if the current state is valid 7305 7306 Input Parameters: 7307 ts - the TS context 7308 stagetime - time of the simulation 7309 Y - state vector to check. 7310 7311 Output Parameter: 7312 accept - Set to PETSC_FALSE if the current state vector is valid. 7313 7314 Note: 7315 This function should be used to ensure the state is in a valid part of the space. 7316 For example, one can ensure here all values are positive. 7317 7318 Level: advanced 7319 @*/ 7320 PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept) 7321 { 7322 PetscErrorCode ierr; 7323 7324 PetscFunctionBegin; 7325 7326 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7327 *accept = PETSC_TRUE; 7328 if (ts->functiondomainerror) { 7329 PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept)); 7330 } 7331 PetscFunctionReturn(0); 7332 } 7333 7334 #undef __FUNCT__ 7335 #define __FUNCT__ "TSClone" 7336 /*@C 7337 TSClone - This function clones a time step object. 7338 7339 Collective on MPI_Comm 7340 7341 Input Parameter: 7342 . tsin - The input TS 7343 7344 Output Parameter: 7345 . tsout - The output TS (cloned) 7346 7347 Notes: 7348 This function is used to create a clone of a TS object. It is used in ARKIMEX for initializing the slope for first stage explicit methods. It will likely be replaced in the future with a mechanism of switching methods on the fly. 7349 7350 When using TSDestroy() on a clone the user has to first reset the correct TS reference in the embedded SNES object: e.g.: by running SNES snes_dup=NULL; TSGetSNES(ts,&snes_dup); ierr = TSSetSNES(ts,snes_dup); 7351 7352 Level: developer 7353 7354 .keywords: TS, clone 7355 .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType() 7356 @*/ 7357 PetscErrorCode TSClone(TS tsin, TS *tsout) 7358 { 7359 TS t; 7360 PetscErrorCode ierr; 7361 SNES snes_start; 7362 DM dm; 7363 TSType type; 7364 7365 PetscFunctionBegin; 7366 PetscValidPointer(tsin,1); 7367 *tsout = NULL; 7368 7369 ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr); 7370 7371 /* General TS description */ 7372 t->numbermonitors = 0; 7373 t->setupcalled = 0; 7374 t->ksp_its = 0; 7375 t->snes_its = 0; 7376 t->nwork = 0; 7377 t->rhsjacobian.time = -1e20; 7378 t->rhsjacobian.scale = 1.; 7379 t->ijacobian.shift = 1.; 7380 7381 ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr); 7382 ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr); 7383 7384 ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr); 7385 ierr = TSSetDM(t,dm);CHKERRQ(ierr); 7386 7387 t->adapt = tsin->adapt; 7388 ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr); 7389 7390 t->problem_type = tsin->problem_type; 7391 t->ptime = tsin->ptime; 7392 t->time_step = tsin->time_step; 7393 t->max_time = tsin->max_time; 7394 t->steps = tsin->steps; 7395 t->max_steps = tsin->max_steps; 7396 t->equation_type = tsin->equation_type; 7397 t->atol = tsin->atol; 7398 t->rtol = tsin->rtol; 7399 t->max_snes_failures = tsin->max_snes_failures; 7400 t->max_reject = tsin->max_reject; 7401 t->errorifstepfailed = tsin->errorifstepfailed; 7402 7403 ierr = TSGetType(tsin,&type);CHKERRQ(ierr); 7404 ierr = TSSetType(t,type);CHKERRQ(ierr); 7405 7406 t->vec_sol = NULL; 7407 7408 t->cfltime = tsin->cfltime; 7409 t->cfltime_local = tsin->cfltime_local; 7410 t->exact_final_time = tsin->exact_final_time; 7411 7412 ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr); 7413 7414 if (((PetscObject)tsin)->fortran_func_pointers) { 7415 PetscInt i; 7416 ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr); 7417 for (i=0; i<10; i++) { 7418 ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i]; 7419 } 7420 } 7421 *tsout = t; 7422 PetscFunctionReturn(0); 7423 } 7424