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, TSGL, 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 ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 1922 ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 1923 if (ts->ops->view) { 1924 ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1925 ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1926 ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1927 } 1928 } else if (isstring) { 1929 ierr = TSGetType(ts,&type);CHKERRQ(ierr); 1930 ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr); 1931 } else if (isbinary) { 1932 PetscInt classid = TS_FILE_CLASSID; 1933 MPI_Comm comm; 1934 PetscMPIInt rank; 1935 char type[256]; 1936 1937 ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 1938 ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 1939 if (!rank) { 1940 ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 1941 ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr); 1942 ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 1943 } 1944 if (ts->ops->view) { 1945 ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1946 } 1947 ierr = DMView(ts->dm,viewer);CHKERRQ(ierr); 1948 ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr); 1949 ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 1950 ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 1951 } else if (isdraw) { 1952 PetscDraw draw; 1953 char str[36]; 1954 PetscReal x,y,bottom,h; 1955 1956 ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 1957 ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 1958 ierr = PetscStrcpy(str,"TS: ");CHKERRQ(ierr); 1959 ierr = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr); 1960 ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 1961 bottom = y - h; 1962 ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 1963 if (ts->ops->view) { 1964 ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1965 } 1966 ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 1967 #if defined(PETSC_HAVE_SAWS) 1968 } else if (issaws) { 1969 PetscMPIInt rank; 1970 const char *name; 1971 1972 ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr); 1973 ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 1974 if (!((PetscObject)ts)->amsmem && !rank) { 1975 char dir[1024]; 1976 1977 ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr); 1978 ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr); 1979 PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT)); 1980 ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr); 1981 PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE)); 1982 } 1983 if (ts->ops->view) { 1984 ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1985 } 1986 #endif 1987 } 1988 1989 ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1990 ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr); 1991 ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1992 PetscFunctionReturn(0); 1993 } 1994 1995 1996 #undef __FUNCT__ 1997 #define __FUNCT__ "TSSetApplicationContext" 1998 /*@ 1999 TSSetApplicationContext - Sets an optional user-defined context for 2000 the timesteppers. 2001 2002 Logically Collective on TS 2003 2004 Input Parameters: 2005 + ts - the TS context obtained from TSCreate() 2006 - usrP - optional user context 2007 2008 Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this 2009 function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 2010 2011 Level: intermediate 2012 2013 .keywords: TS, timestep, set, application, context 2014 2015 .seealso: TSGetApplicationContext() 2016 @*/ 2017 PetscErrorCode TSSetApplicationContext(TS ts,void *usrP) 2018 { 2019 PetscFunctionBegin; 2020 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2021 ts->user = usrP; 2022 PetscFunctionReturn(0); 2023 } 2024 2025 #undef __FUNCT__ 2026 #define __FUNCT__ "TSGetApplicationContext" 2027 /*@ 2028 TSGetApplicationContext - Gets the user-defined context for the 2029 timestepper. 2030 2031 Not Collective 2032 2033 Input Parameter: 2034 . ts - the TS context obtained from TSCreate() 2035 2036 Output Parameter: 2037 . usrP - user context 2038 2039 Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this 2040 function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 2041 2042 Level: intermediate 2043 2044 .keywords: TS, timestep, get, application, context 2045 2046 .seealso: TSSetApplicationContext() 2047 @*/ 2048 PetscErrorCode TSGetApplicationContext(TS ts,void *usrP) 2049 { 2050 PetscFunctionBegin; 2051 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2052 *(void**)usrP = ts->user; 2053 PetscFunctionReturn(0); 2054 } 2055 2056 #undef __FUNCT__ 2057 #define __FUNCT__ "TSGetTimeStepNumber" 2058 /*@ 2059 TSGetTimeStepNumber - Gets the number of time steps completed. 2060 2061 Not Collective 2062 2063 Input Parameter: 2064 . ts - the TS context obtained from TSCreate() 2065 2066 Output Parameter: 2067 . iter - number of steps completed so far 2068 2069 Level: intermediate 2070 2071 .keywords: TS, timestep, get, iteration, number 2072 .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep() 2073 @*/ 2074 PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *iter) 2075 { 2076 PetscFunctionBegin; 2077 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2078 PetscValidIntPointer(iter,2); 2079 *iter = ts->steps; 2080 PetscFunctionReturn(0); 2081 } 2082 2083 #undef __FUNCT__ 2084 #define __FUNCT__ "TSSetInitialTimeStep" 2085 /*@ 2086 TSSetInitialTimeStep - Sets the initial timestep to be used, 2087 as well as the initial time. 2088 2089 Logically Collective on TS 2090 2091 Input Parameters: 2092 + ts - the TS context obtained from TSCreate() 2093 . initial_time - the initial time 2094 - time_step - the size of the timestep 2095 2096 Level: intermediate 2097 2098 .seealso: TSSetTimeStep(), TSGetTimeStep() 2099 2100 .keywords: TS, set, initial, timestep 2101 @*/ 2102 PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step) 2103 { 2104 PetscErrorCode ierr; 2105 2106 PetscFunctionBegin; 2107 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2108 ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 2109 ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr); 2110 PetscFunctionReturn(0); 2111 } 2112 2113 #undef __FUNCT__ 2114 #define __FUNCT__ "TSSetTimeStep" 2115 /*@ 2116 TSSetTimeStep - Allows one to reset the timestep at any time, 2117 useful for simple pseudo-timestepping codes. 2118 2119 Logically Collective on TS 2120 2121 Input Parameters: 2122 + ts - the TS context obtained from TSCreate() 2123 - time_step - the size of the timestep 2124 2125 Level: intermediate 2126 2127 .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 2128 2129 .keywords: TS, set, timestep 2130 @*/ 2131 PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step) 2132 { 2133 PetscFunctionBegin; 2134 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2135 PetscValidLogicalCollectiveReal(ts,time_step,2); 2136 ts->time_step = time_step; 2137 PetscFunctionReturn(0); 2138 } 2139 2140 #undef __FUNCT__ 2141 #define __FUNCT__ "TSSetExactFinalTime" 2142 /*@ 2143 TSSetExactFinalTime - Determines whether to adapt the final time step to 2144 match the exact final time, interpolate solution to the exact final time, 2145 or just return at the final time TS computed. 2146 2147 Logically Collective on TS 2148 2149 Input Parameter: 2150 + ts - the time-step context 2151 - eftopt - exact final time option 2152 2153 $ TS_EXACTFINALTIME_STEPOVER - Don't do anything if final time is exceeded 2154 $ TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time 2155 $ TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time 2156 2157 Options Database: 2158 . -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime 2159 2160 Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time 2161 then the final time you selected. 2162 2163 Level: beginner 2164 2165 .seealso: TSExactFinalTimeOption 2166 @*/ 2167 PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt) 2168 { 2169 PetscFunctionBegin; 2170 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2171 PetscValidLogicalCollectiveEnum(ts,eftopt,2); 2172 ts->exact_final_time = eftopt; 2173 PetscFunctionReturn(0); 2174 } 2175 2176 #undef __FUNCT__ 2177 #define __FUNCT__ "TSGetTimeStep" 2178 /*@ 2179 TSGetTimeStep - Gets the current timestep size. 2180 2181 Not Collective 2182 2183 Input Parameter: 2184 . ts - the TS context obtained from TSCreate() 2185 2186 Output Parameter: 2187 . dt - the current timestep size 2188 2189 Level: intermediate 2190 2191 .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 2192 2193 .keywords: TS, get, timestep 2194 @*/ 2195 PetscErrorCode TSGetTimeStep(TS ts,PetscReal *dt) 2196 { 2197 PetscFunctionBegin; 2198 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2199 PetscValidRealPointer(dt,2); 2200 *dt = ts->time_step; 2201 PetscFunctionReturn(0); 2202 } 2203 2204 #undef __FUNCT__ 2205 #define __FUNCT__ "TSGetSolution" 2206 /*@ 2207 TSGetSolution - Returns the solution at the present timestep. It 2208 is valid to call this routine inside the function that you are evaluating 2209 in order to move to the new timestep. This vector not changed until 2210 the solution at the next timestep has been calculated. 2211 2212 Not Collective, but Vec returned is parallel if TS is parallel 2213 2214 Input Parameter: 2215 . ts - the TS context obtained from TSCreate() 2216 2217 Output Parameter: 2218 . v - the vector containing the solution 2219 2220 Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested 2221 final time. It returns the solution at the next timestep. 2222 2223 Level: intermediate 2224 2225 .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime() 2226 2227 .keywords: TS, timestep, get, solution 2228 @*/ 2229 PetscErrorCode TSGetSolution(TS ts,Vec *v) 2230 { 2231 PetscFunctionBegin; 2232 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2233 PetscValidPointer(v,2); 2234 *v = ts->vec_sol; 2235 PetscFunctionReturn(0); 2236 } 2237 2238 #undef __FUNCT__ 2239 #define __FUNCT__ "TSGetCostGradients" 2240 /*@ 2241 TSGetCostGradients - Returns the gradients from the TSAdjointSolve() 2242 2243 Not Collective, but Vec returned is parallel if TS is parallel 2244 2245 Input Parameter: 2246 . ts - the TS context obtained from TSCreate() 2247 2248 Output Parameter: 2249 + lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables 2250 - mu - vectors containing the gradients of the cost functions with respect to the problem parameters 2251 2252 Level: intermediate 2253 2254 .seealso: TSGetTimeStep() 2255 2256 .keywords: TS, timestep, get, sensitivity 2257 @*/ 2258 PetscErrorCode TSGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu) 2259 { 2260 PetscFunctionBegin; 2261 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2262 if (numcost) *numcost = ts->numcost; 2263 if (lambda) *lambda = ts->vecs_sensi; 2264 if (mu) *mu = ts->vecs_sensip; 2265 PetscFunctionReturn(0); 2266 } 2267 2268 /* ----- Routines to initialize and destroy a timestepper ---- */ 2269 #undef __FUNCT__ 2270 #define __FUNCT__ "TSSetProblemType" 2271 /*@ 2272 TSSetProblemType - Sets the type of problem to be solved. 2273 2274 Not collective 2275 2276 Input Parameters: 2277 + ts - The TS 2278 - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 2279 .vb 2280 U_t - A U = 0 (linear) 2281 U_t - A(t) U = 0 (linear) 2282 F(t,U,U_t) = 0 (nonlinear) 2283 .ve 2284 2285 Level: beginner 2286 2287 .keywords: TS, problem type 2288 .seealso: TSSetUp(), TSProblemType, TS 2289 @*/ 2290 PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 2291 { 2292 PetscErrorCode ierr; 2293 2294 PetscFunctionBegin; 2295 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2296 ts->problem_type = type; 2297 if (type == TS_LINEAR) { 2298 SNES snes; 2299 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2300 ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr); 2301 } 2302 PetscFunctionReturn(0); 2303 } 2304 2305 #undef __FUNCT__ 2306 #define __FUNCT__ "TSGetProblemType" 2307 /*@C 2308 TSGetProblemType - Gets the type of problem to be solved. 2309 2310 Not collective 2311 2312 Input Parameter: 2313 . ts - The TS 2314 2315 Output Parameter: 2316 . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 2317 .vb 2318 M U_t = A U 2319 M(t) U_t = A(t) U 2320 F(t,U,U_t) 2321 .ve 2322 2323 Level: beginner 2324 2325 .keywords: TS, problem type 2326 .seealso: TSSetUp(), TSProblemType, TS 2327 @*/ 2328 PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 2329 { 2330 PetscFunctionBegin; 2331 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2332 PetscValidIntPointer(type,2); 2333 *type = ts->problem_type; 2334 PetscFunctionReturn(0); 2335 } 2336 2337 #undef __FUNCT__ 2338 #define __FUNCT__ "TSSetUp" 2339 /*@ 2340 TSSetUp - Sets up the internal data structures for the later use 2341 of a timestepper. 2342 2343 Collective on TS 2344 2345 Input Parameter: 2346 . ts - the TS context obtained from TSCreate() 2347 2348 Notes: 2349 For basic use of the TS solvers the user need not explicitly call 2350 TSSetUp(), since these actions will automatically occur during 2351 the call to TSStep(). However, if one wishes to control this 2352 phase separately, TSSetUp() should be called after TSCreate() 2353 and optional routines of the form TSSetXXX(), but before TSStep(). 2354 2355 Level: advanced 2356 2357 .keywords: TS, timestep, setup 2358 2359 .seealso: TSCreate(), TSStep(), TSDestroy() 2360 @*/ 2361 PetscErrorCode TSSetUp(TS ts) 2362 { 2363 PetscErrorCode ierr; 2364 DM dm; 2365 PetscErrorCode (*func)(SNES,Vec,Vec,void*); 2366 PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*); 2367 TSIFunction ifun; 2368 TSIJacobian ijac; 2369 TSI2Jacobian i2jac; 2370 TSRHSJacobian rhsjac; 2371 2372 PetscFunctionBegin; 2373 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2374 if (ts->setupcalled) PetscFunctionReturn(0); 2375 2376 ts->total_steps = 0; 2377 if (!((PetscObject)ts)->type_name) { 2378 ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr); 2379 ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr); 2380 } 2381 2382 if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first"); 2383 2384 if (ts->rhsjacobian.reuse) { 2385 Mat Amat,Pmat; 2386 SNES snes; 2387 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2388 ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr); 2389 /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would 2390 * have displaced the RHS matrix */ 2391 if (Amat == ts->Arhs) { 2392 ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr); 2393 ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr); 2394 ierr = MatDestroy(&Amat);CHKERRQ(ierr); 2395 } 2396 if (Pmat == ts->Brhs) { 2397 ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr); 2398 ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr); 2399 ierr = MatDestroy(&Pmat);CHKERRQ(ierr); 2400 } 2401 } 2402 if (ts->ops->setup) { 2403 ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr); 2404 } 2405 2406 /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction 2407 to be set right but can't do it elsewhere due to the overreliance on ctx=ts. 2408 */ 2409 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 2410 ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr); 2411 if (!func) { 2412 ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr); 2413 } 2414 /* If the SNES doesn't have a jacobian set and the TS has an ijacobian or rhsjacobian set, set the SNES to use it. 2415 Otherwise, the SNES will use coloring internally to form the Jacobian. 2416 */ 2417 ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr); 2418 ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr); 2419 ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr); 2420 ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr); 2421 if (!jac && (ijac || i2jac || rhsjac)) { 2422 ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr); 2423 } 2424 ts->setupcalled = PETSC_TRUE; 2425 PetscFunctionReturn(0); 2426 } 2427 2428 #undef __FUNCT__ 2429 #define __FUNCT__ "TSAdjointSetUp" 2430 /*@ 2431 TSAdjointSetUp - Sets up the internal data structures for the later use 2432 of an adjoint solver 2433 2434 Collective on TS 2435 2436 Input Parameter: 2437 . ts - the TS context obtained from TSCreate() 2438 2439 Level: advanced 2440 2441 .keywords: TS, timestep, setup 2442 2443 .seealso: TSCreate(), TSAdjointStep(), TSSetCostGradients() 2444 @*/ 2445 PetscErrorCode TSAdjointSetUp(TS ts) 2446 { 2447 PetscErrorCode ierr; 2448 2449 PetscFunctionBegin; 2450 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2451 if (ts->adjointsetupcalled) PetscFunctionReturn(0); 2452 if (!ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetCostGradients() first"); 2453 2454 if (ts->vec_costintegral) { /* if there is integral in the cost function*/ 2455 ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr); 2456 if (ts->vecs_sensip){ 2457 ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr); 2458 } 2459 } 2460 2461 if (ts->ops->adjointsetup) { 2462 ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr); 2463 } 2464 ts->adjointsetupcalled = PETSC_TRUE; 2465 PetscFunctionReturn(0); 2466 } 2467 2468 #undef __FUNCT__ 2469 #define __FUNCT__ "TSReset" 2470 /*@ 2471 TSReset - Resets a TS context and removes any allocated Vecs and Mats. 2472 2473 Collective on TS 2474 2475 Input Parameter: 2476 . ts - the TS context obtained from TSCreate() 2477 2478 Level: beginner 2479 2480 .keywords: TS, timestep, reset 2481 2482 .seealso: TSCreate(), TSSetup(), TSDestroy() 2483 @*/ 2484 PetscErrorCode TSReset(TS ts) 2485 { 2486 PetscErrorCode ierr; 2487 2488 PetscFunctionBegin; 2489 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2490 2491 if (ts->ops->reset) { 2492 ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr); 2493 } 2494 if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);} 2495 if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);} 2496 2497 ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 2498 ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 2499 ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr); 2500 ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 2501 ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr); 2502 ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 2503 ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 2504 ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr); 2505 2506 if (ts->vec_costintegral) { 2507 ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr); 2508 if (ts->vecs_drdp){ 2509 ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr); 2510 } 2511 } 2512 ts->vecs_sensi = NULL; 2513 ts->vecs_sensip = NULL; 2514 ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 2515 ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr); 2516 ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr); 2517 ts->setupcalled = PETSC_FALSE; 2518 PetscFunctionReturn(0); 2519 } 2520 2521 #undef __FUNCT__ 2522 #define __FUNCT__ "TSDestroy" 2523 /*@ 2524 TSDestroy - Destroys the timestepper context that was created 2525 with TSCreate(). 2526 2527 Collective on TS 2528 2529 Input Parameter: 2530 . ts - the TS context obtained from TSCreate() 2531 2532 Level: beginner 2533 2534 .keywords: TS, timestepper, destroy 2535 2536 .seealso: TSCreate(), TSSetUp(), TSSolve() 2537 @*/ 2538 PetscErrorCode TSDestroy(TS *ts) 2539 { 2540 PetscErrorCode ierr; 2541 2542 PetscFunctionBegin; 2543 if (!*ts) PetscFunctionReturn(0); 2544 PetscValidHeaderSpecific((*ts),TS_CLASSID,1); 2545 if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);} 2546 2547 ierr = TSReset((*ts));CHKERRQ(ierr); 2548 2549 /* if memory was published with SAWs then destroy it */ 2550 ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr); 2551 if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);} 2552 2553 ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr); 2554 2555 ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr); 2556 ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr); 2557 2558 ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr); 2559 ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr); 2560 ierr = TSMonitorCancel((*ts));CHKERRQ(ierr); 2561 ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr); 2562 2563 ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr); 2564 PetscFunctionReturn(0); 2565 } 2566 2567 #undef __FUNCT__ 2568 #define __FUNCT__ "TSGetSNES" 2569 /*@ 2570 TSGetSNES - Returns the SNES (nonlinear solver) associated with 2571 a TS (timestepper) context. Valid only for nonlinear problems. 2572 2573 Not Collective, but SNES is parallel if TS is parallel 2574 2575 Input Parameter: 2576 . ts - the TS context obtained from TSCreate() 2577 2578 Output Parameter: 2579 . snes - the nonlinear solver context 2580 2581 Notes: 2582 The user can then directly manipulate the SNES context to set various 2583 options, etc. Likewise, the user can then extract and manipulate the 2584 KSP, KSP, and PC contexts as well. 2585 2586 TSGetSNES() does not work for integrators that do not use SNES; in 2587 this case TSGetSNES() returns NULL in snes. 2588 2589 Level: beginner 2590 2591 .keywords: timestep, get, SNES 2592 @*/ 2593 PetscErrorCode TSGetSNES(TS ts,SNES *snes) 2594 { 2595 PetscErrorCode ierr; 2596 2597 PetscFunctionBegin; 2598 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2599 PetscValidPointer(snes,2); 2600 if (!ts->snes) { 2601 ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr); 2602 ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 2603 ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr); 2604 ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr); 2605 if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 2606 if (ts->problem_type == TS_LINEAR) { 2607 ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); 2608 } 2609 } 2610 *snes = ts->snes; 2611 PetscFunctionReturn(0); 2612 } 2613 2614 #undef __FUNCT__ 2615 #define __FUNCT__ "TSSetSNES" 2616 /*@ 2617 TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context 2618 2619 Collective 2620 2621 Input Parameter: 2622 + ts - the TS context obtained from TSCreate() 2623 - snes - the nonlinear solver context 2624 2625 Notes: 2626 Most users should have the TS created by calling TSGetSNES() 2627 2628 Level: developer 2629 2630 .keywords: timestep, set, SNES 2631 @*/ 2632 PetscErrorCode TSSetSNES(TS ts,SNES snes) 2633 { 2634 PetscErrorCode ierr; 2635 PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*); 2636 2637 PetscFunctionBegin; 2638 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2639 PetscValidHeaderSpecific(snes,SNES_CLASSID,2); 2640 ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr); 2641 ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr); 2642 2643 ts->snes = snes; 2644 2645 ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 2646 ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr); 2647 if (func == SNESTSFormJacobian) { 2648 ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr); 2649 } 2650 PetscFunctionReturn(0); 2651 } 2652 2653 #undef __FUNCT__ 2654 #define __FUNCT__ "TSGetKSP" 2655 /*@ 2656 TSGetKSP - Returns the KSP (linear solver) associated with 2657 a TS (timestepper) context. 2658 2659 Not Collective, but KSP is parallel if TS is parallel 2660 2661 Input Parameter: 2662 . ts - the TS context obtained from TSCreate() 2663 2664 Output Parameter: 2665 . ksp - the nonlinear solver context 2666 2667 Notes: 2668 The user can then directly manipulate the KSP context to set various 2669 options, etc. Likewise, the user can then extract and manipulate the 2670 KSP and PC contexts as well. 2671 2672 TSGetKSP() does not work for integrators that do not use KSP; 2673 in this case TSGetKSP() returns NULL in ksp. 2674 2675 Level: beginner 2676 2677 .keywords: timestep, get, KSP 2678 @*/ 2679 PetscErrorCode TSGetKSP(TS ts,KSP *ksp) 2680 { 2681 PetscErrorCode ierr; 2682 SNES snes; 2683 2684 PetscFunctionBegin; 2685 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2686 PetscValidPointer(ksp,2); 2687 if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first"); 2688 if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()"); 2689 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2690 ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr); 2691 PetscFunctionReturn(0); 2692 } 2693 2694 /* ----------- Routines to set solver parameters ---------- */ 2695 2696 #undef __FUNCT__ 2697 #define __FUNCT__ "TSGetDuration" 2698 /*@ 2699 TSGetDuration - Gets the maximum number of timesteps to use and 2700 maximum time for iteration. 2701 2702 Not Collective 2703 2704 Input Parameters: 2705 + ts - the TS context obtained from TSCreate() 2706 . maxsteps - maximum number of iterations to use, or NULL 2707 - maxtime - final time to iterate to, or NULL 2708 2709 Level: intermediate 2710 2711 .keywords: TS, timestep, get, maximum, iterations, time 2712 @*/ 2713 PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 2714 { 2715 PetscFunctionBegin; 2716 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2717 if (maxsteps) { 2718 PetscValidIntPointer(maxsteps,2); 2719 *maxsteps = ts->max_steps; 2720 } 2721 if (maxtime) { 2722 PetscValidScalarPointer(maxtime,3); 2723 *maxtime = ts->max_time; 2724 } 2725 PetscFunctionReturn(0); 2726 } 2727 2728 #undef __FUNCT__ 2729 #define __FUNCT__ "TSSetDuration" 2730 /*@ 2731 TSSetDuration - Sets the maximum number of timesteps to use and 2732 maximum time for iteration. 2733 2734 Logically Collective on TS 2735 2736 Input Parameters: 2737 + ts - the TS context obtained from TSCreate() 2738 . maxsteps - maximum number of iterations to use 2739 - maxtime - final time to iterate to 2740 2741 Options Database Keys: 2742 . -ts_max_steps <maxsteps> - Sets maxsteps 2743 . -ts_final_time <maxtime> - Sets maxtime 2744 2745 Notes: 2746 The default maximum number of iterations is 5000. Default time is 5.0 2747 2748 Level: intermediate 2749 2750 .keywords: TS, timestep, set, maximum, iterations 2751 2752 .seealso: TSSetExactFinalTime() 2753 @*/ 2754 PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime) 2755 { 2756 PetscFunctionBegin; 2757 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2758 PetscValidLogicalCollectiveInt(ts,maxsteps,2); 2759 PetscValidLogicalCollectiveReal(ts,maxtime,2); 2760 if (maxsteps >= 0) ts->max_steps = maxsteps; 2761 if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime; 2762 PetscFunctionReturn(0); 2763 } 2764 2765 #undef __FUNCT__ 2766 #define __FUNCT__ "TSSetSolution" 2767 /*@ 2768 TSSetSolution - Sets the initial solution vector 2769 for use by the TS routines. 2770 2771 Logically Collective on TS and Vec 2772 2773 Input Parameters: 2774 + ts - the TS context obtained from TSCreate() 2775 - u - the solution vector 2776 2777 Level: beginner 2778 2779 .keywords: TS, timestep, set, solution, initial conditions 2780 @*/ 2781 PetscErrorCode TSSetSolution(TS ts,Vec u) 2782 { 2783 PetscErrorCode ierr; 2784 DM dm; 2785 2786 PetscFunctionBegin; 2787 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2788 PetscValidHeaderSpecific(u,VEC_CLASSID,2); 2789 ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr); 2790 ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 2791 ts->vec_sol = u; 2792 2793 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 2794 ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr); 2795 PetscFunctionReturn(0); 2796 } 2797 2798 #undef __FUNCT__ 2799 #define __FUNCT__ "TSAdjointSetSteps" 2800 /*@ 2801 TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time 2802 2803 Logically Collective on TS 2804 2805 Input Parameters: 2806 + ts - the TS context obtained from TSCreate() 2807 . steps - number of steps to use 2808 2809 Level: intermediate 2810 2811 Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this 2812 so as to integrate back to less than the original timestep 2813 2814 .keywords: TS, timestep, set, maximum, iterations 2815 2816 .seealso: TSSetExactFinalTime() 2817 @*/ 2818 PetscErrorCode TSAdjointSetSteps(TS ts,PetscInt steps) 2819 { 2820 PetscFunctionBegin; 2821 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2822 PetscValidLogicalCollectiveInt(ts,steps,2); 2823 if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps"); 2824 if (steps > ts->total_steps) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back more than the total number of forward steps"); 2825 ts->adjoint_max_steps = steps; 2826 PetscFunctionReturn(0); 2827 } 2828 2829 #undef __FUNCT__ 2830 #define __FUNCT__ "TSSetCostGradients" 2831 /*@ 2832 TSSetCostGradients - Sets the initial value of the gradients of the cost function w.r.t. initial conditions and w.r.t. the problem parameters 2833 for use by the TSAdjoint routines. 2834 2835 Logically Collective on TS and Vec 2836 2837 Input Parameters: 2838 + ts - the TS context obtained from TSCreate() 2839 . 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 2840 - mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters 2841 2842 Level: beginner 2843 2844 Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime mu_i = df/dp|finaltime 2845 2846 .keywords: TS, timestep, set, sensitivity, initial conditions 2847 @*/ 2848 PetscErrorCode TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu) 2849 { 2850 PetscFunctionBegin; 2851 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2852 PetscValidPointer(lambda,2); 2853 ts->vecs_sensi = lambda; 2854 ts->vecs_sensip = mu; 2855 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"); 2856 ts->numcost = numcost; 2857 PetscFunctionReturn(0); 2858 } 2859 2860 #undef __FUNCT__ 2861 #define __FUNCT__ "TSAdjointSetRHSJacobian" 2862 /*@C 2863 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. 2864 2865 Logically Collective on TS 2866 2867 Input Parameters: 2868 + ts - The TS context obtained from TSCreate() 2869 - func - The function 2870 2871 Calling sequence of func: 2872 $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx); 2873 + t - current timestep 2874 . y - input vector (current ODE solution) 2875 . A - output matrix 2876 - ctx - [optional] user-defined function context 2877 2878 Level: intermediate 2879 2880 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 2881 2882 .keywords: TS, sensitivity 2883 .seealso: 2884 @*/ 2885 PetscErrorCode TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx) 2886 { 2887 PetscErrorCode ierr; 2888 2889 PetscFunctionBegin; 2890 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2891 if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 2892 2893 ts->rhsjacobianp = func; 2894 ts->rhsjacobianpctx = ctx; 2895 if(Amat) { 2896 ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 2897 ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 2898 ts->Jacp = Amat; 2899 } 2900 PetscFunctionReturn(0); 2901 } 2902 2903 #undef __FUNCT__ 2904 #define __FUNCT__ "TSAdjointComputeRHSJacobian" 2905 /*@C 2906 TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function. 2907 2908 Collective on TS 2909 2910 Input Parameters: 2911 . ts - The TS context obtained from TSCreate() 2912 2913 Level: developer 2914 2915 .keywords: TS, sensitivity 2916 .seealso: TSAdjointSetRHSJacobian() 2917 @*/ 2918 PetscErrorCode TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat) 2919 { 2920 PetscErrorCode ierr; 2921 2922 PetscFunctionBegin; 2923 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2924 PetscValidHeaderSpecific(X,VEC_CLASSID,3); 2925 PetscValidPointer(Amat,4); 2926 2927 PetscStackPush("TS user JacobianP function for sensitivity analysis"); 2928 ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr); 2929 PetscStackPop; 2930 PetscFunctionReturn(0); 2931 } 2932 2933 #undef __FUNCT__ 2934 #define __FUNCT__ "TSSetCostIntegrand" 2935 /*@C 2936 TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions 2937 2938 Logically Collective on TS 2939 2940 Input Parameters: 2941 + ts - the TS context obtained from TSCreate() 2942 . numcost - number of gradients to be computed, this is the number of cost functions 2943 . rf - routine for evaluating the integrand function 2944 . drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y 2945 . drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p 2946 . fwd － flag indicating whether to evaluate cost integral in the forward run or the adjoint run 2947 - ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL) 2948 2949 Calling sequence of rf: 2950 $ rf(TS ts,PetscReal t,Vec y,Vec f[],void *ctx); 2951 2952 + t - current timestep 2953 . y - input vector 2954 . f - function result; one vector entry for each cost function 2955 - ctx - [optional] user-defined function context 2956 2957 Calling sequence of drdyf: 2958 $ PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx); 2959 2960 Calling sequence of drdpf: 2961 $ PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx); 2962 2963 Level: intermediate 2964 2965 Notes: For optimization there is generally a single cost function, numcost = 1. For sensitivities there may be multiple cost functions 2966 2967 .keywords: TS, sensitivity analysis, timestep, set, quadrature, function 2968 2969 .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients() 2970 @*/ 2971 PetscErrorCode TSSetCostIntegrand(TS ts,PetscInt numcost,PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*), 2972 PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*), 2973 PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*), 2974 PetscBool fwd,void *ctx) 2975 { 2976 PetscErrorCode ierr; 2977 2978 PetscFunctionBegin; 2979 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2980 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()"); 2981 if (!ts->numcost) ts->numcost=numcost; 2982 2983 ts->costintegralfwd = fwd; /* Evaluate the cost integral in forward run if fwd is true */ 2984 ierr = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr); 2985 ierr = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr); 2986 ts->costintegrand = rf; 2987 ts->costintegrandctx = ctx; 2988 ts->drdyfunction = drdyf; 2989 ts->drdpfunction = drdpf; 2990 PetscFunctionReturn(0); 2991 } 2992 2993 #undef __FUNCT__ 2994 #define __FUNCT__ "TSGetCostIntegral" 2995 /*@ 2996 TSGetCostIntegral - Returns the values of the integral term in the cost functions. 2997 It is valid to call the routine after a backward run. 2998 2999 Not Collective 3000 3001 Input Parameter: 3002 . ts - the TS context obtained from TSCreate() 3003 3004 Output Parameter: 3005 . v - the vector containing the integrals for each cost function 3006 3007 Level: intermediate 3008 3009 .seealso: TSSetCostIntegrand() 3010 3011 .keywords: TS, sensitivity analysis 3012 @*/ 3013 PetscErrorCode TSGetCostIntegral(TS ts,Vec *v) 3014 { 3015 PetscFunctionBegin; 3016 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3017 PetscValidPointer(v,2); 3018 *v = ts->vec_costintegral; 3019 PetscFunctionReturn(0); 3020 } 3021 3022 #undef __FUNCT__ 3023 #define __FUNCT__ "TSAdjointComputeCostIntegrand" 3024 /*@ 3025 TSAdjointComputeCostIntegrand - Evaluates the integral function in the cost functions. 3026 3027 Input Parameters: 3028 + ts - the TS context 3029 . t - current time 3030 - y - state vector, i.e. current solution 3031 3032 Output Parameter: 3033 . q - vector of size numcost to hold the outputs 3034 3035 Note: 3036 Most users should not need to explicitly call this routine, as it 3037 is used internally within the sensitivity analysis context. 3038 3039 Level: developer 3040 3041 .keywords: TS, compute 3042 3043 .seealso: TSSetCostIntegrand() 3044 @*/ 3045 PetscErrorCode TSAdjointComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q) 3046 { 3047 PetscErrorCode ierr; 3048 3049 PetscFunctionBegin; 3050 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3051 PetscValidHeaderSpecific(y,VEC_CLASSID,3); 3052 PetscValidHeaderSpecific(q,VEC_CLASSID,4); 3053 3054 ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr); 3055 if (ts->costintegrand) { 3056 PetscStackPush("TS user integrand in the cost function"); 3057 ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr); 3058 PetscStackPop; 3059 } else { 3060 ierr = VecZeroEntries(q);CHKERRQ(ierr); 3061 } 3062 3063 ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr); 3064 PetscFunctionReturn(0); 3065 } 3066 3067 #undef __FUNCT__ 3068 #define __FUNCT__ "TSAdjointComputeDRDYFunction" 3069 /*@ 3070 TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function. 3071 3072 Collective on TS 3073 3074 Input Parameters: 3075 . ts - The TS context obtained from TSCreate() 3076 3077 Notes: 3078 TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation, 3079 so most users would not generally call this routine themselves. 3080 3081 Level: developer 3082 3083 .keywords: TS, sensitivity 3084 .seealso: TSAdjointComputeDRDYFunction() 3085 @*/ 3086 PetscErrorCode TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy) 3087 { 3088 PetscErrorCode ierr; 3089 3090 PetscFunctionBegin; 3091 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3092 PetscValidHeaderSpecific(y,VEC_CLASSID,3); 3093 3094 PetscStackPush("TS user DRDY function for sensitivity analysis"); 3095 ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr); 3096 PetscStackPop; 3097 PetscFunctionReturn(0); 3098 } 3099 3100 #undef __FUNCT__ 3101 #define __FUNCT__ "TSAdjointComputeDRDPFunction" 3102 /*@ 3103 TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function. 3104 3105 Collective on TS 3106 3107 Input Parameters: 3108 . ts - The TS context obtained from TSCreate() 3109 3110 Notes: 3111 TSDRDPFunction() is typically used for sensitivity implementation, 3112 so most users would not generally call this routine themselves. 3113 3114 Level: developer 3115 3116 .keywords: TS, sensitivity 3117 .seealso: TSAdjointSetDRDPFunction() 3118 @*/ 3119 PetscErrorCode TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp) 3120 { 3121 PetscErrorCode ierr; 3122 3123 PetscFunctionBegin; 3124 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3125 PetscValidHeaderSpecific(y,VEC_CLASSID,3); 3126 3127 PetscStackPush("TS user DRDP function for sensitivity analysis"); 3128 ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr); 3129 PetscStackPop; 3130 PetscFunctionReturn(0); 3131 } 3132 3133 #undef __FUNCT__ 3134 #define __FUNCT__ "TSSetPreStep" 3135 /*@C 3136 TSSetPreStep - Sets the general-purpose function 3137 called once at the beginning of each time step. 3138 3139 Logically Collective on TS 3140 3141 Input Parameters: 3142 + ts - The TS context obtained from TSCreate() 3143 - func - The function 3144 3145 Calling sequence of func: 3146 . func (TS ts); 3147 3148 Level: intermediate 3149 3150 Note: 3151 If a step is rejected, TSStep() will call this routine again before each attempt. 3152 The last completed time step number can be queried using TSGetTimeStepNumber(), the 3153 size of the step being attempted can be obtained using TSGetTimeStep(). 3154 3155 .keywords: TS, timestep 3156 .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep() 3157 @*/ 3158 PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS)) 3159 { 3160 PetscFunctionBegin; 3161 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3162 ts->prestep = func; 3163 PetscFunctionReturn(0); 3164 } 3165 3166 #undef __FUNCT__ 3167 #define __FUNCT__ "TSPreStep" 3168 /*@ 3169 TSPreStep - Runs the user-defined pre-step function. 3170 3171 Collective on TS 3172 3173 Input Parameters: 3174 . ts - The TS context obtained from TSCreate() 3175 3176 Notes: 3177 TSPreStep() is typically used within time stepping implementations, 3178 so most users would not generally call this routine themselves. 3179 3180 Level: developer 3181 3182 .keywords: TS, timestep 3183 .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep() 3184 @*/ 3185 PetscErrorCode TSPreStep(TS ts) 3186 { 3187 PetscErrorCode ierr; 3188 3189 PetscFunctionBegin; 3190 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3191 if (ts->prestep) { 3192 PetscStackCallStandard((*ts->prestep),(ts)); 3193 } 3194 PetscFunctionReturn(0); 3195 } 3196 3197 #undef __FUNCT__ 3198 #define __FUNCT__ "TSSetPreStage" 3199 /*@C 3200 TSSetPreStage - Sets the general-purpose function 3201 called once at the beginning of each stage. 3202 3203 Logically Collective on TS 3204 3205 Input Parameters: 3206 + ts - The TS context obtained from TSCreate() 3207 - func - The function 3208 3209 Calling sequence of func: 3210 . PetscErrorCode func(TS ts, PetscReal stagetime); 3211 3212 Level: intermediate 3213 3214 Note: 3215 There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 3216 The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 3217 attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 3218 3219 .keywords: TS, timestep 3220 .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3221 @*/ 3222 PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal)) 3223 { 3224 PetscFunctionBegin; 3225 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3226 ts->prestage = func; 3227 PetscFunctionReturn(0); 3228 } 3229 3230 #undef __FUNCT__ 3231 #define __FUNCT__ "TSSetPostStage" 3232 /*@C 3233 TSSetPostStage - Sets the general-purpose function 3234 called once at the end of each stage. 3235 3236 Logically Collective on TS 3237 3238 Input Parameters: 3239 + ts - The TS context obtained from TSCreate() 3240 - func - The function 3241 3242 Calling sequence of func: 3243 . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y); 3244 3245 Level: intermediate 3246 3247 Note: 3248 There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 3249 The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 3250 attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 3251 3252 .keywords: TS, timestep 3253 .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3254 @*/ 3255 PetscErrorCode TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*)) 3256 { 3257 PetscFunctionBegin; 3258 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3259 ts->poststage = func; 3260 PetscFunctionReturn(0); 3261 } 3262 3263 #undef __FUNCT__ 3264 #define __FUNCT__ "TSPreStage" 3265 /*@ 3266 TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage() 3267 3268 Collective on TS 3269 3270 Input Parameters: 3271 . ts - The TS context obtained from TSCreate() 3272 stagetime - The absolute time of the current stage 3273 3274 Notes: 3275 TSPreStage() is typically used within time stepping implementations, 3276 most users would not generally call this routine themselves. 3277 3278 Level: developer 3279 3280 .keywords: TS, timestep 3281 .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 3282 @*/ 3283 PetscErrorCode TSPreStage(TS ts, PetscReal stagetime) 3284 { 3285 PetscErrorCode ierr; 3286 3287 PetscFunctionBegin; 3288 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3289 if (ts->prestage) { 3290 PetscStackCallStandard((*ts->prestage),(ts,stagetime)); 3291 } 3292 PetscFunctionReturn(0); 3293 } 3294 3295 #undef __FUNCT__ 3296 #define __FUNCT__ "TSPostStage" 3297 /*@ 3298 TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage() 3299 3300 Collective on TS 3301 3302 Input Parameters: 3303 . ts - The TS context obtained from TSCreate() 3304 stagetime - The absolute time of the current stage 3305 stageindex - Stage number 3306 Y - Array of vectors (of size = total number 3307 of stages) with the stage solutions 3308 3309 Notes: 3310 TSPostStage() is typically used within time stepping implementations, 3311 most users would not generally call this routine themselves. 3312 3313 Level: developer 3314 3315 .keywords: TS, timestep 3316 .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 3317 @*/ 3318 PetscErrorCode TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y) 3319 { 3320 PetscErrorCode ierr; 3321 3322 PetscFunctionBegin; 3323 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3324 if (ts->poststage) { 3325 PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y)); 3326 } 3327 PetscFunctionReturn(0); 3328 } 3329 3330 #undef __FUNCT__ 3331 #define __FUNCT__ "TSSetPostStep" 3332 /*@C 3333 TSSetPostStep - Sets the general-purpose function 3334 called once at the end of each time step. 3335 3336 Logically Collective on TS 3337 3338 Input Parameters: 3339 + ts - The TS context obtained from TSCreate() 3340 - func - The function 3341 3342 Calling sequence of func: 3343 $ func (TS ts); 3344 3345 Level: intermediate 3346 3347 .keywords: TS, timestep 3348 .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime() 3349 @*/ 3350 PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS)) 3351 { 3352 PetscFunctionBegin; 3353 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3354 ts->poststep = func; 3355 PetscFunctionReturn(0); 3356 } 3357 3358 #undef __FUNCT__ 3359 #define __FUNCT__ "TSPostStep" 3360 /*@ 3361 TSPostStep - Runs the user-defined post-step function. 3362 3363 Collective on TS 3364 3365 Input Parameters: 3366 . ts - The TS context obtained from TSCreate() 3367 3368 Notes: 3369 TSPostStep() is typically used within time stepping implementations, 3370 so most users would not generally call this routine themselves. 3371 3372 Level: developer 3373 3374 .keywords: TS, timestep 3375 @*/ 3376 PetscErrorCode TSPostStep(TS ts) 3377 { 3378 PetscErrorCode ierr; 3379 3380 PetscFunctionBegin; 3381 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3382 if (ts->poststep) { 3383 PetscStackCallStandard((*ts->poststep),(ts)); 3384 } 3385 PetscFunctionReturn(0); 3386 } 3387 3388 /* ------------ Routines to set performance monitoring options ----------- */ 3389 3390 #undef __FUNCT__ 3391 #define __FUNCT__ "TSMonitorSet" 3392 /*@C 3393 TSMonitorSet - Sets an ADDITIONAL function that is to be used at every 3394 timestep to display the iteration's progress. 3395 3396 Logically Collective on TS 3397 3398 Input Parameters: 3399 + ts - the TS context obtained from TSCreate() 3400 . monitor - monitoring routine 3401 . mctx - [optional] user-defined context for private data for the 3402 monitor routine (use NULL if no context is desired) 3403 - monitordestroy - [optional] routine that frees monitor context 3404 (may be NULL) 3405 3406 Calling sequence of monitor: 3407 $ int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx) 3408 3409 + ts - the TS context 3410 . 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) 3411 . time - current time 3412 . u - current iterate 3413 - mctx - [optional] monitoring context 3414 3415 Notes: 3416 This routine adds an additional monitor to the list of monitors that 3417 already has been loaded. 3418 3419 Fortran notes: Only a single monitor function can be set for each TS object 3420 3421 Level: intermediate 3422 3423 .keywords: TS, timestep, set, monitor 3424 3425 .seealso: TSMonitorDefault(), TSMonitorCancel() 3426 @*/ 3427 PetscErrorCode TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**)) 3428 { 3429 PetscErrorCode ierr; 3430 PetscInt i; 3431 PetscBool identical; 3432 3433 PetscFunctionBegin; 3434 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3435 for (i=0; i<ts->numbermonitors;i++) { 3436 ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr); 3437 if (identical) PetscFunctionReturn(0); 3438 } 3439 if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 3440 ts->monitor[ts->numbermonitors] = monitor; 3441 ts->monitordestroy[ts->numbermonitors] = mdestroy; 3442 ts->monitorcontext[ts->numbermonitors++] = (void*)mctx; 3443 PetscFunctionReturn(0); 3444 } 3445 3446 #undef __FUNCT__ 3447 #define __FUNCT__ "TSMonitorCancel" 3448 /*@C 3449 TSMonitorCancel - Clears all the monitors that have been set on a time-step object. 3450 3451 Logically Collective on TS 3452 3453 Input Parameters: 3454 . ts - the TS context obtained from TSCreate() 3455 3456 Notes: 3457 There is no way to remove a single, specific monitor. 3458 3459 Level: intermediate 3460 3461 .keywords: TS, timestep, set, monitor 3462 3463 .seealso: TSMonitorDefault(), TSMonitorSet() 3464 @*/ 3465 PetscErrorCode TSMonitorCancel(TS ts) 3466 { 3467 PetscErrorCode ierr; 3468 PetscInt i; 3469 3470 PetscFunctionBegin; 3471 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3472 for (i=0; i<ts->numbermonitors; i++) { 3473 if (ts->monitordestroy[i]) { 3474 ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr); 3475 } 3476 } 3477 ts->numbermonitors = 0; 3478 PetscFunctionReturn(0); 3479 } 3480 3481 #undef __FUNCT__ 3482 #define __FUNCT__ "TSMonitorDefault" 3483 /*@C 3484 TSMonitorDefault - The Default monitor, prints the timestep and time for each step 3485 3486 Level: intermediate 3487 3488 .keywords: TS, set, monitor 3489 3490 .seealso: TSMonitorSet() 3491 @*/ 3492 PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf) 3493 { 3494 PetscErrorCode ierr; 3495 PetscViewer viewer = vf->viewer; 3496 PetscBool iascii,ibinary; 3497 3498 PetscFunctionBegin; 3499 PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4); 3500 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 3501 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr); 3502 ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr); 3503 if (iascii) { 3504 ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3505 if (step == -1){ /* this indicates it is an interpolated solution */ 3506 ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr); 3507 } else { 3508 ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)\n" : "\n");CHKERRQ(ierr); 3509 } 3510 ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3511 } else if (ibinary) { 3512 PetscMPIInt rank; 3513 ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr); 3514 if (!rank) { 3515 ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr); 3516 } else { 3517 ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr); 3518 } 3519 } 3520 ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3521 PetscFunctionReturn(0); 3522 } 3523 3524 #undef __FUNCT__ 3525 #define __FUNCT__ "TSAdjointMonitorSet" 3526 /*@C 3527 TSAdjointMonitorSet - Sets an ADDITIONAL function that is to be used at every 3528 timestep to display the iteration's progress. 3529 3530 Logically Collective on TS 3531 3532 Input Parameters: 3533 + ts - the TS context obtained from TSCreate() 3534 . adjointmonitor - monitoring routine 3535 . adjointmctx - [optional] user-defined context for private data for the 3536 monitor routine (use NULL if no context is desired) 3537 - adjointmonitordestroy - [optional] routine that frees monitor context 3538 (may be NULL) 3539 3540 Calling sequence of monitor: 3541 $ int adjointmonitor(TS ts,PetscInt steps,PetscReal time,Vec u,PetscInt numcost,Vec *lambda, Vec *mu,void *adjointmctx) 3542 3543 + ts - the TS context 3544 . 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 3545 been interpolated to) 3546 . time - current time 3547 . u - current iterate 3548 . numcost - number of cost functionos 3549 . lambda - sensitivities to initial conditions 3550 . mu - sensitivities to parameters 3551 - adjointmctx - [optional] adjoint monitoring context 3552 3553 Notes: 3554 This routine adds an additional monitor to the list of monitors that 3555 already has been loaded. 3556 3557 Fortran notes: Only a single monitor function can be set for each TS object 3558 3559 Level: intermediate 3560 3561 .keywords: TS, timestep, set, adjoint, monitor 3562 3563 .seealso: TSAdjointMonitorCancel() 3564 @*/ 3565 PetscErrorCode TSAdjointMonitorSet(TS ts,PetscErrorCode (*adjointmonitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *adjointmctx,PetscErrorCode (*adjointmdestroy)(void**)) 3566 { 3567 PetscErrorCode ierr; 3568 PetscInt i; 3569 PetscBool identical; 3570 3571 PetscFunctionBegin; 3572 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3573 for (i=0; i<ts->numbermonitors;i++) { 3574 ierr = PetscMonitorCompare((PetscErrorCode (*)(void))adjointmonitor,adjointmctx,adjointmdestroy,(PetscErrorCode (*)(void))ts->adjointmonitor[i],ts->adjointmonitorcontext[i],ts->adjointmonitordestroy[i],&identical);CHKERRQ(ierr); 3575 if (identical) PetscFunctionReturn(0); 3576 } 3577 if (ts->numberadjointmonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many adjoint monitors set"); 3578 ts->adjointmonitor[ts->numberadjointmonitors] = adjointmonitor; 3579 ts->adjointmonitordestroy[ts->numberadjointmonitors] = adjointmdestroy; 3580 ts->adjointmonitorcontext[ts->numberadjointmonitors++] = (void*)adjointmctx; 3581 PetscFunctionReturn(0); 3582 } 3583 3584 #undef __FUNCT__ 3585 #define __FUNCT__ "TSAdjointMonitorCancel" 3586 /*@C 3587 TSAdjointMonitorCancel - Clears all the adjoint monitors that have been set on a time-step object. 3588 3589 Logically Collective on TS 3590 3591 Input Parameters: 3592 . ts - the TS context obtained from TSCreate() 3593 3594 Notes: 3595 There is no way to remove a single, specific monitor. 3596 3597 Level: intermediate 3598 3599 .keywords: TS, timestep, set, adjoint, monitor 3600 3601 .seealso: TSAdjointMonitorSet() 3602 @*/ 3603 PetscErrorCode TSAdjointMonitorCancel(TS ts) 3604 { 3605 PetscErrorCode ierr; 3606 PetscInt i; 3607 3608 PetscFunctionBegin; 3609 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3610 for (i=0; i<ts->numberadjointmonitors; i++) { 3611 if (ts->adjointmonitordestroy[i]) { 3612 ierr = (*ts->adjointmonitordestroy[i])(&ts->adjointmonitorcontext[i]);CHKERRQ(ierr); 3613 } 3614 } 3615 ts->numberadjointmonitors = 0; 3616 PetscFunctionReturn(0); 3617 } 3618 3619 #undef __FUNCT__ 3620 #define __FUNCT__ "TSAdjointMonitorDefault" 3621 /*@C 3622 TSAdjointMonitorDefault - the default monitor of adjoint computations 3623 3624 Level: intermediate 3625 3626 .keywords: TS, set, monitor 3627 3628 .seealso: TSAdjointMonitorSet() 3629 @*/ 3630 PetscErrorCode TSAdjointMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,PetscViewerAndFormat *vf) 3631 { 3632 PetscErrorCode ierr; 3633 PetscViewer viewer = vf->viewer; 3634 3635 PetscFunctionBegin; 3636 PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4); 3637 ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr); 3638 ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3639 ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)\n" : "\n");CHKERRQ(ierr); 3640 ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3641 ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3642 PetscFunctionReturn(0); 3643 } 3644 3645 #undef __FUNCT__ 3646 #define __FUNCT__ "TSInterpolate" 3647 /*@ 3648 TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval 3649 3650 Collective on TS 3651 3652 Input Argument: 3653 + ts - time stepping context 3654 - t - time to interpolate to 3655 3656 Output Argument: 3657 . U - state at given time 3658 3659 Level: intermediate 3660 3661 Developer Notes: 3662 TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints. 3663 3664 .keywords: TS, set 3665 3666 .seealso: TSSetExactFinalTime(), TSSolve() 3667 @*/ 3668 PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U) 3669 { 3670 PetscErrorCode ierr; 3671 3672 PetscFunctionBegin; 3673 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3674 PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3675 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); 3676 if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name); 3677 ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr); 3678 PetscFunctionReturn(0); 3679 } 3680 3681 #undef __FUNCT__ 3682 #define __FUNCT__ "TSStep" 3683 /*@ 3684 TSStep - Steps one time step 3685 3686 Collective on TS 3687 3688 Input Parameter: 3689 . ts - the TS context obtained from TSCreate() 3690 3691 Level: developer 3692 3693 Notes: 3694 The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine. 3695 3696 The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may 3697 be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages. 3698 3699 This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the 3700 time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep. 3701 3702 .keywords: TS, timestep, solve 3703 3704 .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate() 3705 @*/ 3706 PetscErrorCode TSStep(TS ts) 3707 { 3708 PetscErrorCode ierr; 3709 static PetscBool cite = PETSC_FALSE; 3710 PetscReal ptime; 3711 3712 PetscFunctionBegin; 3713 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3714 ierr = PetscCitationsRegister("@techreport{tspaper,\n" 3715 " title = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n" 3716 " author = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n" 3717 " type = {Preprint},\n" 3718 " number = {ANL/MCS-P5061-0114},\n" 3719 " institution = {Argonne National Laboratory},\n" 3720 " year = {2014}\n}\n",&cite);CHKERRQ(ierr); 3721 3722 ierr = TSSetUp(ts);CHKERRQ(ierr); 3723 ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr); 3724 3725 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()"); 3726 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"); 3727 3728 if (!ts->steps) ts->ptime_prev = ts->ptime; 3729 ts->reason = TS_CONVERGED_ITERATING; 3730 ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev; 3731 if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name); 3732 ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3733 ierr = (*ts->ops->step)(ts);CHKERRQ(ierr); 3734 ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3735 ts->ptime_prev = ptime; 3736 ts->steps++; ts->total_steps++; 3737 ts->steprollback = PETSC_FALSE; 3738 ts->steprestart = PETSC_FALSE; 3739 3740 if (ts->reason < 0) { 3741 if (ts->errorifstepfailed) { 3742 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]); 3743 else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 3744 } 3745 } else if (!ts->reason) { 3746 if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 3747 else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 3748 } 3749 PetscFunctionReturn(0); 3750 } 3751 3752 #undef __FUNCT__ 3753 #define __FUNCT__ "TSAdjointStep" 3754 /*@ 3755 TSAdjointStep - Steps one time step backward in the adjoint run 3756 3757 Collective on TS 3758 3759 Input Parameter: 3760 . ts - the TS context obtained from TSCreate() 3761 3762 Level: intermediate 3763 3764 .keywords: TS, adjoint, step 3765 3766 .seealso: TSAdjointSetUp(), TSAdjointSolve() 3767 @*/ 3768 PetscErrorCode TSAdjointStep(TS ts) 3769 { 3770 DM dm; 3771 PetscErrorCode ierr; 3772 3773 PetscFunctionBegin; 3774 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3775 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 3776 ierr = TSAdjointSetUp(ts);CHKERRQ(ierr); 3777 3778 ierr = VecViewFromOptions(ts->vec_sol,(PetscObject)ts,"-ts_view_solution");CHKERRQ(ierr); 3779 3780 ts->reason = TS_CONVERGED_ITERATING; 3781 ts->ptime_prev = ts->ptime; 3782 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); 3783 ierr = PetscLogEventBegin(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr); 3784 ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr); 3785 ierr = PetscLogEventEnd(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr); 3786 ts->steps++; ts->total_steps--; 3787 3788 if (ts->reason < 0) { 3789 if (ts->errorifstepfailed) { 3790 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]); 3791 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]); 3792 else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 3793 } 3794 } else if (!ts->reason) { 3795 if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS; 3796 } 3797 PetscFunctionReturn(0); 3798 } 3799 3800 #undef __FUNCT__ 3801 #define __FUNCT__ "TSEvaluateWLTE" 3802 /*@ 3803 TSEvaluateWLTE - Evaluate the weighted local truncation error norm 3804 at the end of a time step with a given order of accuracy. 3805 3806 Collective on TS 3807 3808 Input Arguments: 3809 + ts - time stepping context 3810 . wnormtype - norm type, either NORM_2 or NORM_INFINITY 3811 - order - optional, desired order for the error evaluation or PETSC_DECIDE 3812 3813 Output Arguments: 3814 + order - optional, the actual order of the error evaluation 3815 - wlte - the weighted local truncation error norm 3816 3817 Level: advanced 3818 3819 Notes: 3820 If the timestepper cannot evaluate the error in a particular step 3821 (eg. in the first step or restart steps after event handling), 3822 this routine returns wlte=-1.0 . 3823 3824 .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm() 3825 @*/ 3826 PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte) 3827 { 3828 PetscErrorCode ierr; 3829 3830 PetscFunctionBegin; 3831 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3832 PetscValidType(ts,1); 3833 PetscValidLogicalCollectiveEnum(ts,wnormtype,4); 3834 if (order) PetscValidIntPointer(order,3); 3835 if (order) PetscValidLogicalCollectiveInt(ts,*order,3); 3836 PetscValidRealPointer(wlte,4); 3837 if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 3838 if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name); 3839 ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr); 3840 PetscFunctionReturn(0); 3841 } 3842 3843 #undef __FUNCT__ 3844 #define __FUNCT__ "TSEvaluateStep" 3845 /*@ 3846 TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy. 3847 3848 Collective on TS 3849 3850 Input Arguments: 3851 + ts - time stepping context 3852 . order - desired order of accuracy 3853 - done - whether the step was evaluated at this order (pass NULL to generate an error if not available) 3854 3855 Output Arguments: 3856 . U - state at the end of the current step 3857 3858 Level: advanced 3859 3860 Notes: 3861 This function cannot be called until all stages have been evaluated. 3862 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. 3863 3864 .seealso: TSStep(), TSAdapt 3865 @*/ 3866 PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done) 3867 { 3868 PetscErrorCode ierr; 3869 3870 PetscFunctionBegin; 3871 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3872 PetscValidType(ts,1); 3873 PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3874 if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name); 3875 ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr); 3876 PetscFunctionReturn(0); 3877 } 3878 3879 #undef __FUNCT__ 3880 #define __FUNCT__ "TSForwardCostIntegral" 3881 /*@ 3882 TSForwardCostIntegral - Evaluate the cost integral in the forward run. 3883 3884 Collective on TS 3885 3886 Input Arguments: 3887 . ts - time stepping context 3888 3889 Level: advanced 3890 3891 Notes: 3892 This function cannot be called until TSStep() has been completed. 3893 3894 .seealso: TSSolve(), TSAdjointCostIntegral() 3895 @*/ 3896 PetscErrorCode TSForwardCostIntegral(TS ts) 3897 { 3898 PetscErrorCode ierr; 3899 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3900 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); 3901 ierr = (*ts->ops->forwardintegral)(ts);CHKERRQ(ierr); 3902 PetscFunctionReturn(0); 3903 } 3904 3905 #undef __FUNCT__ 3906 #define __FUNCT__ "TSSolve" 3907 /*@ 3908 TSSolve - Steps the requested number of timesteps. 3909 3910 Collective on TS 3911 3912 Input Parameter: 3913 + ts - the TS context obtained from TSCreate() 3914 - u - the solution vector (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used, 3915 otherwise must contain the initial conditions and will contain the solution at the final requested time 3916 3917 Level: beginner 3918 3919 Notes: 3920 The final time returned by this function may be different from the time of the internally 3921 held state accessible by TSGetSolution() and TSGetTime() because the method may have 3922 stepped over the final time. 3923 3924 .keywords: TS, timestep, solve 3925 3926 .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime() 3927 @*/ 3928 PetscErrorCode TSSolve(TS ts,Vec u) 3929 { 3930 Vec solution; 3931 PetscErrorCode ierr; 3932 3933 PetscFunctionBegin; 3934 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3935 if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2); 3936 3937 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 */ 3938 PetscValidHeaderSpecific(u,VEC_CLASSID,2); 3939 if (!ts->vec_sol || u == ts->vec_sol) { 3940 ierr = VecDuplicate(u,&solution);CHKERRQ(ierr); 3941 ierr = TSSetSolution(ts,solution);CHKERRQ(ierr); 3942 ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */ 3943 } 3944 ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr); 3945 } else if (u) { 3946 ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 3947 } 3948 ierr = TSSetUp(ts);CHKERRQ(ierr); 3949 ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr); 3950 3951 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()"); 3952 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"); 3953 3954 /* reset time step and iteration counters */ 3955 ts->steps = 0; 3956 ts->ksp_its = 0; 3957 ts->snes_its = 0; 3958 ts->num_snes_failures = 0; 3959 ts->reject = 0; 3960 ts->reason = TS_CONVERGED_ITERATING; 3961 3962 ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr); 3963 3964 if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 3965 ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr); 3966 if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 3967 ts->solvetime = ts->ptime; 3968 solution = ts->vec_sol; 3969 } else { /* Step the requested number of timesteps. */ 3970 if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 3971 else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 3972 ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 3973 ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 3974 ts->steprollback = PETSC_FALSE; 3975 ts->steprestart = PETSC_TRUE; 3976 3977 while (!ts->reason) { 3978 ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 3979 if (!ts->steprollback) { 3980 ierr = TSPreStep(ts);CHKERRQ(ierr); 3981 } 3982 ierr = TSStep(ts);CHKERRQ(ierr); 3983 if (ts->vec_costintegral && ts->costintegralfwd) { /* Must evaluate the cost integral before event is handled. The cost integral value can also be rolled back. */ 3984 ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr); 3985 } 3986 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. */ 3987 if (!ts->steprollback) { 3988 ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 3989 ierr = TSPostStep(ts);CHKERRQ(ierr); 3990 } 3991 } 3992 ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 3993 3994 if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) { 3995 ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr); 3996 ts->solvetime = ts->max_time; 3997 solution = u; 3998 ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr); 3999 } else { 4000 if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 4001 ts->solvetime = ts->ptime; 4002 solution = ts->vec_sol; 4003 } 4004 } 4005 4006 ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr); 4007 ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr); 4008 ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr); 4009 if (ts->adjoint_solve) { 4010 ierr = TSAdjointSolve(ts);CHKERRQ(ierr); 4011 } 4012 PetscFunctionReturn(0); 4013 } 4014 4015 #undef __FUNCT__ 4016 #define __FUNCT__ "TSAdjointCostIntegral" 4017 /*@ 4018 TSAdjointCostIntegral - Evaluate the cost integral in the adjoint run. 4019 4020 Collective on TS 4021 4022 Input Arguments: 4023 . ts - time stepping context 4024 4025 Level: advanced 4026 4027 Notes: 4028 This function cannot be called until TSAdjointStep() has been completed. 4029 4030 .seealso: TSAdjointSolve(), TSAdjointStep 4031 @*/ 4032 PetscErrorCode TSAdjointCostIntegral(TS ts) 4033 { 4034 PetscErrorCode ierr; 4035 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4036 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); 4037 ierr = (*ts->ops->adjointintegral)(ts);CHKERRQ(ierr); 4038 PetscFunctionReturn(0); 4039 } 4040 4041 #undef __FUNCT__ 4042 #define __FUNCT__ "TSAdjointSolve" 4043 /*@ 4044 TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE 4045 4046 Collective on TS 4047 4048 Input Parameter: 4049 . ts - the TS context obtained from TSCreate() 4050 4051 Options Database: 4052 . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial conditions 4053 4054 Level: intermediate 4055 4056 Notes: 4057 This must be called after a call to TSSolve() that solves the forward problem 4058 4059 By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time 4060 4061 .keywords: TS, timestep, solve 4062 4063 .seealso: TSCreate(), TSSetCostGradients(), TSSetSolution(), TSAdjointStep() 4064 @*/ 4065 PetscErrorCode TSAdjointSolve(TS ts) 4066 { 4067 PetscErrorCode ierr; 4068 4069 PetscFunctionBegin; 4070 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4071 ierr = TSAdjointSetUp(ts);CHKERRQ(ierr); 4072 4073 /* reset time step and iteration counters */ 4074 ts->steps = 0; 4075 ts->ksp_its = 0; 4076 ts->snes_its = 0; 4077 ts->num_snes_failures = 0; 4078 ts->reject = 0; 4079 ts->reason = TS_CONVERGED_ITERATING; 4080 4081 if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps; 4082 4083 if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS; 4084 while (!ts->reason) { 4085 ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr); 4086 ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr); 4087 ierr = TSAdjointEventHandler(ts);CHKERRQ(ierr); 4088 ierr = TSAdjointStep(ts);CHKERRQ(ierr); 4089 if (ts->vec_costintegral && !ts->costintegralfwd) { 4090 ierr = TSAdjointCostIntegral(ts);CHKERRQ(ierr); 4091 } 4092 } 4093 ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr); 4094 ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr); 4095 ts->solvetime = ts->ptime; 4096 ierr = TSTrajectoryViewFromOptions(ts->trajectory,NULL,"-ts_trajectory_view");CHKERRQ(ierr); 4097 ierr = VecViewFromOptions(ts->vecs_sensi[0],(PetscObject) ts, "-ts_adjoint_view_solution");CHKERRQ(ierr); 4098 PetscFunctionReturn(0); 4099 } 4100 4101 #undef __FUNCT__ 4102 #define __FUNCT__ "TSMonitor" 4103 /*@C 4104 TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet() 4105 4106 Collective on TS 4107 4108 Input Parameters: 4109 + ts - time stepping context obtained from TSCreate() 4110 . step - step number that has just completed 4111 . ptime - model time of the state 4112 - u - state at the current model time 4113 4114 Notes: 4115 TSMonitor() is typically used automatically within the time stepping implementations. 4116 Users would almost never call this routine directly. 4117 4118 A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions 4119 4120 Level: developer 4121 4122 .keywords: TS, timestep 4123 @*/ 4124 PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u) 4125 { 4126 DM dm; 4127 PetscInt i,n = ts->numbermonitors; 4128 PetscErrorCode ierr; 4129 4130 PetscFunctionBegin; 4131 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4132 PetscValidHeaderSpecific(u,VEC_CLASSID,4); 4133 4134 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 4135 ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr); 4136 4137 ierr = VecLockPush(u);CHKERRQ(ierr); 4138 for (i=0; i<n; i++) { 4139 ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr); 4140 } 4141 ierr = VecLockPop(u);CHKERRQ(ierr); 4142 PetscFunctionReturn(0); 4143 } 4144 4145 #undef __FUNCT__ 4146 #define __FUNCT__ "TSAdjointMonitor" 4147 /*@C 4148 TSAdjointMonitor - Runs all user-provided adjoint monitor routines set using TSAdjointMonitorSet() 4149 4150 Collective on TS 4151 4152 Input Parameters: 4153 + ts - time stepping context obtained from TSCreate() 4154 . step - step number that has just completed 4155 . ptime - model time of the state 4156 . u - state at the current model time 4157 . numcost - number of cost functions (dimension of lambda or mu) 4158 . lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables 4159 - mu - vectors containing the gradients of the cost functions with respect to the problem parameters 4160 4161 Notes: 4162 TSAdjointMonitor() is typically used automatically within the time stepping implementations. 4163 Users would almost never call this routine directly. 4164 4165 Level: developer 4166 4167 .keywords: TS, timestep 4168 @*/ 4169 PetscErrorCode TSAdjointMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda, Vec *mu) 4170 { 4171 PetscErrorCode ierr; 4172 PetscInt i,n = ts->numberadjointmonitors; 4173 4174 PetscFunctionBegin; 4175 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4176 PetscValidHeaderSpecific(u,VEC_CLASSID,4); 4177 ierr = VecLockPush(u);CHKERRQ(ierr); 4178 for (i=0; i<n; i++) { 4179 ierr = (*ts->adjointmonitor[i])(ts,step,ptime,u,numcost,lambda,mu,ts->adjointmonitorcontext[i]);CHKERRQ(ierr); 4180 } 4181 ierr = VecLockPop(u);CHKERRQ(ierr); 4182 PetscFunctionReturn(0); 4183 } 4184 4185 /* ------------------------------------------------------------------------*/ 4186 #undef __FUNCT__ 4187 #define __FUNCT__ "TSMonitorLGCtxCreate" 4188 /*@C 4189 TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with 4190 TS to monitor the solution process graphically in various ways 4191 4192 Collective on TS 4193 4194 Input Parameters: 4195 + host - the X display to open, or null for the local machine 4196 . label - the title to put in the title bar 4197 . x, y - the screen coordinates of the upper left coordinate of the window 4198 . m, n - the screen width and height in pixels 4199 - howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time 4200 4201 Output Parameter: 4202 . ctx - the context 4203 4204 Options Database Key: 4205 + -ts_monitor_lg_timestep - automatically sets line graph monitor 4206 . -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables()) 4207 . -ts_monitor_lg_error - monitor the error 4208 . -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep 4209 . -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep 4210 - -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true 4211 4212 Notes: 4213 Use TSMonitorLGCtxDestroy() to destroy. 4214 4215 One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform() 4216 4217 Many of the functions that control the monitoring have two forms: TSMonitorLGSet/GetXXXX() and TSMonitorLGCtxSet/GetXXXX() the first take a TS object as the 4218 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 4219 as the first argument. 4220 4221 One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames() 4222 4223 4224 Level: intermediate 4225 4226 .keywords: TS, monitor, line graph, residual 4227 4228 .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(), 4229 TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(), 4230 TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(), 4231 TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(), 4232 TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop() 4233 4234 @*/ 4235 PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx) 4236 { 4237 PetscDraw draw; 4238 PetscErrorCode ierr; 4239 4240 PetscFunctionBegin; 4241 ierr = PetscNew(ctx);CHKERRQ(ierr); 4242 ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr); 4243 ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr); 4244 ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr); 4245 ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr); 4246 ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 4247 (*ctx)->howoften = howoften; 4248 PetscFunctionReturn(0); 4249 } 4250 4251 #undef __FUNCT__ 4252 #define __FUNCT__ "TSMonitorLGTimeStep" 4253 PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx) 4254 { 4255 TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 4256 PetscReal x = ptime,y; 4257 PetscErrorCode ierr; 4258 4259 PetscFunctionBegin; 4260 if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */ 4261 if (!step) { 4262 PetscDrawAxis axis; 4263 ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 4264 ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time Step");CHKERRQ(ierr); 4265 ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4266 } 4267 ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr); 4268 ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 4269 if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 4270 ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 4271 ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 4272 } 4273 PetscFunctionReturn(0); 4274 } 4275 4276 #undef __FUNCT__ 4277 #define __FUNCT__ "TSMonitorLGCtxDestroy" 4278 /*@C 4279 TSMonitorLGCtxDestroy - Destroys a line graph context that was created 4280 with TSMonitorLGCtxCreate(). 4281 4282 Collective on TSMonitorLGCtx 4283 4284 Input Parameter: 4285 . ctx - the monitor context 4286 4287 Level: intermediate 4288 4289 .keywords: TS, monitor, line graph, destroy 4290 4291 .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep(); 4292 @*/ 4293 PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx) 4294 { 4295 PetscErrorCode ierr; 4296 4297 PetscFunctionBegin; 4298 if ((*ctx)->transformdestroy) { 4299 ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr); 4300 } 4301 ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr); 4302 ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr); 4303 ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr); 4304 ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr); 4305 ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr); 4306 ierr = PetscFree(*ctx);CHKERRQ(ierr); 4307 PetscFunctionReturn(0); 4308 } 4309 4310 #undef __FUNCT__ 4311 #define __FUNCT__ "TSGetTime" 4312 /*@ 4313 TSGetTime - Gets the time of the most recently completed step. 4314 4315 Not Collective 4316 4317 Input Parameter: 4318 . ts - the TS context obtained from TSCreate() 4319 4320 Output Parameter: 4321 . t - the current time. This time may not corresponds to the final time set with TSSetDuration(), use TSGetSolveTime(). 4322 4323 Level: beginner 4324 4325 Note: 4326 When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(), 4327 TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated. 4328 4329 .seealso: TSSetInitialTimeStep(), TSGetTimeStep(), TSGetSolveTime() 4330 4331 .keywords: TS, get, time 4332 @*/ 4333 PetscErrorCode TSGetTime(TS ts,PetscReal *t) 4334 { 4335 PetscFunctionBegin; 4336 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4337 PetscValidRealPointer(t,2); 4338 *t = ts->ptime; 4339 PetscFunctionReturn(0); 4340 } 4341 4342 #undef __FUNCT__ 4343 #define __FUNCT__ "TSGetPrevTime" 4344 /*@ 4345 TSGetPrevTime - Gets the starting time of the previously completed step. 4346 4347 Not Collective 4348 4349 Input Parameter: 4350 . ts - the TS context obtained from TSCreate() 4351 4352 Output Parameter: 4353 . t - the previous time 4354 4355 Level: beginner 4356 4357 .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 4358 4359 .keywords: TS, get, time 4360 @*/ 4361 PetscErrorCode TSGetPrevTime(TS ts,PetscReal *t) 4362 { 4363 PetscFunctionBegin; 4364 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4365 PetscValidRealPointer(t,2); 4366 *t = ts->ptime_prev; 4367 PetscFunctionReturn(0); 4368 } 4369 4370 #undef __FUNCT__ 4371 #define __FUNCT__ "TSSetTime" 4372 /*@ 4373 TSSetTime - Allows one to reset the time. 4374 4375 Logically Collective on TS 4376 4377 Input Parameters: 4378 + ts - the TS context obtained from TSCreate() 4379 - time - the time 4380 4381 Level: intermediate 4382 4383 .seealso: TSGetTime(), TSSetDuration() 4384 4385 .keywords: TS, set, time 4386 @*/ 4387 PetscErrorCode TSSetTime(TS ts, PetscReal t) 4388 { 4389 PetscFunctionBegin; 4390 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4391 PetscValidLogicalCollectiveReal(ts,t,2); 4392 ts->ptime = t; 4393 PetscFunctionReturn(0); 4394 } 4395 4396 #undef __FUNCT__ 4397 #define __FUNCT__ "TSSetOptionsPrefix" 4398 /*@C 4399 TSSetOptionsPrefix - Sets the prefix used for searching for all 4400 TS options in the database. 4401 4402 Logically Collective on TS 4403 4404 Input Parameter: 4405 + ts - The TS context 4406 - prefix - The prefix to prepend to all option names 4407 4408 Notes: 4409 A hyphen (-) must NOT be given at the beginning of the prefix name. 4410 The first character of all runtime options is AUTOMATICALLY the 4411 hyphen. 4412 4413 Level: advanced 4414 4415 .keywords: TS, set, options, prefix, database 4416 4417 .seealso: TSSetFromOptions() 4418 4419 @*/ 4420 PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[]) 4421 { 4422 PetscErrorCode ierr; 4423 SNES snes; 4424 4425 PetscFunctionBegin; 4426 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4427 ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4428 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4429 ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr); 4430 PetscFunctionReturn(0); 4431 } 4432 4433 4434 #undef __FUNCT__ 4435 #define __FUNCT__ "TSAppendOptionsPrefix" 4436 /*@C 4437 TSAppendOptionsPrefix - Appends to the prefix used for searching for all 4438 TS options in the database. 4439 4440 Logically Collective on TS 4441 4442 Input Parameter: 4443 + ts - The TS context 4444 - prefix - The prefix to prepend to all option names 4445 4446 Notes: 4447 A hyphen (-) must NOT be given at the beginning of the prefix name. 4448 The first character of all runtime options is AUTOMATICALLY the 4449 hyphen. 4450 4451 Level: advanced 4452 4453 .keywords: TS, append, options, prefix, database 4454 4455 .seealso: TSGetOptionsPrefix() 4456 4457 @*/ 4458 PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[]) 4459 { 4460 PetscErrorCode ierr; 4461 SNES snes; 4462 4463 PetscFunctionBegin; 4464 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4465 ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4466 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4467 ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr); 4468 PetscFunctionReturn(0); 4469 } 4470 4471 #undef __FUNCT__ 4472 #define __FUNCT__ "TSGetOptionsPrefix" 4473 /*@C 4474 TSGetOptionsPrefix - Sets the prefix used for searching for all 4475 TS options in the database. 4476 4477 Not Collective 4478 4479 Input Parameter: 4480 . ts - The TS context 4481 4482 Output Parameter: 4483 . prefix - A pointer to the prefix string used 4484 4485 Notes: On the fortran side, the user should pass in a string 'prifix' of 4486 sufficient length to hold the prefix. 4487 4488 Level: intermediate 4489 4490 .keywords: TS, get, options, prefix, database 4491 4492 .seealso: TSAppendOptionsPrefix() 4493 @*/ 4494 PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[]) 4495 { 4496 PetscErrorCode ierr; 4497 4498 PetscFunctionBegin; 4499 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4500 PetscValidPointer(prefix,2); 4501 ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4502 PetscFunctionReturn(0); 4503 } 4504 4505 #undef __FUNCT__ 4506 #define __FUNCT__ "TSGetRHSJacobian" 4507 /*@C 4508 TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 4509 4510 Not Collective, but parallel objects are returned if TS is parallel 4511 4512 Input Parameter: 4513 . ts - The TS context obtained from TSCreate() 4514 4515 Output Parameters: 4516 + Amat - The (approximate) Jacobian J of G, where U_t = G(U,t) (or NULL) 4517 . Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat (or NULL) 4518 . func - Function to compute the Jacobian of the RHS (or NULL) 4519 - ctx - User-defined context for Jacobian evaluation routine (or NULL) 4520 4521 Notes: You can pass in NULL for any return argument you do not need. 4522 4523 Level: intermediate 4524 4525 .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 4526 4527 .keywords: TS, timestep, get, matrix, Jacobian 4528 @*/ 4529 PetscErrorCode TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx) 4530 { 4531 PetscErrorCode ierr; 4532 SNES snes; 4533 DM dm; 4534 4535 PetscFunctionBegin; 4536 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4537 ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 4538 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 4539 ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr); 4540 PetscFunctionReturn(0); 4541 } 4542 4543 #undef __FUNCT__ 4544 #define __FUNCT__ "TSGetIJacobian" 4545 /*@C 4546 TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 4547 4548 Not Collective, but parallel objects are returned if TS is parallel 4549 4550 Input Parameter: 4551 . ts - The TS context obtained from TSCreate() 4552 4553 Output Parameters: 4554 + Amat - The (approximate) Jacobian of F(t,U,U_t) 4555 . Pmat - The matrix from which the preconditioner is constructed, often the same as Amat 4556 . f - The function to compute the matrices 4557 - ctx - User-defined context for Jacobian evaluation routine 4558 4559 Notes: You can pass in NULL for any return argument you do not need. 4560 4561 Level: advanced 4562 4563 .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 4564 4565 .keywords: TS, timestep, get, matrix, Jacobian 4566 @*/ 4567 PetscErrorCode TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx) 4568 { 4569 PetscErrorCode ierr; 4570 SNES snes; 4571 DM dm; 4572 4573 PetscFunctionBegin; 4574 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4575 ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 4576 ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 4577 ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 4578 ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr); 4579 PetscFunctionReturn(0); 4580 } 4581 4582 4583 #undef __FUNCT__ 4584 #define __FUNCT__ "TSMonitorDrawSolution" 4585 /*@C 4586 TSMonitorDrawSolution - Monitors progress of the TS solvers by calling 4587 VecView() for the solution at each timestep 4588 4589 Collective on TS 4590 4591 Input Parameters: 4592 + ts - the TS context 4593 . step - current time-step 4594 . ptime - current time 4595 - dummy - either a viewer or NULL 4596 4597 Options Database: 4598 . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 4599 4600 Notes: the initial solution and current solution are not display with a common axis scaling so generally the option -ts_monitor_draw_solution_initial 4601 will look bad 4602 4603 Level: intermediate 4604 4605 .keywords: TS, vector, monitor, view 4606 4607 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 4608 @*/ 4609 PetscErrorCode TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 4610 { 4611 PetscErrorCode ierr; 4612 TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 4613 PetscDraw draw; 4614 4615 PetscFunctionBegin; 4616 if (!step && ictx->showinitial) { 4617 if (!ictx->initialsolution) { 4618 ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr); 4619 } 4620 ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr); 4621 } 4622 if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 4623 4624 if (ictx->showinitial) { 4625 PetscReal pause; 4626 ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr); 4627 ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr); 4628 ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr); 4629 ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr); 4630 ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr); 4631 } 4632 ierr = VecView(u,ictx->viewer);CHKERRQ(ierr); 4633 if (ictx->showtimestepandtime) { 4634 PetscReal xl,yl,xr,yr,h; 4635 char time[32]; 4636 4637 ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 4638 ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 4639 ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 4640 h = yl + .95*(yr - yl); 4641 ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 4642 ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 4643 } 4644 4645 if (ictx->showinitial) { 4646 ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr); 4647 } 4648 PetscFunctionReturn(0); 4649 } 4650 4651 #undef __FUNCT__ 4652 #define __FUNCT__ "TSAdjointMonitorDrawSensi" 4653 /*@C 4654 TSAdjointMonitorDrawSensi - Monitors progress of the adjoint TS solvers by calling 4655 VecView() for the sensitivities to initial states at each timestep 4656 4657 Collective on TS 4658 4659 Input Parameters: 4660 + ts - the TS context 4661 . step - current time-step 4662 . ptime - current time 4663 . u - current state 4664 . numcost - number of cost functions 4665 . lambda - sensitivities to initial conditions 4666 . mu - sensitivities to parameters 4667 - dummy - either a viewer or NULL 4668 4669 Level: intermediate 4670 4671 .keywords: TS, vector, adjoint, monitor, view 4672 4673 .seealso: TSAdjointMonitorSet(), TSAdjointMonitorDefault(), VecView() 4674 @*/ 4675 PetscErrorCode TSAdjointMonitorDrawSensi(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy) 4676 { 4677 PetscErrorCode ierr; 4678 TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 4679 PetscDraw draw; 4680 PetscReal xl,yl,xr,yr,h; 4681 char time[32]; 4682 4683 PetscFunctionBegin; 4684 if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 4685 4686 ierr = VecView(lambda[0],ictx->viewer);CHKERRQ(ierr); 4687 ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 4688 ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 4689 ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 4690 h = yl + .95*(yr - yl); 4691 ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 4692 ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 4693 PetscFunctionReturn(0); 4694 } 4695 4696 #undef __FUNCT__ 4697 #define __FUNCT__ "TSMonitorDrawSolutionPhase" 4698 /*@C 4699 TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram 4700 4701 Collective on TS 4702 4703 Input Parameters: 4704 + ts - the TS context 4705 . step - current time-step 4706 . ptime - current time 4707 - dummy - either a viewer or NULL 4708 4709 Level: intermediate 4710 4711 .keywords: TS, vector, monitor, view 4712 4713 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 4714 @*/ 4715 PetscErrorCode TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 4716 { 4717 PetscErrorCode ierr; 4718 TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 4719 PetscDraw draw; 4720 PetscDrawAxis axis; 4721 PetscInt n; 4722 PetscMPIInt size; 4723 PetscReal U0,U1,xl,yl,xr,yr,h; 4724 char time[32]; 4725 const PetscScalar *U; 4726 4727 PetscFunctionBegin; 4728 ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr); 4729 if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs"); 4730 ierr = VecGetSize(u,&n);CHKERRQ(ierr); 4731 if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns"); 4732 4733 ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 4734 ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr); 4735 ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr); 4736 if (!step) { 4737 ierr = PetscDrawClear(draw);CHKERRQ(ierr); 4738 ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr); 4739 } 4740 4741 ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr); 4742 U0 = PetscRealPart(U[0]); 4743 U1 = PetscRealPart(U[1]); 4744 ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 4745 if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0); 4746 4747 ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr); 4748 ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr); 4749 if (ictx->showtimestepandtime) { 4750 ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 4751 ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 4752 h = yl + .95*(yr - yl); 4753 ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 4754 } 4755 ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr); 4756 ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 4757 ierr = PetscDrawSave(draw);CHKERRQ(ierr); 4758 PetscFunctionReturn(0); 4759 } 4760 4761 4762 #undef __FUNCT__ 4763 #define __FUNCT__ "TSMonitorDrawCtxDestroy" 4764 /*@C 4765 TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution() 4766 4767 Collective on TS 4768 4769 Input Parameters: 4770 . ctx - the monitor context 4771 4772 Level: intermediate 4773 4774 .keywords: TS, vector, monitor, view 4775 4776 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError() 4777 @*/ 4778 PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx) 4779 { 4780 PetscErrorCode ierr; 4781 4782 PetscFunctionBegin; 4783 ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr); 4784 ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr); 4785 ierr = PetscFree(*ictx);CHKERRQ(ierr); 4786 PetscFunctionReturn(0); 4787 } 4788 4789 #undef __FUNCT__ 4790 #define __FUNCT__ "TSMonitorDrawCtxCreate" 4791 /*@C 4792 TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx 4793 4794 Collective on TS 4795 4796 Input Parameter: 4797 . ts - time-step context 4798 4799 Output Patameter: 4800 . ctx - the monitor context 4801 4802 Options Database: 4803 . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 4804 4805 Level: intermediate 4806 4807 .keywords: TS, vector, monitor, view 4808 4809 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx() 4810 @*/ 4811 PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx) 4812 { 4813 PetscErrorCode ierr; 4814 4815 PetscFunctionBegin; 4816 ierr = PetscNew(ctx);CHKERRQ(ierr); 4817 ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr); 4818 ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr); 4819 4820 (*ctx)->howoften = howoften; 4821 (*ctx)->showinitial = PETSC_FALSE; 4822 ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr); 4823 4824 (*ctx)->showtimestepandtime = PETSC_FALSE; 4825 ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr); 4826 PetscFunctionReturn(0); 4827 } 4828 4829 #undef __FUNCT__ 4830 #define __FUNCT__ "TSMonitorDrawError" 4831 /*@C 4832 TSMonitorDrawError - Monitors progress of the TS solvers by calling 4833 VecView() for the error at each timestep 4834 4835 Collective on TS 4836 4837 Input Parameters: 4838 + ts - the TS context 4839 . step - current time-step 4840 . ptime - current time 4841 - dummy - either a viewer or NULL 4842 4843 Level: intermediate 4844 4845 .keywords: TS, vector, monitor, view 4846 4847 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 4848 @*/ 4849 PetscErrorCode TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 4850 { 4851 PetscErrorCode ierr; 4852 TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy; 4853 PetscViewer viewer = ctx->viewer; 4854 Vec work; 4855 4856 PetscFunctionBegin; 4857 if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 4858 ierr = VecDuplicate(u,&work);CHKERRQ(ierr); 4859 ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr); 4860 ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr); 4861 ierr = VecView(work,viewer);CHKERRQ(ierr); 4862 ierr = VecDestroy(&work);CHKERRQ(ierr); 4863 PetscFunctionReturn(0); 4864 } 4865 4866 #include <petsc/private/dmimpl.h> 4867 #undef __FUNCT__ 4868 #define __FUNCT__ "TSSetDM" 4869 /*@ 4870 TSSetDM - Sets the DM that may be used by some preconditioners 4871 4872 Logically Collective on TS and DM 4873 4874 Input Parameters: 4875 + ts - the preconditioner context 4876 - dm - the dm 4877 4878 Level: intermediate 4879 4880 4881 .seealso: TSGetDM(), SNESSetDM(), SNESGetDM() 4882 @*/ 4883 PetscErrorCode TSSetDM(TS ts,DM dm) 4884 { 4885 PetscErrorCode ierr; 4886 SNES snes; 4887 DMTS tsdm; 4888 4889 PetscFunctionBegin; 4890 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4891 ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr); 4892 if (ts->dm) { /* Move the DMTS context over to the new DM unless the new DM already has one */ 4893 if (ts->dm->dmts && !dm->dmts) { 4894 ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr); 4895 ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr); 4896 if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */ 4897 tsdm->originaldm = dm; 4898 } 4899 } 4900 ierr = DMDestroy(&ts->dm);CHKERRQ(ierr); 4901 } 4902 ts->dm = dm; 4903 4904 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4905 ierr = SNESSetDM(snes,dm);CHKERRQ(ierr); 4906 PetscFunctionReturn(0); 4907 } 4908 4909 #undef __FUNCT__ 4910 #define __FUNCT__ "TSGetDM" 4911 /*@ 4912 TSGetDM - Gets the DM that may be used by some preconditioners 4913 4914 Not Collective 4915 4916 Input Parameter: 4917 . ts - the preconditioner context 4918 4919 Output Parameter: 4920 . dm - the dm 4921 4922 Level: intermediate 4923 4924 4925 .seealso: TSSetDM(), SNESSetDM(), SNESGetDM() 4926 @*/ 4927 PetscErrorCode TSGetDM(TS ts,DM *dm) 4928 { 4929 PetscErrorCode ierr; 4930 4931 PetscFunctionBegin; 4932 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4933 if (!ts->dm) { 4934 ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr); 4935 if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 4936 } 4937 *dm = ts->dm; 4938 PetscFunctionReturn(0); 4939 } 4940 4941 #undef __FUNCT__ 4942 #define __FUNCT__ "SNESTSFormFunction" 4943 /*@ 4944 SNESTSFormFunction - Function to evaluate nonlinear residual 4945 4946 Logically Collective on SNES 4947 4948 Input Parameter: 4949 + snes - nonlinear solver 4950 . U - the current state at which to evaluate the residual 4951 - ctx - user context, must be a TS 4952 4953 Output Parameter: 4954 . F - the nonlinear residual 4955 4956 Notes: 4957 This function is not normally called by users and is automatically registered with the SNES used by TS. 4958 It is most frequently passed to MatFDColoringSetFunction(). 4959 4960 Level: advanced 4961 4962 .seealso: SNESSetFunction(), MatFDColoringSetFunction() 4963 @*/ 4964 PetscErrorCode SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx) 4965 { 4966 TS ts = (TS)ctx; 4967 PetscErrorCode ierr; 4968 4969 PetscFunctionBegin; 4970 PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4971 PetscValidHeaderSpecific(U,VEC_CLASSID,2); 4972 PetscValidHeaderSpecific(F,VEC_CLASSID,3); 4973 PetscValidHeaderSpecific(ts,TS_CLASSID,4); 4974 ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr); 4975 PetscFunctionReturn(0); 4976 } 4977 4978 #undef __FUNCT__ 4979 #define __FUNCT__ "SNESTSFormJacobian" 4980 /*@ 4981 SNESTSFormJacobian - Function to evaluate the Jacobian 4982 4983 Collective on SNES 4984 4985 Input Parameter: 4986 + snes - nonlinear solver 4987 . U - the current state at which to evaluate the residual 4988 - ctx - user context, must be a TS 4989 4990 Output Parameter: 4991 + A - the Jacobian 4992 . B - the preconditioning matrix (may be the same as A) 4993 - flag - indicates any structure change in the matrix 4994 4995 Notes: 4996 This function is not normally called by users and is automatically registered with the SNES used by TS. 4997 4998 Level: developer 4999 5000 .seealso: SNESSetJacobian() 5001 @*/ 5002 PetscErrorCode SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx) 5003 { 5004 TS ts = (TS)ctx; 5005 PetscErrorCode ierr; 5006 5007 PetscFunctionBegin; 5008 PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 5009 PetscValidHeaderSpecific(U,VEC_CLASSID,2); 5010 PetscValidPointer(A,3); 5011 PetscValidHeaderSpecific(A,MAT_CLASSID,3); 5012 PetscValidPointer(B,4); 5013 PetscValidHeaderSpecific(B,MAT_CLASSID,4); 5014 PetscValidHeaderSpecific(ts,TS_CLASSID,6); 5015 ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr); 5016 PetscFunctionReturn(0); 5017 } 5018 5019 #undef __FUNCT__ 5020 #define __FUNCT__ "TSComputeRHSFunctionLinear" 5021 /*@C 5022 TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only 5023 5024 Collective on TS 5025 5026 Input Arguments: 5027 + ts - time stepping context 5028 . t - time at which to evaluate 5029 . U - state at which to evaluate 5030 - ctx - context 5031 5032 Output Arguments: 5033 . F - right hand side 5034 5035 Level: intermediate 5036 5037 Notes: 5038 This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems. 5039 The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian(). 5040 5041 .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 5042 @*/ 5043 PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx) 5044 { 5045 PetscErrorCode ierr; 5046 Mat Arhs,Brhs; 5047 5048 PetscFunctionBegin; 5049 ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 5050 ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 5051 ierr = MatMult(Arhs,U,F);CHKERRQ(ierr); 5052 PetscFunctionReturn(0); 5053 } 5054 5055 #undef __FUNCT__ 5056 #define __FUNCT__ "TSComputeRHSJacobianConstant" 5057 /*@C 5058 TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 5059 5060 Collective on TS 5061 5062 Input Arguments: 5063 + ts - time stepping context 5064 . t - time at which to evaluate 5065 . U - state at which to evaluate 5066 - ctx - context 5067 5068 Output Arguments: 5069 + A - pointer to operator 5070 . B - pointer to preconditioning matrix 5071 - flg - matrix structure flag 5072 5073 Level: intermediate 5074 5075 Notes: 5076 This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems. 5077 5078 .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear() 5079 @*/ 5080 PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx) 5081 { 5082 PetscFunctionBegin; 5083 PetscFunctionReturn(0); 5084 } 5085 5086 #undef __FUNCT__ 5087 #define __FUNCT__ "TSComputeIFunctionLinear" 5088 /*@C 5089 TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 5090 5091 Collective on TS 5092 5093 Input Arguments: 5094 + ts - time stepping context 5095 . t - time at which to evaluate 5096 . U - state at which to evaluate 5097 . Udot - time derivative of state vector 5098 - ctx - context 5099 5100 Output Arguments: 5101 . F - left hand side 5102 5103 Level: intermediate 5104 5105 Notes: 5106 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 5107 user is required to write their own TSComputeIFunction. 5108 This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems. 5109 The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian(). 5110 5111 Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U 5112 5113 .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear() 5114 @*/ 5115 PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx) 5116 { 5117 PetscErrorCode ierr; 5118 Mat A,B; 5119 5120 PetscFunctionBegin; 5121 ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 5122 ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr); 5123 ierr = MatMult(A,Udot,F);CHKERRQ(ierr); 5124 PetscFunctionReturn(0); 5125 } 5126 5127 #undef __FUNCT__ 5128 #define __FUNCT__ "TSComputeIJacobianConstant" 5129 /*@C 5130 TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE 5131 5132 Collective on TS 5133 5134 Input Arguments: 5135 + ts - time stepping context 5136 . t - time at which to evaluate 5137 . U - state at which to evaluate 5138 . Udot - time derivative of state vector 5139 . shift - shift to apply 5140 - ctx - context 5141 5142 Output Arguments: 5143 + A - pointer to operator 5144 . B - pointer to preconditioning matrix 5145 - flg - matrix structure flag 5146 5147 Level: advanced 5148 5149 Notes: 5150 This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems. 5151 5152 It is only appropriate for problems of the form 5153 5154 $ M Udot = F(U,t) 5155 5156 where M is constant and F is non-stiff. The user must pass M to TSSetIJacobian(). The current implementation only 5157 works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing 5158 an implicit operator of the form 5159 5160 $ shift*M + J 5161 5162 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 5163 a copy of M or reassemble it when requested. 5164 5165 .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear() 5166 @*/ 5167 PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx) 5168 { 5169 PetscErrorCode ierr; 5170 5171 PetscFunctionBegin; 5172 ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr); 5173 ts->ijacobian.shift = shift; 5174 PetscFunctionReturn(0); 5175 } 5176 5177 #undef __FUNCT__ 5178 #define __FUNCT__ "TSGetEquationType" 5179 /*@ 5180 TSGetEquationType - Gets the type of the equation that TS is solving. 5181 5182 Not Collective 5183 5184 Input Parameter: 5185 . ts - the TS context 5186 5187 Output Parameter: 5188 . equation_type - see TSEquationType 5189 5190 Level: beginner 5191 5192 .keywords: TS, equation type 5193 5194 .seealso: TSSetEquationType(), TSEquationType 5195 @*/ 5196 PetscErrorCode TSGetEquationType(TS ts,TSEquationType *equation_type) 5197 { 5198 PetscFunctionBegin; 5199 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5200 PetscValidPointer(equation_type,2); 5201 *equation_type = ts->equation_type; 5202 PetscFunctionReturn(0); 5203 } 5204 5205 #undef __FUNCT__ 5206 #define __FUNCT__ "TSSetEquationType" 5207 /*@ 5208 TSSetEquationType - Sets the type of the equation that TS is solving. 5209 5210 Not Collective 5211 5212 Input Parameter: 5213 + ts - the TS context 5214 - equation_type - see TSEquationType 5215 5216 Level: advanced 5217 5218 .keywords: TS, equation type 5219 5220 .seealso: TSGetEquationType(), TSEquationType 5221 @*/ 5222 PetscErrorCode TSSetEquationType(TS ts,TSEquationType equation_type) 5223 { 5224 PetscFunctionBegin; 5225 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5226 ts->equation_type = equation_type; 5227 PetscFunctionReturn(0); 5228 } 5229 5230 #undef __FUNCT__ 5231 #define __FUNCT__ "TSGetConvergedReason" 5232 /*@ 5233 TSGetConvergedReason - Gets the reason the TS iteration was stopped. 5234 5235 Not Collective 5236 5237 Input Parameter: 5238 . ts - the TS context 5239 5240 Output Parameter: 5241 . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 5242 manual pages for the individual convergence tests for complete lists 5243 5244 Level: beginner 5245 5246 Notes: 5247 Can only be called after the call to TSSolve() is complete. 5248 5249 .keywords: TS, nonlinear, set, convergence, test 5250 5251 .seealso: TSSetConvergenceTest(), TSConvergedReason 5252 @*/ 5253 PetscErrorCode TSGetConvergedReason(TS ts,TSConvergedReason *reason) 5254 { 5255 PetscFunctionBegin; 5256 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5257 PetscValidPointer(reason,2); 5258 *reason = ts->reason; 5259 PetscFunctionReturn(0); 5260 } 5261 5262 #undef __FUNCT__ 5263 #define __FUNCT__ "TSSetConvergedReason" 5264 /*@ 5265 TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve. 5266 5267 Not Collective 5268 5269 Input Parameter: 5270 + ts - the TS context 5271 . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 5272 manual pages for the individual convergence tests for complete lists 5273 5274 Level: advanced 5275 5276 Notes: 5277 Can only be called during TSSolve() is active. 5278 5279 .keywords: TS, nonlinear, set, convergence, test 5280 5281 .seealso: TSConvergedReason 5282 @*/ 5283 PetscErrorCode TSSetConvergedReason(TS ts,TSConvergedReason reason) 5284 { 5285 PetscFunctionBegin; 5286 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5287 ts->reason = reason; 5288 PetscFunctionReturn(0); 5289 } 5290 5291 #undef __FUNCT__ 5292 #define __FUNCT__ "TSGetSolveTime" 5293 /*@ 5294 TSGetSolveTime - Gets the time after a call to TSSolve() 5295 5296 Not Collective 5297 5298 Input Parameter: 5299 . ts - the TS context 5300 5301 Output Parameter: 5302 . ftime - the final time. This time corresponds to the final time set with TSSetDuration() 5303 5304 Level: beginner 5305 5306 Notes: 5307 Can only be called after the call to TSSolve() is complete. 5308 5309 .keywords: TS, nonlinear, set, convergence, test 5310 5311 .seealso: TSSetConvergenceTest(), TSConvergedReason 5312 @*/ 5313 PetscErrorCode TSGetSolveTime(TS ts,PetscReal *ftime) 5314 { 5315 PetscFunctionBegin; 5316 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5317 PetscValidPointer(ftime,2); 5318 *ftime = ts->solvetime; 5319 PetscFunctionReturn(0); 5320 } 5321 5322 #undef __FUNCT__ 5323 #define __FUNCT__ "TSGetTotalSteps" 5324 /*@ 5325 TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate() 5326 5327 Not Collective 5328 5329 Input Parameter: 5330 . ts - the TS context 5331 5332 Output Parameter: 5333 . steps - the number of steps 5334 5335 Level: beginner 5336 5337 Notes: 5338 Includes the number of steps for all calls to TSSolve() since TSSetUp() was called 5339 5340 .keywords: TS, nonlinear, set, convergence, test 5341 5342 .seealso: TSSetConvergenceTest(), TSConvergedReason 5343 @*/ 5344 PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps) 5345 { 5346 PetscFunctionBegin; 5347 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5348 PetscValidPointer(steps,2); 5349 *steps = ts->total_steps; 5350 PetscFunctionReturn(0); 5351 } 5352 5353 #undef __FUNCT__ 5354 #define __FUNCT__ "TSGetSNESIterations" 5355 /*@ 5356 TSGetSNESIterations - Gets the total number of nonlinear iterations 5357 used by the time integrator. 5358 5359 Not Collective 5360 5361 Input Parameter: 5362 . ts - TS context 5363 5364 Output Parameter: 5365 . nits - number of nonlinear iterations 5366 5367 Notes: 5368 This counter is reset to zero for each successive call to TSSolve(). 5369 5370 Level: intermediate 5371 5372 .keywords: TS, get, number, nonlinear, iterations 5373 5374 .seealso: TSGetKSPIterations() 5375 @*/ 5376 PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits) 5377 { 5378 PetscFunctionBegin; 5379 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5380 PetscValidIntPointer(nits,2); 5381 *nits = ts->snes_its; 5382 PetscFunctionReturn(0); 5383 } 5384 5385 #undef __FUNCT__ 5386 #define __FUNCT__ "TSGetKSPIterations" 5387 /*@ 5388 TSGetKSPIterations - Gets the total number of linear iterations 5389 used by the time integrator. 5390 5391 Not Collective 5392 5393 Input Parameter: 5394 . ts - TS context 5395 5396 Output Parameter: 5397 . lits - number of linear iterations 5398 5399 Notes: 5400 This counter is reset to zero for each successive call to TSSolve(). 5401 5402 Level: intermediate 5403 5404 .keywords: TS, get, number, linear, iterations 5405 5406 .seealso: TSGetSNESIterations(), SNESGetKSPIterations() 5407 @*/ 5408 PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits) 5409 { 5410 PetscFunctionBegin; 5411 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5412 PetscValidIntPointer(lits,2); 5413 *lits = ts->ksp_its; 5414 PetscFunctionReturn(0); 5415 } 5416 5417 #undef __FUNCT__ 5418 #define __FUNCT__ "TSGetStepRejections" 5419 /*@ 5420 TSGetStepRejections - Gets the total number of rejected steps. 5421 5422 Not Collective 5423 5424 Input Parameter: 5425 . ts - TS context 5426 5427 Output Parameter: 5428 . rejects - number of steps rejected 5429 5430 Notes: 5431 This counter is reset to zero for each successive call to TSSolve(). 5432 5433 Level: intermediate 5434 5435 .keywords: TS, get, number 5436 5437 .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails() 5438 @*/ 5439 PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects) 5440 { 5441 PetscFunctionBegin; 5442 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5443 PetscValidIntPointer(rejects,2); 5444 *rejects = ts->reject; 5445 PetscFunctionReturn(0); 5446 } 5447 5448 #undef __FUNCT__ 5449 #define __FUNCT__ "TSGetSNESFailures" 5450 /*@ 5451 TSGetSNESFailures - Gets the total number of failed SNES solves 5452 5453 Not Collective 5454 5455 Input Parameter: 5456 . ts - TS context 5457 5458 Output Parameter: 5459 . fails - number of failed nonlinear solves 5460 5461 Notes: 5462 This counter is reset to zero for each successive call to TSSolve(). 5463 5464 Level: intermediate 5465 5466 .keywords: TS, get, number 5467 5468 .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures() 5469 @*/ 5470 PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails) 5471 { 5472 PetscFunctionBegin; 5473 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5474 PetscValidIntPointer(fails,2); 5475 *fails = ts->num_snes_failures; 5476 PetscFunctionReturn(0); 5477 } 5478 5479 #undef __FUNCT__ 5480 #define __FUNCT__ "TSSetMaxStepRejections" 5481 /*@ 5482 TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails 5483 5484 Not Collective 5485 5486 Input Parameter: 5487 + ts - TS context 5488 - rejects - maximum number of rejected steps, pass -1 for unlimited 5489 5490 Notes: 5491 The counter is reset to zero for each step 5492 5493 Options Database Key: 5494 . -ts_max_reject - Maximum number of step rejections before a step fails 5495 5496 Level: intermediate 5497 5498 .keywords: TS, set, maximum, number 5499 5500 .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 5501 @*/ 5502 PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects) 5503 { 5504 PetscFunctionBegin; 5505 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5506 ts->max_reject = rejects; 5507 PetscFunctionReturn(0); 5508 } 5509 5510 #undef __FUNCT__ 5511 #define __FUNCT__ "TSSetMaxSNESFailures" 5512 /*@ 5513 TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves 5514 5515 Not Collective 5516 5517 Input Parameter: 5518 + ts - TS context 5519 - fails - maximum number of failed nonlinear solves, pass -1 for unlimited 5520 5521 Notes: 5522 The counter is reset to zero for each successive call to TSSolve(). 5523 5524 Options Database Key: 5525 . -ts_max_snes_failures - Maximum number of nonlinear solve failures 5526 5527 Level: intermediate 5528 5529 .keywords: TS, set, maximum, number 5530 5531 .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason() 5532 @*/ 5533 PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails) 5534 { 5535 PetscFunctionBegin; 5536 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5537 ts->max_snes_failures = fails; 5538 PetscFunctionReturn(0); 5539 } 5540 5541 #undef __FUNCT__ 5542 #define __FUNCT__ "TSSetErrorIfStepFails" 5543 /*@ 5544 TSSetErrorIfStepFails - Error if no step succeeds 5545 5546 Not Collective 5547 5548 Input Parameter: 5549 + ts - TS context 5550 - err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure 5551 5552 Options Database Key: 5553 . -ts_error_if_step_fails - Error if no step succeeds 5554 5555 Level: intermediate 5556 5557 .keywords: TS, set, error 5558 5559 .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 5560 @*/ 5561 PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err) 5562 { 5563 PetscFunctionBegin; 5564 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5565 ts->errorifstepfailed = err; 5566 PetscFunctionReturn(0); 5567 } 5568 5569 #undef __FUNCT__ 5570 #define __FUNCT__ "TSMonitorSolution" 5571 /*@C 5572 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 5573 5574 Collective on TS 5575 5576 Input Parameters: 5577 + ts - the TS context 5578 . step - current time-step 5579 . ptime - current time 5580 . u - current state 5581 - vf - viewer and its format 5582 5583 Level: intermediate 5584 5585 .keywords: TS, vector, monitor, view 5586 5587 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5588 @*/ 5589 PetscErrorCode TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf) 5590 { 5591 PetscErrorCode ierr; 5592 5593 PetscFunctionBegin; 5594 ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr); 5595 ierr = VecView(u,vf->viewer);CHKERRQ(ierr); 5596 ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr); 5597 PetscFunctionReturn(0); 5598 } 5599 5600 #undef __FUNCT__ 5601 #define __FUNCT__ "TSMonitorSolutionVTK" 5602 /*@C 5603 TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep. 5604 5605 Collective on TS 5606 5607 Input Parameters: 5608 + ts - the TS context 5609 . step - current time-step 5610 . ptime - current time 5611 . u - current state 5612 - filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 5613 5614 Level: intermediate 5615 5616 Notes: 5617 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. 5618 These are named according to the file name template. 5619 5620 This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy(). 5621 5622 .keywords: TS, vector, monitor, view 5623 5624 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5625 @*/ 5626 PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate) 5627 { 5628 PetscErrorCode ierr; 5629 char filename[PETSC_MAX_PATH_LEN]; 5630 PetscViewer viewer; 5631 5632 PetscFunctionBegin; 5633 if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 5634 ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr); 5635 ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr); 5636 ierr = VecView(u,viewer);CHKERRQ(ierr); 5637 ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 5638 PetscFunctionReturn(0); 5639 } 5640 5641 #undef __FUNCT__ 5642 #define __FUNCT__ "TSMonitorSolutionVTKDestroy" 5643 /*@C 5644 TSMonitorSolutionVTKDestroy - Destroy context for monitoring 5645 5646 Collective on TS 5647 5648 Input Parameters: 5649 . filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 5650 5651 Level: intermediate 5652 5653 Note: 5654 This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK(). 5655 5656 .keywords: TS, vector, monitor, view 5657 5658 .seealso: TSMonitorSet(), TSMonitorSolutionVTK() 5659 @*/ 5660 PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate) 5661 { 5662 PetscErrorCode ierr; 5663 5664 PetscFunctionBegin; 5665 ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr); 5666 PetscFunctionReturn(0); 5667 } 5668 5669 #undef __FUNCT__ 5670 #define __FUNCT__ "TSGetAdapt" 5671 /*@ 5672 TSGetAdapt - Get the adaptive controller context for the current method 5673 5674 Collective on TS if controller has not been created yet 5675 5676 Input Arguments: 5677 . ts - time stepping context 5678 5679 Output Arguments: 5680 . adapt - adaptive controller 5681 5682 Level: intermediate 5683 5684 .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose() 5685 @*/ 5686 PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt) 5687 { 5688 PetscErrorCode ierr; 5689 5690 PetscFunctionBegin; 5691 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5692 PetscValidPointer(adapt,2); 5693 if (!ts->adapt) { 5694 ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr); 5695 ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr); 5696 ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr); 5697 } 5698 *adapt = ts->adapt; 5699 PetscFunctionReturn(0); 5700 } 5701 5702 #undef __FUNCT__ 5703 #define __FUNCT__ "TSSetTolerances" 5704 /*@ 5705 TSSetTolerances - Set tolerances for local truncation error when using adaptive controller 5706 5707 Logically Collective 5708 5709 Input Arguments: 5710 + ts - time integration context 5711 . atol - scalar absolute tolerances, PETSC_DECIDE to leave current value 5712 . vatol - vector of absolute tolerances or NULL, used in preference to atol if present 5713 . rtol - scalar relative tolerances, PETSC_DECIDE to leave current value 5714 - vrtol - vector of relative tolerances or NULL, used in preference to atol if present 5715 5716 Options Database keys: 5717 + -ts_rtol <rtol> - relative tolerance for local truncation error 5718 - -ts_atol <atol> Absolute tolerance for local truncation error 5719 5720 Notes: 5721 With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error 5722 (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be 5723 computed only for the differential or the algebraic part then this can be done using the vector of 5724 tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the 5725 differential part and infinity for the algebraic part, the LTE calculation will include only the 5726 differential variables. 5727 5728 Level: beginner 5729 5730 .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances() 5731 @*/ 5732 PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol) 5733 { 5734 PetscErrorCode ierr; 5735 5736 PetscFunctionBegin; 5737 if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol; 5738 if (vatol) { 5739 ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr); 5740 ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 5741 ts->vatol = vatol; 5742 } 5743 if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol; 5744 if (vrtol) { 5745 ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr); 5746 ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 5747 ts->vrtol = vrtol; 5748 } 5749 PetscFunctionReturn(0); 5750 } 5751 5752 #undef __FUNCT__ 5753 #define __FUNCT__ "TSGetTolerances" 5754 /*@ 5755 TSGetTolerances - Get tolerances for local truncation error when using adaptive controller 5756 5757 Logically Collective 5758 5759 Input Arguments: 5760 . ts - time integration context 5761 5762 Output Arguments: 5763 + atol - scalar absolute tolerances, NULL to ignore 5764 . vatol - vector of absolute tolerances, NULL to ignore 5765 . rtol - scalar relative tolerances, NULL to ignore 5766 - vrtol - vector of relative tolerances, NULL to ignore 5767 5768 Level: beginner 5769 5770 .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances() 5771 @*/ 5772 PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol) 5773 { 5774 PetscFunctionBegin; 5775 if (atol) *atol = ts->atol; 5776 if (vatol) *vatol = ts->vatol; 5777 if (rtol) *rtol = ts->rtol; 5778 if (vrtol) *vrtol = ts->vrtol; 5779 PetscFunctionReturn(0); 5780 } 5781 5782 #undef __FUNCT__ 5783 #define __FUNCT__ "TSErrorWeightedNorm2" 5784 /*@ 5785 TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors 5786 5787 Collective on TS 5788 5789 Input Arguments: 5790 + ts - time stepping context 5791 . U - state vector, usually ts->vec_sol 5792 - Y - state vector to be compared to U 5793 5794 Output Arguments: 5795 . norm - weighted norm, a value of 1.0 is considered small 5796 5797 Level: developer 5798 5799 .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity() 5800 @*/ 5801 PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm) 5802 { 5803 PetscErrorCode ierr; 5804 PetscInt i,n,N,rstart; 5805 const PetscScalar *u,*y; 5806 PetscReal sum,gsum; 5807 PetscReal tol; 5808 5809 PetscFunctionBegin; 5810 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5811 PetscValidHeaderSpecific(U,VEC_CLASSID,2); 5812 PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 5813 PetscValidType(U,2); 5814 PetscValidType(Y,3); 5815 PetscCheckSameComm(U,2,Y,3); 5816 PetscValidPointer(norm,4); 5817 if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 5818 5819 ierr = VecGetSize(U,&N);CHKERRQ(ierr); 5820 ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 5821 ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 5822 ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 5823 ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 5824 sum = 0.; 5825 if (ts->vatol && ts->vrtol) { 5826 const PetscScalar *atol,*rtol; 5827 ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 5828 ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 5829 for (i=0; i<n; i++) { 5830 tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 5831 sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 5832 } 5833 ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 5834 ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 5835 } else if (ts->vatol) { /* vector atol, scalar rtol */ 5836 const PetscScalar *atol; 5837 ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 5838 for (i=0; i<n; i++) { 5839 tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 5840 sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 5841 } 5842 ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 5843 } else if (ts->vrtol) { /* scalar atol, vector rtol */ 5844 const PetscScalar *rtol; 5845 ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 5846 for (i=0; i<n; i++) { 5847 tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 5848 sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 5849 } 5850 ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 5851 } else { /* scalar atol, scalar rtol */ 5852 for (i=0; i<n; i++) { 5853 tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 5854 sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 5855 } 5856 } 5857 ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 5858 ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 5859 5860 ierr = MPIU_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 5861 *norm = PetscSqrtReal(gsum / N); 5862 5863 if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 5864 PetscFunctionReturn(0); 5865 } 5866 5867 #undef __FUNCT__ 5868 #define __FUNCT__ "TSErrorWeightedNormInfinity" 5869 /*@ 5870 TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors 5871 5872 Collective on TS 5873 5874 Input Arguments: 5875 + ts - time stepping context 5876 . U - state vector, usually ts->vec_sol 5877 - Y - state vector to be compared to U 5878 5879 Output Arguments: 5880 . norm - weighted norm, a value of 1.0 is considered small 5881 5882 Level: developer 5883 5884 .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2() 5885 @*/ 5886 PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm) 5887 { 5888 PetscErrorCode ierr; 5889 PetscInt i,n,N,rstart,k; 5890 const PetscScalar *u,*y; 5891 PetscReal max,gmax; 5892 PetscReal tol; 5893 5894 PetscFunctionBegin; 5895 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5896 PetscValidHeaderSpecific(U,VEC_CLASSID,2); 5897 PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 5898 PetscValidType(U,2); 5899 PetscValidType(Y,3); 5900 PetscCheckSameComm(U,2,Y,3); 5901 PetscValidPointer(norm,4); 5902 if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 5903 5904 ierr = VecGetSize(U,&N);CHKERRQ(ierr); 5905 ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 5906 ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 5907 ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 5908 ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 5909 if (ts->vatol && ts->vrtol) { 5910 const PetscScalar *atol,*rtol; 5911 ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 5912 ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 5913 k = 0; 5914 tol = PetscRealPart(atol[k]) + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k])); 5915 max = PetscAbsScalar(y[k] - u[k]) / tol; 5916 for (i=1; i<n; i++) { 5917 tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 5918 max = PetscMax(max,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 k = 0; 5926 tol = PetscRealPart(atol[k]) + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k])); 5927 max = PetscAbsScalar(y[k] - u[k]) / tol; 5928 for (i=1; i<n; i++) { 5929 tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 5930 max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol); 5931 } 5932 ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 5933 } else if (ts->vrtol) { /* scalar atol, vector rtol */ 5934 const PetscScalar *rtol; 5935 ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 5936 k = 0; 5937 tol = ts->atol + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k])); 5938 max = PetscAbsScalar(y[k] - u[k]) / tol; 5939 for (i=1; i<n; i++) { 5940 tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 5941 max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol); 5942 } 5943 ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 5944 } else { /* scalar atol, scalar rtol */ 5945 k = 0; 5946 tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k])); 5947 max = PetscAbsScalar(y[k] - u[k]) / tol; 5948 for (i=1; i<n; i++) { 5949 tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 5950 max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol); 5951 } 5952 } 5953 ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 5954 ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 5955 5956 ierr = MPIU_Allreduce(&max,&gmax,1,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 5957 *norm = gmax; 5958 5959 if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 5960 PetscFunctionReturn(0); 5961 } 5962 5963 #undef __FUNCT__ 5964 #define __FUNCT__ "TSErrorWeightedNorm" 5965 /*@ 5966 TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors 5967 5968 Collective on TS 5969 5970 Input Arguments: 5971 + ts - time stepping context 5972 . U - state vector, usually ts->vec_sol 5973 . Y - state vector to be compared to U 5974 - wnormtype - norm type, either NORM_2 or NORM_INFINITY 5975 5976 Output Arguments: 5977 . norm - weighted norm, a value of 1.0 is considered small 5978 5979 5980 Options Database Keys: 5981 . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 5982 5983 Level: developer 5984 5985 .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2() 5986 @*/ 5987 PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm) 5988 { 5989 PetscErrorCode ierr; 5990 5991 PetscFunctionBegin; 5992 if (wnormtype == NORM_2) { 5993 ierr = TSErrorWeightedNorm2(ts,U,Y,norm);CHKERRQ(ierr); 5994 } else if(wnormtype == NORM_INFINITY) { 5995 ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm);CHKERRQ(ierr); 5996 } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 5997 PetscFunctionReturn(0); 5998 } 5999 6000 #undef __FUNCT__ 6001 #define __FUNCT__ "TSSetCFLTimeLocal" 6002 /*@ 6003 TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler 6004 6005 Logically Collective on TS 6006 6007 Input Arguments: 6008 + ts - time stepping context 6009 - cfltime - maximum stable time step if using forward Euler (value can be different on each process) 6010 6011 Note: 6012 After calling this function, the global CFL time can be obtained by calling TSGetCFLTime() 6013 6014 Level: intermediate 6015 6016 .seealso: TSGetCFLTime(), TSADAPTCFL 6017 @*/ 6018 PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime) 6019 { 6020 PetscFunctionBegin; 6021 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6022 ts->cfltime_local = cfltime; 6023 ts->cfltime = -1.; 6024 PetscFunctionReturn(0); 6025 } 6026 6027 #undef __FUNCT__ 6028 #define __FUNCT__ "TSGetCFLTime" 6029 /*@ 6030 TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler 6031 6032 Collective on TS 6033 6034 Input Arguments: 6035 . ts - time stepping context 6036 6037 Output Arguments: 6038 . cfltime - maximum stable time step for forward Euler 6039 6040 Level: advanced 6041 6042 .seealso: TSSetCFLTimeLocal() 6043 @*/ 6044 PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime) 6045 { 6046 PetscErrorCode ierr; 6047 6048 PetscFunctionBegin; 6049 if (ts->cfltime < 0) { 6050 ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 6051 } 6052 *cfltime = ts->cfltime; 6053 PetscFunctionReturn(0); 6054 } 6055 6056 #undef __FUNCT__ 6057 #define __FUNCT__ "TSVISetVariableBounds" 6058 /*@ 6059 TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu 6060 6061 Input Parameters: 6062 . ts - the TS context. 6063 . xl - lower bound. 6064 . xu - upper bound. 6065 6066 Notes: 6067 If this routine is not called then the lower and upper bounds are set to 6068 PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp(). 6069 6070 Level: advanced 6071 6072 @*/ 6073 PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu) 6074 { 6075 PetscErrorCode ierr; 6076 SNES snes; 6077 6078 PetscFunctionBegin; 6079 ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 6080 ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr); 6081 PetscFunctionReturn(0); 6082 } 6083 6084 #if defined(PETSC_HAVE_MATLAB_ENGINE) 6085 #include <mex.h> 6086 6087 typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext; 6088 6089 #undef __FUNCT__ 6090 #define __FUNCT__ "TSComputeFunction_Matlab" 6091 /* 6092 TSComputeFunction_Matlab - Calls the function that has been set with 6093 TSSetFunctionMatlab(). 6094 6095 Collective on TS 6096 6097 Input Parameters: 6098 + snes - the TS context 6099 - u - input vector 6100 6101 Output Parameter: 6102 . y - function vector, as set by TSSetFunction() 6103 6104 Notes: 6105 TSComputeFunction() is typically used within nonlinear solvers 6106 implementations, so most users would not generally call this routine 6107 themselves. 6108 6109 Level: developer 6110 6111 .keywords: TS, nonlinear, compute, function 6112 6113 .seealso: TSSetFunction(), TSGetFunction() 6114 */ 6115 PetscErrorCode TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx) 6116 { 6117 PetscErrorCode ierr; 6118 TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6119 int nlhs = 1,nrhs = 7; 6120 mxArray *plhs[1],*prhs[7]; 6121 long long int lx = 0,lxdot = 0,ly = 0,ls = 0; 6122 6123 PetscFunctionBegin; 6124 PetscValidHeaderSpecific(snes,TS_CLASSID,1); 6125 PetscValidHeaderSpecific(u,VEC_CLASSID,3); 6126 PetscValidHeaderSpecific(udot,VEC_CLASSID,4); 6127 PetscValidHeaderSpecific(y,VEC_CLASSID,5); 6128 PetscCheckSameComm(snes,1,u,3); 6129 PetscCheckSameComm(snes,1,y,5); 6130 6131 ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 6132 ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 6133 ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr); 6134 ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr); 6135 6136 prhs[0] = mxCreateDoubleScalar((double)ls); 6137 prhs[1] = mxCreateDoubleScalar(time); 6138 prhs[2] = mxCreateDoubleScalar((double)lx); 6139 prhs[3] = mxCreateDoubleScalar((double)lxdot); 6140 prhs[4] = mxCreateDoubleScalar((double)ly); 6141 prhs[5] = mxCreateString(sctx->funcname); 6142 prhs[6] = sctx->ctx; 6143 ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr); 6144 ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6145 mxDestroyArray(prhs[0]); 6146 mxDestroyArray(prhs[1]); 6147 mxDestroyArray(prhs[2]); 6148 mxDestroyArray(prhs[3]); 6149 mxDestroyArray(prhs[4]); 6150 mxDestroyArray(prhs[5]); 6151 mxDestroyArray(plhs[0]); 6152 PetscFunctionReturn(0); 6153 } 6154 6155 6156 #undef __FUNCT__ 6157 #define __FUNCT__ "TSSetFunctionMatlab" 6158 /* 6159 TSSetFunctionMatlab - Sets the function evaluation routine and function 6160 vector for use by the TS routines in solving ODEs 6161 equations from MATLAB. Here the function is a string containing the name of a MATLAB function 6162 6163 Logically Collective on TS 6164 6165 Input Parameters: 6166 + ts - the TS context 6167 - func - function evaluation routine 6168 6169 Calling sequence of func: 6170 $ func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx); 6171 6172 Level: beginner 6173 6174 .keywords: TS, nonlinear, set, function 6175 6176 .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6177 */ 6178 PetscErrorCode TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx) 6179 { 6180 PetscErrorCode ierr; 6181 TSMatlabContext *sctx; 6182 6183 PetscFunctionBegin; 6184 /* currently sctx is memory bleed */ 6185 ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 6186 ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6187 /* 6188 This should work, but it doesn't 6189 sctx->ctx = ctx; 6190 mexMakeArrayPersistent(sctx->ctx); 6191 */ 6192 sctx->ctx = mxDuplicateArray(ctx); 6193 6194 ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr); 6195 PetscFunctionReturn(0); 6196 } 6197 6198 #undef __FUNCT__ 6199 #define __FUNCT__ "TSComputeJacobian_Matlab" 6200 /* 6201 TSComputeJacobian_Matlab - Calls the function that has been set with 6202 TSSetJacobianMatlab(). 6203 6204 Collective on TS 6205 6206 Input Parameters: 6207 + ts - the TS context 6208 . u - input vector 6209 . A, B - the matrices 6210 - ctx - user context 6211 6212 Level: developer 6213 6214 .keywords: TS, nonlinear, compute, function 6215 6216 .seealso: TSSetFunction(), TSGetFunction() 6217 @*/ 6218 PetscErrorCode TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx) 6219 { 6220 PetscErrorCode ierr; 6221 TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6222 int nlhs = 2,nrhs = 9; 6223 mxArray *plhs[2],*prhs[9]; 6224 long long int lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0; 6225 6226 PetscFunctionBegin; 6227 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6228 PetscValidHeaderSpecific(u,VEC_CLASSID,3); 6229 6230 /* call Matlab function in ctx with arguments u and y */ 6231 6232 ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 6233 ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 6234 ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr); 6235 ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr); 6236 ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr); 6237 6238 prhs[0] = mxCreateDoubleScalar((double)ls); 6239 prhs[1] = mxCreateDoubleScalar((double)time); 6240 prhs[2] = mxCreateDoubleScalar((double)lx); 6241 prhs[3] = mxCreateDoubleScalar((double)lxdot); 6242 prhs[4] = mxCreateDoubleScalar((double)shift); 6243 prhs[5] = mxCreateDoubleScalar((double)lA); 6244 prhs[6] = mxCreateDoubleScalar((double)lB); 6245 prhs[7] = mxCreateString(sctx->funcname); 6246 prhs[8] = sctx->ctx; 6247 ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr); 6248 ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6249 mxDestroyArray(prhs[0]); 6250 mxDestroyArray(prhs[1]); 6251 mxDestroyArray(prhs[2]); 6252 mxDestroyArray(prhs[3]); 6253 mxDestroyArray(prhs[4]); 6254 mxDestroyArray(prhs[5]); 6255 mxDestroyArray(prhs[6]); 6256 mxDestroyArray(prhs[7]); 6257 mxDestroyArray(plhs[0]); 6258 mxDestroyArray(plhs[1]); 6259 PetscFunctionReturn(0); 6260 } 6261 6262 6263 #undef __FUNCT__ 6264 #define __FUNCT__ "TSSetJacobianMatlab" 6265 /* 6266 TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 6267 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 6268 6269 Logically Collective on TS 6270 6271 Input Parameters: 6272 + ts - the TS context 6273 . A,B - Jacobian matrices 6274 . func - function evaluation routine 6275 - ctx - user context 6276 6277 Calling sequence of func: 6278 $ flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx); 6279 6280 6281 Level: developer 6282 6283 .keywords: TS, nonlinear, set, function 6284 6285 .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6286 */ 6287 PetscErrorCode TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx) 6288 { 6289 PetscErrorCode ierr; 6290 TSMatlabContext *sctx; 6291 6292 PetscFunctionBegin; 6293 /* currently sctx is memory bleed */ 6294 ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 6295 ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6296 /* 6297 This should work, but it doesn't 6298 sctx->ctx = ctx; 6299 mexMakeArrayPersistent(sctx->ctx); 6300 */ 6301 sctx->ctx = mxDuplicateArray(ctx); 6302 6303 ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 6304 PetscFunctionReturn(0); 6305 } 6306 6307 #undef __FUNCT__ 6308 #define __FUNCT__ "TSMonitor_Matlab" 6309 /* 6310 TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab(). 6311 6312 Collective on TS 6313 6314 .seealso: TSSetFunction(), TSGetFunction() 6315 @*/ 6316 PetscErrorCode TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx) 6317 { 6318 PetscErrorCode ierr; 6319 TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6320 int nlhs = 1,nrhs = 6; 6321 mxArray *plhs[1],*prhs[6]; 6322 long long int lx = 0,ls = 0; 6323 6324 PetscFunctionBegin; 6325 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6326 PetscValidHeaderSpecific(u,VEC_CLASSID,4); 6327 6328 ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 6329 ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 6330 6331 prhs[0] = mxCreateDoubleScalar((double)ls); 6332 prhs[1] = mxCreateDoubleScalar((double)it); 6333 prhs[2] = mxCreateDoubleScalar((double)time); 6334 prhs[3] = mxCreateDoubleScalar((double)lx); 6335 prhs[4] = mxCreateString(sctx->funcname); 6336 prhs[5] = sctx->ctx; 6337 ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr); 6338 ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6339 mxDestroyArray(prhs[0]); 6340 mxDestroyArray(prhs[1]); 6341 mxDestroyArray(prhs[2]); 6342 mxDestroyArray(prhs[3]); 6343 mxDestroyArray(prhs[4]); 6344 mxDestroyArray(plhs[0]); 6345 PetscFunctionReturn(0); 6346 } 6347 6348 6349 #undef __FUNCT__ 6350 #define __FUNCT__ "TSMonitorSetMatlab" 6351 /* 6352 TSMonitorSetMatlab - Sets the monitor function from Matlab 6353 6354 Level: developer 6355 6356 .keywords: TS, nonlinear, set, function 6357 6358 .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6359 */ 6360 PetscErrorCode TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx) 6361 { 6362 PetscErrorCode ierr; 6363 TSMatlabContext *sctx; 6364 6365 PetscFunctionBegin; 6366 /* currently sctx is memory bleed */ 6367 ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 6368 ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6369 /* 6370 This should work, but it doesn't 6371 sctx->ctx = ctx; 6372 mexMakeArrayPersistent(sctx->ctx); 6373 */ 6374 sctx->ctx = mxDuplicateArray(ctx); 6375 6376 ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr); 6377 PetscFunctionReturn(0); 6378 } 6379 #endif 6380 6381 #undef __FUNCT__ 6382 #define __FUNCT__ "TSMonitorLGSolution" 6383 /*@C 6384 TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector 6385 in a time based line graph 6386 6387 Collective on TS 6388 6389 Input Parameters: 6390 + ts - the TS context 6391 . step - current time-step 6392 . ptime - current time 6393 . u - current solution 6394 - dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate() 6395 6396 Options Database: 6397 . -ts_monitor_lg_solution_variables 6398 6399 Level: intermediate 6400 6401 Notes: Each process in a parallel run displays its component solutions in a separate window 6402 6403 .keywords: TS, vector, monitor, view 6404 6405 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(), 6406 TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(), 6407 TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(), 6408 TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop() 6409 @*/ 6410 PetscErrorCode TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 6411 { 6412 PetscErrorCode ierr; 6413 TSMonitorLGCtx ctx = (TSMonitorLGCtx)dctx; 6414 const PetscScalar *yy; 6415 Vec v; 6416 6417 PetscFunctionBegin; 6418 if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 6419 if (!step) { 6420 PetscDrawAxis axis; 6421 PetscInt dim; 6422 ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 6423 ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr); 6424 if (ctx->names && !ctx->displaynames) { 6425 char **displaynames; 6426 PetscBool flg; 6427 ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 6428 ierr = PetscMalloc((dim+1)*sizeof(char*),&displaynames);CHKERRQ(ierr); 6429 ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr); 6430 ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr); 6431 if (flg) { 6432 ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr); 6433 } 6434 ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr); 6435 } 6436 if (ctx->displaynames) { 6437 ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr); 6438 ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr); 6439 } else if (ctx->names) { 6440 ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 6441 ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6442 ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr); 6443 } else { 6444 ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 6445 ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6446 } 6447 ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 6448 } 6449 6450 if (!ctx->transform) v = u; 6451 else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);} 6452 ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr); 6453 if (ctx->displaynames) { 6454 PetscInt i; 6455 for (i=0; i<ctx->ndisplayvariables; i++) 6456 ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]); 6457 ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr); 6458 } else { 6459 #if defined(PETSC_USE_COMPLEX) 6460 PetscInt i,n; 6461 PetscReal *yreal; 6462 ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr); 6463 ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 6464 for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 6465 ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 6466 ierr = PetscFree(yreal);CHKERRQ(ierr); 6467 #else 6468 ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 6469 #endif 6470 } 6471 ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr); 6472 if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);} 6473 6474 if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 6475 ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 6476 ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 6477 } 6478 PetscFunctionReturn(0); 6479 } 6480 6481 6482 #undef __FUNCT__ 6483 #define __FUNCT__ "TSMonitorLGSetVariableNames" 6484 /*@C 6485 TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot 6486 6487 Collective on TS 6488 6489 Input Parameters: 6490 + ts - the TS context 6491 - names - the names of the components, final string must be NULL 6492 6493 Level: intermediate 6494 6495 Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 6496 6497 .keywords: TS, vector, monitor, view 6498 6499 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames() 6500 @*/ 6501 PetscErrorCode TSMonitorLGSetVariableNames(TS ts,const char * const *names) 6502 { 6503 PetscErrorCode ierr; 6504 PetscInt i; 6505 6506 PetscFunctionBegin; 6507 for (i=0; i<ts->numbermonitors; i++) { 6508 if (ts->monitor[i] == TSMonitorLGSolution) { 6509 ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr); 6510 break; 6511 } 6512 } 6513 PetscFunctionReturn(0); 6514 } 6515 6516 #undef __FUNCT__ 6517 #define __FUNCT__ "TSMonitorLGCtxSetVariableNames" 6518 /*@C 6519 TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot 6520 6521 Collective on TS 6522 6523 Input Parameters: 6524 + ts - the TS context 6525 - names - the names of the components, final string must be NULL 6526 6527 Level: intermediate 6528 6529 .keywords: TS, vector, monitor, view 6530 6531 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames() 6532 @*/ 6533 PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names) 6534 { 6535 PetscErrorCode ierr; 6536 6537 PetscFunctionBegin; 6538 ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr); 6539 ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr); 6540 PetscFunctionReturn(0); 6541 } 6542 6543 #undef __FUNCT__ 6544 #define __FUNCT__ "TSMonitorLGGetVariableNames" 6545 /*@C 6546 TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot 6547 6548 Collective on TS 6549 6550 Input Parameter: 6551 . ts - the TS context 6552 6553 Output Parameter: 6554 . names - the names of the components, final string must be NULL 6555 6556 Level: intermediate 6557 6558 Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 6559 6560 .keywords: TS, vector, monitor, view 6561 6562 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables() 6563 @*/ 6564 PetscErrorCode TSMonitorLGGetVariableNames(TS ts,const char *const **names) 6565 { 6566 PetscInt i; 6567 6568 PetscFunctionBegin; 6569 *names = NULL; 6570 for (i=0; i<ts->numbermonitors; i++) { 6571 if (ts->monitor[i] == TSMonitorLGSolution) { 6572 TSMonitorLGCtx ctx = (TSMonitorLGCtx) ts->monitorcontext[i]; 6573 *names = (const char *const *)ctx->names; 6574 break; 6575 } 6576 } 6577 PetscFunctionReturn(0); 6578 } 6579 6580 #undef __FUNCT__ 6581 #define __FUNCT__ "TSMonitorLGCtxSetDisplayVariables" 6582 /*@C 6583 TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor 6584 6585 Collective on TS 6586 6587 Input Parameters: 6588 + ctx - the TSMonitorLG context 6589 . displaynames - the names of the components, final string must be NULL 6590 6591 Level: intermediate 6592 6593 .keywords: TS, vector, monitor, view 6594 6595 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames() 6596 @*/ 6597 PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames) 6598 { 6599 PetscInt j = 0,k; 6600 PetscErrorCode ierr; 6601 6602 PetscFunctionBegin; 6603 if (!ctx->names) PetscFunctionReturn(0); 6604 ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr); 6605 ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr); 6606 while (displaynames[j]) j++; 6607 ctx->ndisplayvariables = j; 6608 ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr); 6609 ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr); 6610 j = 0; 6611 while (displaynames[j]) { 6612 k = 0; 6613 while (ctx->names[k]) { 6614 PetscBool flg; 6615 ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr); 6616 if (flg) { 6617 ctx->displayvariables[j] = k; 6618 break; 6619 } 6620 k++; 6621 } 6622 j++; 6623 } 6624 PetscFunctionReturn(0); 6625 } 6626 6627 6628 #undef __FUNCT__ 6629 #define __FUNCT__ "TSMonitorLGSetDisplayVariables" 6630 /*@C 6631 TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor 6632 6633 Collective on TS 6634 6635 Input Parameters: 6636 + ts - the TS context 6637 . displaynames - the names of the components, final string must be NULL 6638 6639 Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 6640 6641 Level: intermediate 6642 6643 .keywords: TS, vector, monitor, view 6644 6645 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames() 6646 @*/ 6647 PetscErrorCode TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames) 6648 { 6649 PetscInt i; 6650 PetscErrorCode ierr; 6651 6652 PetscFunctionBegin; 6653 for (i=0; i<ts->numbermonitors; i++) { 6654 if (ts->monitor[i] == TSMonitorLGSolution) { 6655 ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr); 6656 break; 6657 } 6658 } 6659 PetscFunctionReturn(0); 6660 } 6661 6662 #undef __FUNCT__ 6663 #define __FUNCT__ "TSMonitorLGSetTransform" 6664 /*@C 6665 TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed 6666 6667 Collective on TS 6668 6669 Input Parameters: 6670 + ts - the TS context 6671 . transform - the transform function 6672 . destroy - function to destroy the optional context 6673 - ctx - optional context used by transform function 6674 6675 Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 6676 6677 Level: intermediate 6678 6679 .keywords: TS, vector, monitor, view 6680 6681 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform() 6682 @*/ 6683 PetscErrorCode TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 6684 { 6685 PetscInt i; 6686 PetscErrorCode ierr; 6687 6688 PetscFunctionBegin; 6689 for (i=0; i<ts->numbermonitors; i++) { 6690 if (ts->monitor[i] == TSMonitorLGSolution) { 6691 ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr); 6692 } 6693 } 6694 PetscFunctionReturn(0); 6695 } 6696 6697 #undef __FUNCT__ 6698 #define __FUNCT__ "TSMonitorLGCtxSetTransform" 6699 /*@C 6700 TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed 6701 6702 Collective on TSLGCtx 6703 6704 Input Parameters: 6705 + ts - the TS context 6706 . transform - the transform function 6707 . destroy - function to destroy the optional context 6708 - ctx - optional context used by transform function 6709 6710 Level: intermediate 6711 6712 .keywords: TS, vector, monitor, view 6713 6714 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform() 6715 @*/ 6716 PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 6717 { 6718 PetscFunctionBegin; 6719 ctx->transform = transform; 6720 ctx->transformdestroy = destroy; 6721 ctx->transformctx = tctx; 6722 PetscFunctionReturn(0); 6723 } 6724 6725 #undef __FUNCT__ 6726 #define __FUNCT__ "TSMonitorLGError" 6727 /*@C 6728 TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector 6729 in a time based line graph 6730 6731 Collective on TS 6732 6733 Input Parameters: 6734 + ts - the TS context 6735 . step - current time-step 6736 . ptime - current time 6737 . u - current solution 6738 - dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate() 6739 6740 Level: intermediate 6741 6742 Notes: Each process in a parallel run displays its component errors in a separate window 6743 6744 The user must provide the solution using TSSetSolutionFunction() to use this monitor. 6745 6746 Options Database Keys: 6747 . -ts_monitor_lg_error - create a graphical monitor of error history 6748 6749 .keywords: TS, vector, monitor, view 6750 6751 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 6752 @*/ 6753 PetscErrorCode TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 6754 { 6755 PetscErrorCode ierr; 6756 TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 6757 const PetscScalar *yy; 6758 Vec y; 6759 6760 PetscFunctionBegin; 6761 if (!step) { 6762 PetscDrawAxis axis; 6763 PetscInt dim; 6764 ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 6765 ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr); 6766 ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 6767 ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6768 ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 6769 } 6770 ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 6771 ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr); 6772 ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr); 6773 ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr); 6774 #if defined(PETSC_USE_COMPLEX) 6775 { 6776 PetscReal *yreal; 6777 PetscInt i,n; 6778 ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr); 6779 ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 6780 for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 6781 ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 6782 ierr = PetscFree(yreal);CHKERRQ(ierr); 6783 } 6784 #else 6785 ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 6786 #endif 6787 ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr); 6788 ierr = VecDestroy(&y);CHKERRQ(ierr); 6789 if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 6790 ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 6791 ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 6792 } 6793 PetscFunctionReturn(0); 6794 } 6795 6796 #undef __FUNCT__ 6797 #define __FUNCT__ "TSMonitorLGSNESIterations" 6798 PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 6799 { 6800 TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 6801 PetscReal x = ptime,y; 6802 PetscErrorCode ierr; 6803 PetscInt its; 6804 6805 PetscFunctionBegin; 6806 if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 6807 if (!n) { 6808 PetscDrawAxis axis; 6809 ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 6810 ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr); 6811 ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 6812 ctx->snes_its = 0; 6813 } 6814 ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr); 6815 y = its - ctx->snes_its; 6816 ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 6817 if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 6818 ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 6819 ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 6820 } 6821 ctx->snes_its = its; 6822 PetscFunctionReturn(0); 6823 } 6824 6825 #undef __FUNCT__ 6826 #define __FUNCT__ "TSMonitorLGKSPIterations" 6827 PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 6828 { 6829 TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 6830 PetscReal x = ptime,y; 6831 PetscErrorCode ierr; 6832 PetscInt its; 6833 6834 PetscFunctionBegin; 6835 if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 6836 if (!n) { 6837 PetscDrawAxis axis; 6838 ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 6839 ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr); 6840 ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 6841 ctx->ksp_its = 0; 6842 } 6843 ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr); 6844 y = its - ctx->ksp_its; 6845 ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 6846 if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 6847 ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 6848 ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 6849 } 6850 ctx->ksp_its = its; 6851 PetscFunctionReturn(0); 6852 } 6853 6854 #undef __FUNCT__ 6855 #define __FUNCT__ "TSComputeLinearStability" 6856 /*@ 6857 TSComputeLinearStability - computes the linear stability function at a point 6858 6859 Collective on TS and Vec 6860 6861 Input Parameters: 6862 + ts - the TS context 6863 - xr,xi - real and imaginary part of input arguments 6864 6865 Output Parameters: 6866 . yr,yi - real and imaginary part of function value 6867 6868 Level: developer 6869 6870 .keywords: TS, compute 6871 6872 .seealso: TSSetRHSFunction(), TSComputeIFunction() 6873 @*/ 6874 PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi) 6875 { 6876 PetscErrorCode ierr; 6877 6878 PetscFunctionBegin; 6879 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6880 if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method"); 6881 ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr); 6882 PetscFunctionReturn(0); 6883 } 6884 6885 /* ------------------------------------------------------------------------*/ 6886 #undef __FUNCT__ 6887 #define __FUNCT__ "TSMonitorEnvelopeCtxCreate" 6888 /*@C 6889 TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope() 6890 6891 Collective on TS 6892 6893 Input Parameters: 6894 . ts - the ODE solver object 6895 6896 Output Parameter: 6897 . ctx - the context 6898 6899 Level: intermediate 6900 6901 .keywords: TS, monitor, line graph, residual, seealso 6902 6903 .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError() 6904 6905 @*/ 6906 PetscErrorCode TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx) 6907 { 6908 PetscErrorCode ierr; 6909 6910 PetscFunctionBegin; 6911 ierr = PetscNew(ctx);CHKERRQ(ierr); 6912 PetscFunctionReturn(0); 6913 } 6914 6915 #undef __FUNCT__ 6916 #define __FUNCT__ "TSMonitorEnvelope" 6917 /*@C 6918 TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution 6919 6920 Collective on TS 6921 6922 Input Parameters: 6923 + ts - the TS context 6924 . step - current time-step 6925 . ptime - current time 6926 . u - current solution 6927 - dctx - the envelope context 6928 6929 Options Database: 6930 . -ts_monitor_envelope 6931 6932 Level: intermediate 6933 6934 Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope 6935 6936 .keywords: TS, vector, monitor, view 6937 6938 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate() 6939 @*/ 6940 PetscErrorCode TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 6941 { 6942 PetscErrorCode ierr; 6943 TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx; 6944 6945 PetscFunctionBegin; 6946 if (!ctx->max) { 6947 ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr); 6948 ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr); 6949 ierr = VecCopy(u,ctx->max);CHKERRQ(ierr); 6950 ierr = VecCopy(u,ctx->min);CHKERRQ(ierr); 6951 } else { 6952 ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr); 6953 ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr); 6954 } 6955 PetscFunctionReturn(0); 6956 } 6957 6958 6959 #undef __FUNCT__ 6960 #define __FUNCT__ "TSMonitorEnvelopeGetBounds" 6961 /*@C 6962 TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution 6963 6964 Collective on TS 6965 6966 Input Parameter: 6967 . ts - the TS context 6968 6969 Output Parameter: 6970 + max - the maximum values 6971 - min - the minimum values 6972 6973 Notes: If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored 6974 6975 Level: intermediate 6976 6977 .keywords: TS, vector, monitor, view 6978 6979 .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables() 6980 @*/ 6981 PetscErrorCode TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min) 6982 { 6983 PetscInt i; 6984 6985 PetscFunctionBegin; 6986 if (max) *max = NULL; 6987 if (min) *min = NULL; 6988 for (i=0; i<ts->numbermonitors; i++) { 6989 if (ts->monitor[i] == TSMonitorEnvelope) { 6990 TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i]; 6991 if (max) *max = ctx->max; 6992 if (min) *min = ctx->min; 6993 break; 6994 } 6995 } 6996 PetscFunctionReturn(0); 6997 } 6998 6999 #undef __FUNCT__ 7000 #define __FUNCT__ "TSMonitorEnvelopeCtxDestroy" 7001 /*@C 7002 TSMonitorEnvelopeCtxDestroy - Destroys a context that was created with TSMonitorEnvelopeCtxCreate(). 7003 7004 Collective on TSMonitorEnvelopeCtx 7005 7006 Input Parameter: 7007 . ctx - the monitor context 7008 7009 Level: intermediate 7010 7011 .keywords: TS, monitor, line graph, destroy 7012 7013 .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep() 7014 @*/ 7015 PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx) 7016 { 7017 PetscErrorCode ierr; 7018 7019 PetscFunctionBegin; 7020 ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr); 7021 ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr); 7022 ierr = PetscFree(*ctx);CHKERRQ(ierr); 7023 PetscFunctionReturn(0); 7024 } 7025 7026 #undef __FUNCT__ 7027 #define __FUNCT__ "TSRollBack" 7028 /*@ 7029 TSRollBack - Rolls back one time step 7030 7031 Collective on TS 7032 7033 Input Parameter: 7034 . ts - the TS context obtained from TSCreate() 7035 7036 Level: advanced 7037 7038 .keywords: TS, timestep, rollback 7039 7040 .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate() 7041 @*/ 7042 PetscErrorCode TSRollBack(TS ts) 7043 { 7044 PetscErrorCode ierr; 7045 7046 PetscFunctionBegin; 7047 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7048 if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called"); 7049 if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name); 7050 ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr); 7051 ts->time_step = ts->ptime - ts->ptime_prev; 7052 ts->ptime = ts->ptime_prev; 7053 ts->ptime_prev = ts->ptime_prev_rollback; 7054 ts->steps--; ts->total_steps--; 7055 ts->steprollback = PETSC_TRUE; 7056 PetscFunctionReturn(0); 7057 } 7058 7059 #undef __FUNCT__ 7060 #define __FUNCT__ "TSGetStages" 7061 /*@ 7062 TSGetStages - Get the number of stages and stage values 7063 7064 Input Parameter: 7065 . ts - the TS context obtained from TSCreate() 7066 7067 Level: advanced 7068 7069 .keywords: TS, getstages 7070 7071 .seealso: TSCreate() 7072 @*/ 7073 PetscErrorCode TSGetStages(TS ts,PetscInt *ns,Vec **Y) 7074 { 7075 PetscErrorCode ierr; 7076 7077 PetscFunctionBegin; 7078 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7079 PetscValidPointer(ns,2); 7080 7081 if (!ts->ops->getstages) *ns=0; 7082 else { 7083 ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr); 7084 } 7085 PetscFunctionReturn(0); 7086 } 7087 7088 #undef __FUNCT__ 7089 #define __FUNCT__ "TSComputeIJacobianDefaultColor" 7090 /*@C 7091 TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity. 7092 7093 Collective on SNES 7094 7095 Input Parameters: 7096 + ts - the TS context 7097 . t - current timestep 7098 . U - state vector 7099 . Udot - time derivative of state vector 7100 . shift - shift to apply, see note below 7101 - ctx - an optional user context 7102 7103 Output Parameters: 7104 + J - Jacobian matrix (not altered in this routine) 7105 - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J) 7106 7107 Level: intermediate 7108 7109 Notes: 7110 If F(t,U,Udot)=0 is the DAE, the required Jacobian is 7111 7112 dF/dU + shift*dF/dUdot 7113 7114 Most users should not need to explicitly call this routine, as it 7115 is used internally within the nonlinear solvers. 7116 7117 This will first try to get the coloring from the DM. If the DM type has no coloring 7118 routine, then it will try to get the coloring from the matrix. This requires that the 7119 matrix have nonzero entries precomputed. 7120 7121 .keywords: TS, finite differences, Jacobian, coloring, sparse 7122 .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction() 7123 @*/ 7124 PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx) 7125 { 7126 SNES snes; 7127 MatFDColoring color; 7128 PetscBool hascolor, matcolor = PETSC_FALSE; 7129 PetscErrorCode ierr; 7130 7131 PetscFunctionBegin; 7132 ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr); 7133 ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr); 7134 if (!color) { 7135 DM dm; 7136 ISColoring iscoloring; 7137 7138 ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 7139 ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr); 7140 if (hascolor && !matcolor) { 7141 ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr); 7142 ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 7143 ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 7144 ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 7145 ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 7146 ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 7147 } else { 7148 MatColoring mc; 7149 7150 ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr); 7151 ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr); 7152 ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr); 7153 ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr); 7154 ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr); 7155 ierr = MatColoringDestroy(&mc);CHKERRQ(ierr); 7156 ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 7157 ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 7158 ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 7159 ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 7160 ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 7161 } 7162 ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr); 7163 ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr); 7164 } 7165 ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr); 7166 ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr); 7167 if (J != B) { 7168 ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 7169 ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 7170 } 7171 PetscFunctionReturn(0); 7172 } 7173 7174 #undef __FUNCT__ 7175 #define __FUNCT__ "TSSetFunctionDomainError" 7176 /*@ 7177 TSSetFunctionDomainError - Set the function testing if the current state vector is valid 7178 7179 Input Parameters: 7180 ts - the TS context 7181 func - function called within TSFunctionDomainError 7182 7183 Level: intermediate 7184 7185 .keywords: TS, state, domain 7186 .seealso: TSAdaptCheckStage(), TSFunctionDomainError() 7187 @*/ 7188 7189 PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*)) 7190 { 7191 PetscFunctionBegin; 7192 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7193 ts->functiondomainerror = func; 7194 PetscFunctionReturn(0); 7195 } 7196 7197 #undef __FUNCT__ 7198 #define __FUNCT__ "TSFunctionDomainError" 7199 /*@ 7200 TSFunctionDomainError - Check if the current state is valid 7201 7202 Input Parameters: 7203 ts - the TS context 7204 stagetime - time of the simulation 7205 Y - state vector to check. 7206 7207 Output Parameter: 7208 accept - Set to PETSC_FALSE if the current state vector is valid. 7209 7210 Note: 7211 This function should be used to ensure the state is in a valid part of the space. 7212 For example, one can ensure here all values are positive. 7213 7214 Level: advanced 7215 @*/ 7216 PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept) 7217 { 7218 PetscErrorCode ierr; 7219 7220 PetscFunctionBegin; 7221 7222 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7223 *accept = PETSC_TRUE; 7224 if (ts->functiondomainerror) { 7225 PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept)); 7226 } 7227 PetscFunctionReturn(0); 7228 } 7229 7230 #undef __FUNCT__ 7231 #define __FUNCT__ "TSClone" 7232 /*@C 7233 TSClone - This function clones a time step object. 7234 7235 Collective on MPI_Comm 7236 7237 Input Parameter: 7238 . tsin - The input TS 7239 7240 Output Parameter: 7241 . tsout - The output TS (cloned) 7242 7243 Notes: 7244 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. 7245 7246 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); 7247 7248 Level: developer 7249 7250 .keywords: TS, clone 7251 .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType() 7252 @*/ 7253 PetscErrorCode TSClone(TS tsin, TS *tsout) 7254 { 7255 TS t; 7256 PetscErrorCode ierr; 7257 SNES snes_start; 7258 DM dm; 7259 TSType type; 7260 7261 PetscFunctionBegin; 7262 PetscValidPointer(tsin,1); 7263 *tsout = NULL; 7264 7265 ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr); 7266 7267 /* General TS description */ 7268 t->numbermonitors = 0; 7269 t->setupcalled = 0; 7270 t->ksp_its = 0; 7271 t->snes_its = 0; 7272 t->nwork = 0; 7273 t->rhsjacobian.time = -1e20; 7274 t->rhsjacobian.scale = 1.; 7275 t->ijacobian.shift = 1.; 7276 7277 ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr); 7278 ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr); 7279 7280 ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr); 7281 ierr = TSSetDM(t,dm);CHKERRQ(ierr); 7282 7283 t->adapt = tsin->adapt; 7284 ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr); 7285 7286 t->problem_type = tsin->problem_type; 7287 t->ptime = tsin->ptime; 7288 t->time_step = tsin->time_step; 7289 t->max_time = tsin->max_time; 7290 t->steps = tsin->steps; 7291 t->max_steps = tsin->max_steps; 7292 t->equation_type = tsin->equation_type; 7293 t->atol = tsin->atol; 7294 t->rtol = tsin->rtol; 7295 t->max_snes_failures = tsin->max_snes_failures; 7296 t->max_reject = tsin->max_reject; 7297 t->errorifstepfailed = tsin->errorifstepfailed; 7298 7299 ierr = TSGetType(tsin,&type);CHKERRQ(ierr); 7300 ierr = TSSetType(t,type);CHKERRQ(ierr); 7301 7302 t->vec_sol = NULL; 7303 7304 t->cfltime = tsin->cfltime; 7305 t->cfltime_local = tsin->cfltime_local; 7306 t->exact_final_time = tsin->exact_final_time; 7307 7308 ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr); 7309 7310 if (((PetscObject)tsin)->fortran_func_pointers) { 7311 PetscInt i; 7312 ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr); 7313 for (i=0; i<10; i++) { 7314 ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i]; 7315 } 7316 } 7317 *tsout = t; 7318 PetscFunctionReturn(0); 7319 } 7320