163dd3a1aSKris Buschelman 2b45d2f2cSJed Brown #include <petsc-private/tsimpl.h> /*I "petscts.h" I*/ 3496e6a7aSJed Brown #include <petscdmshell.h> 41e25c274SJed Brown #include <petscdmda.h> 52d5ee99bSBarry Smith #include <petscviewer.h> 62d5ee99bSBarry Smith #include <petscdraw.h> 7d763cef2SBarry Smith 8d5ba7fb7SMatthew Knepley /* Logging support */ 9d74926cbSBarry Smith PetscClassId TS_CLASSID, DMTS_CLASSID; 10166c7f25SBarry Smith PetscLogEvent TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval; 11d405a339SMatthew Knepley 1249354f04SShri Abhyankar const char *const TSExactFinalTimeOptions[] = {"STEPOVER","INTERPOLATE","MATCHSTEP","TSExactFinalTimeOption","TS_EXACTFINALTIME_",0}; 1349354f04SShri Abhyankar 144a2ae208SSatish Balay #undef __FUNCT__ 15bdad233fSMatthew Knepley #define __FUNCT__ "TSSetTypeFromOptions" 16bdad233fSMatthew Knepley /* 17bdad233fSMatthew Knepley TSSetTypeFromOptions - Sets the type of ts from user options. 18bdad233fSMatthew Knepley 19bdad233fSMatthew Knepley Collective on TS 20bdad233fSMatthew Knepley 21bdad233fSMatthew Knepley Input Parameter: 22bdad233fSMatthew Knepley . ts - The ts 23bdad233fSMatthew Knepley 24bdad233fSMatthew Knepley Level: intermediate 25bdad233fSMatthew Knepley 26bdad233fSMatthew Knepley .keywords: TS, set, options, database, type 27bdad233fSMatthew Knepley .seealso: TSSetFromOptions(), TSSetType() 28bdad233fSMatthew Knepley */ 296849ba73SBarry Smith static PetscErrorCode TSSetTypeFromOptions(TS ts) 30bdad233fSMatthew Knepley { 31ace3abfcSBarry Smith PetscBool opt; 322fc52814SBarry Smith const char *defaultType; 33bdad233fSMatthew Knepley char typeName[256]; 34dfbe8321SBarry Smith PetscErrorCode ierr; 35bdad233fSMatthew Knepley 36bdad233fSMatthew Knepley PetscFunctionBegin; 37bbd56ea5SKarl Rupp if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name; 38bbd56ea5SKarl Rupp else defaultType = TSEULER; 39bdad233fSMatthew Knepley 40607a6623SBarry Smith if (!TSRegisterAllCalled) {ierr = TSRegisterAll();CHKERRQ(ierr);} 41bdad233fSMatthew Knepley ierr = PetscOptionsList("-ts_type", "TS method"," TSSetType", TSList, defaultType, typeName, 256, &opt);CHKERRQ(ierr); 42a7cc72afSBarry Smith if (opt) { 43bdad233fSMatthew Knepley ierr = TSSetType(ts, typeName);CHKERRQ(ierr); 44bdad233fSMatthew Knepley } else { 45bdad233fSMatthew Knepley ierr = TSSetType(ts, defaultType);CHKERRQ(ierr); 46bdad233fSMatthew Knepley } 47bdad233fSMatthew Knepley PetscFunctionReturn(0); 48bdad233fSMatthew Knepley } 49bdad233fSMatthew Knepley 502d5ee99bSBarry Smith struct _n_TSMonitorDrawCtx { 512d5ee99bSBarry Smith PetscViewer viewer; 524b363babSBarry Smith PetscDrawAxis axis; 532d5ee99bSBarry Smith Vec initialsolution; 542d5ee99bSBarry Smith PetscBool showinitial; 552d5ee99bSBarry Smith PetscInt howoften; /* when > 0 uses step % howoften, when negative only final solution plotted */ 562d5ee99bSBarry Smith PetscBool showtimestepandtime; 572d5ee99bSBarry Smith int color; 582d5ee99bSBarry Smith }; 592d5ee99bSBarry Smith 60bdad233fSMatthew Knepley #undef __FUNCT__ 61bdad233fSMatthew Knepley #define __FUNCT__ "TSSetFromOptions" 62bdad233fSMatthew Knepley /*@ 63bdad233fSMatthew Knepley TSSetFromOptions - Sets various TS parameters from user options. 64bdad233fSMatthew Knepley 65bdad233fSMatthew Knepley Collective on TS 66bdad233fSMatthew Knepley 67bdad233fSMatthew Knepley Input Parameter: 68bdad233fSMatthew Knepley . ts - the TS context obtained from TSCreate() 69bdad233fSMatthew Knepley 70bdad233fSMatthew Knepley Options Database Keys: 714d91e141SJed Brown + -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSGL, TSSSP 72bdad233fSMatthew Knepley . -ts_max_steps maxsteps - maximum number of time-steps to take 733bca7d26SBarry Smith . -ts_final_time time - maximum time to compute to 74bdad233fSMatthew Knepley . -ts_dt dt - initial time step 75bdad233fSMatthew Knepley . -ts_monitor - print information at each timestep 76de06c3feSJed Brown . -ts_monitor_lg_timestep - Monitor timestep size graphically 77de06c3feSJed Brown . -ts_monitor_lg_solution - Monitor solution graphically 78de06c3feSJed Brown . -ts_monitor_lg_error - Monitor error graphically 79de06c3feSJed Brown . -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically 80de06c3feSJed Brown . -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically 81de06c3feSJed Brown . -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically 82de06c3feSJed Brown . -ts_monitor_draw_solution - Monitor solution graphically 832d5ee99bSBarry Smith . -ts_monitor_draw_solution_phase - Monitor solution graphically with phase diagram 84de06c3feSJed Brown . -ts_monitor_draw_error - Monitor error graphically 8591b97e58SBarry Smith . -ts_monitor_solution_binary <filename> - Save each solution to a binary file 8691b97e58SBarry Smith - -ts_monitor_solution_vtk <filename.vts> - Save each time step to a binary file, use filename-%%03D.vts 8791b97e58SBarry Smith 8891b97e58SBarry Smith Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified 89bdad233fSMatthew Knepley 90bdad233fSMatthew Knepley Level: beginner 91bdad233fSMatthew Knepley 92bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database 93bdad233fSMatthew Knepley 94a313700dSBarry Smith .seealso: TSGetType() 95bdad233fSMatthew Knepley @*/ 967087cfbeSBarry Smith PetscErrorCode TSSetFromOptions(TS ts) 97bdad233fSMatthew Knepley { 98ace3abfcSBarry Smith PetscBool opt,flg; 99dfbe8321SBarry Smith PetscErrorCode ierr; 100649052a6SBarry Smith PetscViewer monviewer; 101eabae89aSBarry Smith char monfilename[PETSC_MAX_PATH_LEN]; 102089b2837SJed Brown SNES snes; 1031c3436cfSJed Brown TSAdapt adapt; 10431748224SBarry Smith PetscReal time_step; 10549354f04SShri Abhyankar TSExactFinalTimeOption eftopt; 106d1212d36SBarry Smith char dir[16]; 107bdad233fSMatthew Knepley 108bdad233fSMatthew Knepley PetscFunctionBegin; 1090700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1103194b578SJed Brown ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr); 111a43b19c4SJed Brown /* Handle TS type options */ 112a43b19c4SJed Brown ierr = TSSetTypeFromOptions(ts);CHKERRQ(ierr); 113bdad233fSMatthew Knepley 114bdad233fSMatthew Knepley /* Handle generic TS options */ 1150298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr); 1160298fd71SBarry Smith ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr); 1170298fd71SBarry Smith ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr); 11831748224SBarry Smith ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr); 11931748224SBarry Smith if (flg) { 12031748224SBarry Smith ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 12131748224SBarry Smith } 12249354f04SShri Abhyankar ierr = PetscOptionsEnum("-ts_exact_final_time","Option for handling of final time step","TSSetExactFinalTime",TSExactFinalTimeOptions,(PetscEnum)ts->exact_final_time,(PetscEnum*)&eftopt,&flg);CHKERRQ(ierr); 12349354f04SShri Abhyankar if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);} 1240298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_snes_failures","Maximum number of nonlinear solve failures","TSSetMaxSNESFailures",ts->max_snes_failures,&ts->max_snes_failures,NULL);CHKERRQ(ierr); 1250298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr); 1260298fd71SBarry Smith ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr); 1270298fd71SBarry Smith ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr); 1280298fd71SBarry Smith ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr); 129bdad233fSMatthew Knepley 130*56f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS) 131*56f85f32SBarry Smith { 132*56f85f32SBarry Smith PetscBool set; 133*56f85f32SBarry Smith flg = PETSC_FALSE; 134*56f85f32SBarry Smith ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr); 135*56f85f32SBarry Smith if (set) { 136*56f85f32SBarry Smith ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr); 137*56f85f32SBarry Smith } 138*56f85f32SBarry Smith } 139*56f85f32SBarry Smith #endif 140*56f85f32SBarry Smith 141bdad233fSMatthew Knepley /* Monitor options */ 142a6570f20SBarry Smith ierr = PetscOptionsString("-ts_monitor","Monitor timestep size","TSMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 143eabae89aSBarry Smith if (flg) { 144ce94432eSBarry Smith ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)ts),monfilename,&monviewer);CHKERRQ(ierr); 145649052a6SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 146bdad233fSMatthew Knepley } 1475180491cSLisandro Dalcin ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 1485180491cSLisandro Dalcin if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);} 1495180491cSLisandro Dalcin 1504f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr); 151a7cc72afSBarry Smith if (opt) { 1520b039ecaSBarry Smith TSMonitorLGCtx ctx; 1533923b477SBarry Smith PetscInt howoften = 1; 154a80ad3e0SBarry Smith 1550298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr); 156ce94432eSBarry Smith ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 1574f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 158b3603a34SBarry Smith } 1594f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr); 160b3603a34SBarry Smith if (opt) { 1610b039ecaSBarry Smith TSMonitorLGCtx ctx; 1623923b477SBarry Smith PetscInt howoften = 1; 163b3603a34SBarry Smith 1640298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 16522d28d08SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 1664f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 167bdad233fSMatthew Knepley } 1684f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr); 169ef20d060SBarry Smith if (opt) { 1700b039ecaSBarry Smith TSMonitorLGCtx ctx; 1713923b477SBarry Smith PetscInt howoften = 1; 172ef20d060SBarry Smith 1730298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr); 17422d28d08SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 1754f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 176ef20d060SBarry Smith } 177201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr); 178201da799SBarry Smith if (opt) { 179201da799SBarry Smith TSMonitorLGCtx ctx; 180201da799SBarry Smith PetscInt howoften = 1; 181201da799SBarry Smith 1820298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 18322d28d08SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 184201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 185201da799SBarry Smith } 186201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr); 187201da799SBarry Smith if (opt) { 188201da799SBarry Smith TSMonitorLGCtx ctx; 189201da799SBarry Smith PetscInt howoften = 1; 190201da799SBarry Smith 1910298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 19222d28d08SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 193201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 194201da799SBarry Smith } 1958189c53fSBarry Smith ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr); 1968189c53fSBarry Smith if (opt) { 1978189c53fSBarry Smith TSMonitorSPEigCtx ctx; 1988189c53fSBarry Smith PetscInt howoften = 1; 1998189c53fSBarry Smith 2000298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr); 20122d28d08SBarry Smith ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 2028189c53fSBarry Smith ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr); 2038189c53fSBarry Smith } 204ef20d060SBarry Smith opt = PETSC_FALSE; 2050dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr); 206a7cc72afSBarry Smith if (opt) { 20783a4ac43SBarry Smith TSMonitorDrawCtx ctx; 20883a4ac43SBarry Smith PetscInt howoften = 1; 209a80ad3e0SBarry Smith 2100298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 211ce94432eSBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 21283a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 213bdad233fSMatthew Knepley } 214fb1732b5SBarry Smith opt = PETSC_FALSE; 2152d5ee99bSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr); 2162d5ee99bSBarry Smith if (opt) { 2172d5ee99bSBarry Smith TSMonitorDrawCtx ctx; 2182d5ee99bSBarry Smith PetscReal bounds[4]; 2192d5ee99bSBarry Smith PetscInt n = 4; 2202d5ee99bSBarry Smith PetscDraw draw; 2212d5ee99bSBarry Smith 2222d5ee99bSBarry Smith ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr); 2232d5ee99bSBarry Smith if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field"); 2242d5ee99bSBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,1,&ctx);CHKERRQ(ierr); 2252d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr); 2262d5ee99bSBarry Smith ierr = PetscDrawClear(draw);CHKERRQ(ierr); 2274b363babSBarry Smith ierr = PetscDrawAxisCreate(draw,&ctx->axis);CHKERRQ(ierr); 2284b363babSBarry Smith ierr = PetscDrawAxisSetLimits(ctx->axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr); 229f54adfc0SBarry Smith ierr = PetscDrawAxisSetLabels(ctx->axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr); 2304b363babSBarry Smith ierr = PetscDrawAxisDraw(ctx->axis);CHKERRQ(ierr); 23107995780SPeter Brune /* ierr = PetscDrawSetCoordinates(draw,bounds[0],bounds[1],bounds[2],bounds[3]);CHKERRQ(ierr); */ 2322d5ee99bSBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 2332d5ee99bSBarry Smith } 2342d5ee99bSBarry Smith opt = PETSC_FALSE; 2350dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr); 2363a471f94SBarry Smith if (opt) { 23783a4ac43SBarry Smith TSMonitorDrawCtx ctx; 23883a4ac43SBarry Smith PetscInt howoften = 1; 2393a471f94SBarry Smith 2400298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr); 241ce94432eSBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 24283a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 2433a471f94SBarry Smith } 2443a471f94SBarry Smith opt = PETSC_FALSE; 24591b97e58SBarry Smith ierr = PetscOptionsString("-ts_monitor_solution_binary","Save each solution to a binary file","TSMonitorSolutionBinary",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 246fb1732b5SBarry Smith if (flg) { 247fb1732b5SBarry Smith PetscViewer ctx; 248fb1732b5SBarry Smith if (monfilename[0]) { 249ce94432eSBarry Smith ierr = PetscViewerBinaryOpen(PetscObjectComm((PetscObject)ts),monfilename,FILE_MODE_WRITE,&ctx);CHKERRQ(ierr); 250c2fbc07fSBarry Smith ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 251fb1732b5SBarry Smith } else { 252ce94432eSBarry Smith ctx = PETSC_VIEWER_BINARY_(PetscObjectComm((PetscObject)ts)); 2530298fd71SBarry Smith ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))NULL);CHKERRQ(ierr); 254fb1732b5SBarry Smith } 255fb1732b5SBarry Smith } 256ed81e22dSJed Brown opt = PETSC_FALSE; 25791b97e58SBarry Smith 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); 258ed81e22dSJed Brown if (flg) { 259ed81e22dSJed Brown const char *ptr,*ptr2; 260ed81e22dSJed Brown char *filetemplate; 261ce94432eSBarry Smith if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 262ed81e22dSJed Brown /* Do some cursory validation of the input. */ 263ed81e22dSJed Brown ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr); 264ce94432eSBarry Smith if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 265ed81e22dSJed Brown for (ptr++; ptr && *ptr; ptr++) { 266ed81e22dSJed Brown ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr); 267ce94432eSBarry Smith if (!ptr2 && (*ptr < '0' || '9' < *ptr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Invalid file template argument to -ts_monitor_solution_vtk, should look like filename-%%03D.vts"); 268ed81e22dSJed Brown if (ptr2) break; 269ed81e22dSJed Brown } 270ed81e22dSJed Brown ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr); 271ed81e22dSJed Brown ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr); 272ed81e22dSJed Brown } 273bdad233fSMatthew Knepley 274d1212d36SBarry Smith ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr); 275d1212d36SBarry Smith if (flg) { 276d1212d36SBarry Smith TSMonitorDMDARayCtx *rayctx; 277d1212d36SBarry Smith int ray = 0; 278d1212d36SBarry Smith DMDADirection ddir; 279d1212d36SBarry Smith DM da; 280d1212d36SBarry Smith PetscMPIInt rank; 281d1212d36SBarry Smith 282ce94432eSBarry Smith if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 283d1212d36SBarry Smith if (dir[0] == 'x') ddir = DMDA_X; 284d1212d36SBarry Smith else if (dir[0] == 'y') ddir = DMDA_Y; 285ce94432eSBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 286d1212d36SBarry Smith sscanf(dir+2,"%d",&ray); 287d1212d36SBarry Smith 288d1212d36SBarry Smith ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr); 289d1212d36SBarry Smith ierr = PetscNew(TSMonitorDMDARayCtx,&rayctx);CHKERRQ(ierr); 290d1212d36SBarry Smith ierr = TSGetDM(ts,&da);CHKERRQ(ierr); 291d1212d36SBarry Smith ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr); 292ce94432eSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr); 293d1212d36SBarry Smith if (!rank) { 294d1212d36SBarry Smith ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr); 295d1212d36SBarry Smith } 296d1212d36SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr); 297d1212d36SBarry Smith } 298d1212d36SBarry Smith 299552698daSJed Brown ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr); 3001c3436cfSJed Brown ierr = TSAdaptSetFromOptions(adapt);CHKERRQ(ierr); 3011c3436cfSJed Brown 302d52bd9f3SBarry Smith ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 303d52bd9f3SBarry Smith if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);} 304d52bd9f3SBarry Smith 305bdad233fSMatthew Knepley /* Handle specific TS options */ 306abc0a331SBarry Smith if (ts->ops->setfromoptions) { 307bdad233fSMatthew Knepley ierr = (*ts->ops->setfromoptions)(ts);CHKERRQ(ierr); 308bdad233fSMatthew Knepley } 3095d973c19SBarry Smith 3105d973c19SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 3115d973c19SBarry Smith ierr = PetscObjectProcessOptionsHandlers((PetscObject)ts);CHKERRQ(ierr); 312bdad233fSMatthew Knepley ierr = PetscOptionsEnd();CHKERRQ(ierr); 313bdad233fSMatthew Knepley PetscFunctionReturn(0); 314bdad233fSMatthew Knepley } 315bdad233fSMatthew Knepley 316bdad233fSMatthew Knepley #undef __FUNCT__ 317cdcf91faSSean Farley #undef __FUNCT__ 3184a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSJacobian" 319a7a1495cSBarry Smith /*@ 3208c385f81SBarry Smith TSComputeRHSJacobian - Computes the Jacobian matrix that has been 321a7a1495cSBarry Smith set with TSSetRHSJacobian(). 322a7a1495cSBarry Smith 323a7a1495cSBarry Smith Collective on TS and Vec 324a7a1495cSBarry Smith 325a7a1495cSBarry Smith Input Parameters: 326316643e7SJed Brown + ts - the TS context 327a7a1495cSBarry Smith . t - current timestep 3280910c330SBarry Smith - U - input vector 329a7a1495cSBarry Smith 330a7a1495cSBarry Smith Output Parameters: 331a7a1495cSBarry Smith + A - Jacobian matrix 332a7a1495cSBarry Smith . B - optional preconditioning matrix 333a7a1495cSBarry Smith - flag - flag indicating matrix structure 334a7a1495cSBarry Smith 335a7a1495cSBarry Smith Notes: 336a7a1495cSBarry Smith Most users should not need to explicitly call this routine, as it 337a7a1495cSBarry Smith is used internally within the nonlinear solvers. 338a7a1495cSBarry Smith 33994b7f48cSBarry Smith See KSPSetOperators() for important information about setting the 340a7a1495cSBarry Smith flag parameter. 341a7a1495cSBarry Smith 342a7a1495cSBarry Smith Level: developer 343a7a1495cSBarry Smith 344a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix 345a7a1495cSBarry Smith 34694b7f48cSBarry Smith .seealso: TSSetRHSJacobian(), KSPSetOperators() 347a7a1495cSBarry Smith @*/ 3480910c330SBarry Smith PetscErrorCode TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat *A,Mat *B,MatStructure *flg) 349a7a1495cSBarry Smith { 350dfbe8321SBarry Smith PetscErrorCode ierr; 3510910c330SBarry Smith PetscInt Ustate; 35224989b8cSPeter Brune DM dm; 353942e3340SBarry Smith DMTS tsdm; 35424989b8cSPeter Brune TSRHSJacobian rhsjacobianfunc; 35524989b8cSPeter Brune void *ctx; 35624989b8cSPeter Brune TSIJacobian ijacobianfunc; 357a7a1495cSBarry Smith 358a7a1495cSBarry Smith PetscFunctionBegin; 3590700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3600910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3610910c330SBarry Smith PetscCheckSameComm(ts,1,U,3); 36224989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 363942e3340SBarry Smith ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr); 36424989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr); 3650298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr); 3660910c330SBarry Smith ierr = PetscObjectStateQuery((PetscObject)U,&Ustate);CHKERRQ(ierr); 3670910c330SBarry Smith if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate))) { 3680e4ef248SJed Brown *flg = ts->rhsjacobian.mstructure; 3690e4ef248SJed Brown PetscFunctionReturn(0); 370f8ede8e7SJed Brown } 371d90be118SSean Farley 372ce94432eSBarry Smith if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 373d90be118SSean Farley 374e1244c69SJed Brown if (ts->rhsjacobian.reuse) { 375e1244c69SJed Brown ierr = MatShift(*A,-ts->rhsjacobian.shift);CHKERRQ(ierr); 376e1244c69SJed Brown ierr = MatScale(*A,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 377e1244c69SJed Brown if (*A != *B) { 378e1244c69SJed Brown ierr = MatShift(*B,-ts->rhsjacobian.shift);CHKERRQ(ierr); 379e1244c69SJed Brown ierr = MatScale(*B,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 380e1244c69SJed Brown } 381e1244c69SJed Brown ts->rhsjacobian.shift = 0; 382e1244c69SJed Brown ts->rhsjacobian.scale = 1.; 383e1244c69SJed Brown } 384e1244c69SJed Brown 38524989b8cSPeter Brune if (rhsjacobianfunc) { 3860910c330SBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,*A,*B);CHKERRQ(ierr); 387a7a1495cSBarry Smith *flg = DIFFERENT_NONZERO_PATTERN; 388a7a1495cSBarry Smith PetscStackPush("TS user Jacobian function"); 3890910c330SBarry Smith ierr = (*rhsjacobianfunc)(ts,t,U,A,B,flg,ctx);CHKERRQ(ierr); 390a7a1495cSBarry Smith PetscStackPop; 3910910c330SBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,*A,*B);CHKERRQ(ierr); 392a7a1495cSBarry Smith /* make sure user returned a correct Jacobian and preconditioner */ 3930700a824SBarry Smith PetscValidHeaderSpecific(*A,MAT_CLASSID,4); 3940700a824SBarry Smith PetscValidHeaderSpecific(*B,MAT_CLASSID,5); 395ef66eb69SBarry Smith } else { 396214bc6a2SJed Brown ierr = MatZeroEntries(*A);CHKERRQ(ierr); 397214bc6a2SJed Brown if (*A != *B) {ierr = MatZeroEntries(*B);CHKERRQ(ierr);} 398214bc6a2SJed Brown *flg = SAME_NONZERO_PATTERN; 399ef66eb69SBarry Smith } 4000e4ef248SJed Brown ts->rhsjacobian.time = t; 4010910c330SBarry Smith ts->rhsjacobian.X = U; 4020910c330SBarry Smith ierr = PetscObjectStateQuery((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr); 4030e4ef248SJed Brown ts->rhsjacobian.mstructure = *flg; 404a7a1495cSBarry Smith PetscFunctionReturn(0); 405a7a1495cSBarry Smith } 406a7a1495cSBarry Smith 4074a2ae208SSatish Balay #undef __FUNCT__ 4084a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction" 409316643e7SJed Brown /*@ 410d763cef2SBarry Smith TSComputeRHSFunction - Evaluates the right-hand-side function. 411d763cef2SBarry Smith 412316643e7SJed Brown Collective on TS and Vec 413316643e7SJed Brown 414316643e7SJed Brown Input Parameters: 415316643e7SJed Brown + ts - the TS context 416316643e7SJed Brown . t - current time 4170910c330SBarry Smith - U - state vector 418316643e7SJed Brown 419316643e7SJed Brown Output Parameter: 420316643e7SJed Brown . y - right hand side 421316643e7SJed Brown 422316643e7SJed Brown Note: 423316643e7SJed Brown Most users should not need to explicitly call this routine, as it 424316643e7SJed Brown is used internally within the nonlinear solvers. 425316643e7SJed Brown 426316643e7SJed Brown Level: developer 427316643e7SJed Brown 428316643e7SJed Brown .keywords: TS, compute 429316643e7SJed Brown 430316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction() 431316643e7SJed Brown @*/ 4320910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y) 433d763cef2SBarry Smith { 434dfbe8321SBarry Smith PetscErrorCode ierr; 43524989b8cSPeter Brune TSRHSFunction rhsfunction; 43624989b8cSPeter Brune TSIFunction ifunction; 43724989b8cSPeter Brune void *ctx; 43824989b8cSPeter Brune DM dm; 43924989b8cSPeter Brune 440d763cef2SBarry Smith PetscFunctionBegin; 4410700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4420910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 4430700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,4); 44424989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 44524989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 4460298fd71SBarry Smith ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr); 447d763cef2SBarry Smith 448ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 449d763cef2SBarry Smith 4500910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 45124989b8cSPeter Brune if (rhsfunction) { 452d763cef2SBarry Smith PetscStackPush("TS user right-hand-side function"); 4530910c330SBarry Smith ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr); 454d763cef2SBarry Smith PetscStackPop; 455214bc6a2SJed Brown } else { 456214bc6a2SJed Brown ierr = VecZeroEntries(y);CHKERRQ(ierr); 457b2cd27e8SJed Brown } 45844a41b28SSean Farley 4590910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 460d763cef2SBarry Smith PetscFunctionReturn(0); 461d763cef2SBarry Smith } 462d763cef2SBarry Smith 4634a2ae208SSatish Balay #undef __FUNCT__ 464ef20d060SBarry Smith #define __FUNCT__ "TSComputeSolutionFunction" 465ef20d060SBarry Smith /*@ 466ef20d060SBarry Smith TSComputeSolutionFunction - Evaluates the solution function. 467ef20d060SBarry Smith 468ef20d060SBarry Smith Collective on TS and Vec 469ef20d060SBarry Smith 470ef20d060SBarry Smith Input Parameters: 471ef20d060SBarry Smith + ts - the TS context 472ef20d060SBarry Smith - t - current time 473ef20d060SBarry Smith 474ef20d060SBarry Smith Output Parameter: 4750910c330SBarry Smith . U - the solution 476ef20d060SBarry Smith 477ef20d060SBarry Smith Note: 478ef20d060SBarry Smith Most users should not need to explicitly call this routine, as it 479ef20d060SBarry Smith is used internally within the nonlinear solvers. 480ef20d060SBarry Smith 481ef20d060SBarry Smith Level: developer 482ef20d060SBarry Smith 483ef20d060SBarry Smith .keywords: TS, compute 484ef20d060SBarry Smith 485abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 486ef20d060SBarry Smith @*/ 4870910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U) 488ef20d060SBarry Smith { 489ef20d060SBarry Smith PetscErrorCode ierr; 490ef20d060SBarry Smith TSSolutionFunction solutionfunction; 491ef20d060SBarry Smith void *ctx; 492ef20d060SBarry Smith DM dm; 493ef20d060SBarry Smith 494ef20d060SBarry Smith PetscFunctionBegin; 495ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4960910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 497ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 498ef20d060SBarry Smith ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr); 499ef20d060SBarry Smith 500ef20d060SBarry Smith if (solutionfunction) { 5019b7cd975SBarry Smith PetscStackPush("TS user solution function"); 5020910c330SBarry Smith ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr); 503ef20d060SBarry Smith PetscStackPop; 504ef20d060SBarry Smith } 505ef20d060SBarry Smith PetscFunctionReturn(0); 506ef20d060SBarry Smith } 5079b7cd975SBarry Smith #undef __FUNCT__ 5089b7cd975SBarry Smith #define __FUNCT__ "TSComputeForcingFunction" 5099b7cd975SBarry Smith /*@ 5109b7cd975SBarry Smith TSComputeForcingFunction - Evaluates the forcing function. 5119b7cd975SBarry Smith 5129b7cd975SBarry Smith Collective on TS and Vec 5139b7cd975SBarry Smith 5149b7cd975SBarry Smith Input Parameters: 5159b7cd975SBarry Smith + ts - the TS context 5169b7cd975SBarry Smith - t - current time 5179b7cd975SBarry Smith 5189b7cd975SBarry Smith Output Parameter: 5199b7cd975SBarry Smith . U - the function value 5209b7cd975SBarry Smith 5219b7cd975SBarry Smith Note: 5229b7cd975SBarry Smith Most users should not need to explicitly call this routine, as it 5239b7cd975SBarry Smith is used internally within the nonlinear solvers. 5249b7cd975SBarry Smith 5259b7cd975SBarry Smith Level: developer 5269b7cd975SBarry Smith 5279b7cd975SBarry Smith .keywords: TS, compute 5289b7cd975SBarry Smith 5299b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 5309b7cd975SBarry Smith @*/ 5319b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U) 5329b7cd975SBarry Smith { 5339b7cd975SBarry Smith PetscErrorCode ierr, (*forcing)(TS,PetscReal,Vec,void*); 5349b7cd975SBarry Smith void *ctx; 5359b7cd975SBarry Smith DM dm; 5369b7cd975SBarry Smith 5379b7cd975SBarry Smith PetscFunctionBegin; 5389b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5399b7cd975SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 5409b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 5419b7cd975SBarry Smith ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr); 5429b7cd975SBarry Smith 5439b7cd975SBarry Smith if (forcing) { 5449b7cd975SBarry Smith PetscStackPush("TS user forcing function"); 5459b7cd975SBarry Smith ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr); 5469b7cd975SBarry Smith PetscStackPop; 5479b7cd975SBarry Smith } 5489b7cd975SBarry Smith PetscFunctionReturn(0); 5499b7cd975SBarry Smith } 550ef20d060SBarry Smith 551ef20d060SBarry Smith #undef __FUNCT__ 552214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private" 553214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs) 554214bc6a2SJed Brown { 5552dd45cf8SJed Brown Vec F; 556214bc6a2SJed Brown PetscErrorCode ierr; 557214bc6a2SJed Brown 558214bc6a2SJed Brown PetscFunctionBegin; 5590298fd71SBarry Smith *Frhs = NULL; 5600298fd71SBarry Smith ierr = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr); 561214bc6a2SJed Brown if (!ts->Frhs) { 5622dd45cf8SJed Brown ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr); 563214bc6a2SJed Brown } 564214bc6a2SJed Brown *Frhs = ts->Frhs; 565214bc6a2SJed Brown PetscFunctionReturn(0); 566214bc6a2SJed Brown } 567214bc6a2SJed Brown 568214bc6a2SJed Brown #undef __FUNCT__ 569214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private" 570214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs) 571214bc6a2SJed Brown { 572214bc6a2SJed Brown Mat A,B; 5732dd45cf8SJed Brown PetscErrorCode ierr; 574214bc6a2SJed Brown 575214bc6a2SJed Brown PetscFunctionBegin; 5760298fd71SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 577214bc6a2SJed Brown if (Arhs) { 578214bc6a2SJed Brown if (!ts->Arhs) { 579214bc6a2SJed Brown ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr); 580214bc6a2SJed Brown } 581214bc6a2SJed Brown *Arhs = ts->Arhs; 582214bc6a2SJed Brown } 583214bc6a2SJed Brown if (Brhs) { 584214bc6a2SJed Brown if (!ts->Brhs) { 585214bc6a2SJed Brown ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr); 586214bc6a2SJed Brown } 587214bc6a2SJed Brown *Brhs = ts->Brhs; 588214bc6a2SJed Brown } 589214bc6a2SJed Brown PetscFunctionReturn(0); 590214bc6a2SJed Brown } 591214bc6a2SJed Brown 592214bc6a2SJed Brown #undef __FUNCT__ 593316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction" 594316643e7SJed Brown /*@ 5950910c330SBarry Smith TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0 596316643e7SJed Brown 597316643e7SJed Brown Collective on TS and Vec 598316643e7SJed Brown 599316643e7SJed Brown Input Parameters: 600316643e7SJed Brown + ts - the TS context 601316643e7SJed Brown . t - current time 6020910c330SBarry Smith . U - state vector 6030910c330SBarry Smith . Udot - time derivative of state vector 604214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate 605316643e7SJed Brown 606316643e7SJed Brown Output Parameter: 607316643e7SJed Brown . Y - right hand side 608316643e7SJed Brown 609316643e7SJed Brown Note: 610316643e7SJed Brown Most users should not need to explicitly call this routine, as it 611316643e7SJed Brown is used internally within the nonlinear solvers. 612316643e7SJed Brown 613316643e7SJed Brown If the user did did not write their equations in implicit form, this 614316643e7SJed Brown function recasts them in implicit form. 615316643e7SJed Brown 616316643e7SJed Brown Level: developer 617316643e7SJed Brown 618316643e7SJed Brown .keywords: TS, compute 619316643e7SJed Brown 620316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction() 621316643e7SJed Brown @*/ 6220910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex) 623316643e7SJed Brown { 624316643e7SJed Brown PetscErrorCode ierr; 62524989b8cSPeter Brune TSIFunction ifunction; 62624989b8cSPeter Brune TSRHSFunction rhsfunction; 62724989b8cSPeter Brune void *ctx; 62824989b8cSPeter Brune DM dm; 629316643e7SJed Brown 630316643e7SJed Brown PetscFunctionBegin; 6310700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6320910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 6330910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 6340700a824SBarry Smith PetscValidHeaderSpecific(Y,VEC_CLASSID,5); 635316643e7SJed Brown 63624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 63724989b8cSPeter Brune ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr); 6380298fd71SBarry Smith ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 63924989b8cSPeter Brune 640ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 641d90be118SSean Farley 6420910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 64324989b8cSPeter Brune if (ifunction) { 644316643e7SJed Brown PetscStackPush("TS user implicit function"); 6450910c330SBarry Smith ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr); 646316643e7SJed Brown PetscStackPop; 647214bc6a2SJed Brown } 648214bc6a2SJed Brown if (imex) { 64924989b8cSPeter Brune if (!ifunction) { 6500910c330SBarry Smith ierr = VecCopy(Udot,Y);CHKERRQ(ierr); 6512dd45cf8SJed Brown } 65224989b8cSPeter Brune } else if (rhsfunction) { 65324989b8cSPeter Brune if (ifunction) { 654214bc6a2SJed Brown Vec Frhs; 655214bc6a2SJed Brown ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 6560910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 657214bc6a2SJed Brown ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr); 6582dd45cf8SJed Brown } else { 6590910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr); 6600910c330SBarry Smith ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr); 661316643e7SJed Brown } 6624a6899ffSJed Brown } 6630910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 664316643e7SJed Brown PetscFunctionReturn(0); 665316643e7SJed Brown } 666316643e7SJed Brown 667316643e7SJed Brown #undef __FUNCT__ 668316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian" 669316643e7SJed Brown /*@ 670316643e7SJed Brown TSComputeIJacobian - Evaluates the Jacobian of the DAE 671316643e7SJed Brown 672316643e7SJed Brown Collective on TS and Vec 673316643e7SJed Brown 674316643e7SJed Brown Input 675316643e7SJed Brown Input Parameters: 676316643e7SJed Brown + ts - the TS context 677316643e7SJed Brown . t - current timestep 6780910c330SBarry Smith . U - state vector 6790910c330SBarry Smith . Udot - time derivative of state vector 680214bc6a2SJed Brown . shift - shift to apply, see note below 681214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate 682316643e7SJed Brown 683316643e7SJed Brown Output Parameters: 684316643e7SJed Brown + A - Jacobian matrix 685316643e7SJed Brown . B - optional preconditioning matrix 686316643e7SJed Brown - flag - flag indicating matrix structure 687316643e7SJed Brown 688316643e7SJed Brown Notes: 6890910c330SBarry Smith If F(t,U,Udot)=0 is the DAE, the required Jacobian is 690316643e7SJed Brown 6910910c330SBarry Smith dF/dU + shift*dF/dUdot 692316643e7SJed Brown 693316643e7SJed Brown Most users should not need to explicitly call this routine, as it 694316643e7SJed Brown is used internally within the nonlinear solvers. 695316643e7SJed Brown 696316643e7SJed Brown Level: developer 697316643e7SJed Brown 698316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix 699316643e7SJed Brown 700316643e7SJed Brown .seealso: TSSetIJacobian() 70163495f91SJed Brown @*/ 7020910c330SBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat *A,Mat *B,MatStructure *flg,PetscBool imex) 703316643e7SJed Brown { 704316643e7SJed Brown PetscErrorCode ierr; 70524989b8cSPeter Brune TSIJacobian ijacobian; 70624989b8cSPeter Brune TSRHSJacobian rhsjacobian; 70724989b8cSPeter Brune DM dm; 70824989b8cSPeter Brune void *ctx; 709316643e7SJed Brown 710316643e7SJed Brown PetscFunctionBegin; 7110700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7120910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 7130910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 714316643e7SJed Brown PetscValidPointer(A,6); 7150700a824SBarry Smith PetscValidHeaderSpecific(*A,MAT_CLASSID,6); 716316643e7SJed Brown PetscValidPointer(B,7); 7170700a824SBarry Smith PetscValidHeaderSpecific(*B,MAT_CLASSID,7); 718316643e7SJed Brown PetscValidPointer(flg,8); 71924989b8cSPeter Brune 72024989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 72124989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr); 7220298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 72324989b8cSPeter Brune 724ce94432eSBarry Smith if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 725316643e7SJed Brown 7264e684422SJed Brown *flg = SAME_NONZERO_PATTERN; /* In case we're solving a linear problem in which case it wouldn't get initialized below. */ 7270910c330SBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,*A,*B);CHKERRQ(ierr); 72824989b8cSPeter Brune if (ijacobian) { 7292dd45cf8SJed Brown *flg = DIFFERENT_NONZERO_PATTERN; 730316643e7SJed Brown PetscStackPush("TS user implicit Jacobian"); 7310910c330SBarry Smith ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,flg,ctx);CHKERRQ(ierr); 732316643e7SJed Brown PetscStackPop; 733214bc6a2SJed Brown /* make sure user returned a correct Jacobian and preconditioner */ 734214bc6a2SJed Brown PetscValidHeaderSpecific(*A,MAT_CLASSID,4); 735214bc6a2SJed Brown PetscValidHeaderSpecific(*B,MAT_CLASSID,5); 7364a6899ffSJed Brown } 737214bc6a2SJed Brown if (imex) { 738b5abc632SBarry Smith if (!ijacobian) { /* system was written as Udot = G(t,U) */ 739214bc6a2SJed Brown ierr = MatZeroEntries(*A);CHKERRQ(ierr); 7402dd45cf8SJed Brown ierr = MatShift(*A,shift);CHKERRQ(ierr); 741214bc6a2SJed Brown if (*A != *B) { 742214bc6a2SJed Brown ierr = MatZeroEntries(*B);CHKERRQ(ierr); 743214bc6a2SJed Brown ierr = MatShift(*B,shift);CHKERRQ(ierr); 744214bc6a2SJed Brown } 745214bc6a2SJed Brown *flg = SAME_PRECONDITIONER; 746214bc6a2SJed Brown } 747214bc6a2SJed Brown } else { 748e1244c69SJed Brown Mat Arhs = NULL,Brhs = NULL; 749e1244c69SJed Brown MatStructure flg2; 750e1244c69SJed Brown if (rhsjacobian) { 751e1244c69SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 752e1244c69SJed Brown ierr = TSComputeRHSJacobian(ts,t,U,&Arhs,&Brhs,&flg2);CHKERRQ(ierr); 753e1244c69SJed Brown } 754e1244c69SJed Brown if (Arhs == *A) { /* No IJacobian, so we only have the RHS matrix */ 755e1244c69SJed Brown ts->rhsjacobian.scale = -1; 756e1244c69SJed Brown ts->rhsjacobian.shift = shift; 757214bc6a2SJed Brown ierr = MatScale(*A,-1);CHKERRQ(ierr); 758214bc6a2SJed Brown ierr = MatShift(*A,shift);CHKERRQ(ierr); 759316643e7SJed Brown if (*A != *B) { 760316643e7SJed Brown ierr = MatScale(*B,-1);CHKERRQ(ierr); 761316643e7SJed Brown ierr = MatShift(*B,shift);CHKERRQ(ierr); 762316643e7SJed Brown } 763e1244c69SJed Brown } else if (Arhs) { /* Both IJacobian and RHSJacobian */ 764e1244c69SJed Brown MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 765e1244c69SJed Brown if (!ijacobian) { /* No IJacobian provided, but we have a separate RHS matrix */ 766e1244c69SJed Brown ierr = MatZeroEntries(*A);CHKERRQ(ierr); 767e1244c69SJed Brown ierr = MatShift(*A,shift);CHKERRQ(ierr); 768e1244c69SJed Brown if (*A != *B) { 769e1244c69SJed Brown ierr = MatZeroEntries(*B);CHKERRQ(ierr); 770e1244c69SJed Brown ierr = MatShift(*B,shift);CHKERRQ(ierr); 771e1244c69SJed Brown } 772e1244c69SJed Brown } 773214bc6a2SJed Brown ierr = MatAXPY(*A,-1,Arhs,axpy);CHKERRQ(ierr); 774214bc6a2SJed Brown if (*A != *B) { 775214bc6a2SJed Brown ierr = MatAXPY(*B,-1,Brhs,axpy);CHKERRQ(ierr); 776214bc6a2SJed Brown } 777214bc6a2SJed Brown *flg = PetscMin(*flg,flg2); 778214bc6a2SJed Brown } 779316643e7SJed Brown } 7800026cea9SSean Farley 7810910c330SBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,*A,*B);CHKERRQ(ierr); 782316643e7SJed Brown PetscFunctionReturn(0); 783316643e7SJed Brown } 784316643e7SJed Brown 785316643e7SJed Brown #undef __FUNCT__ 7864a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction" 787d763cef2SBarry Smith /*@C 788d763cef2SBarry Smith TSSetRHSFunction - Sets the routine for evaluating the function, 789b5abc632SBarry Smith where U_t = G(t,u). 790d763cef2SBarry Smith 7913f9fe445SBarry Smith Logically Collective on TS 792d763cef2SBarry Smith 793d763cef2SBarry Smith Input Parameters: 794d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 7950298fd71SBarry Smith . r - vector to put the computed right hand side (or NULL to have it created) 796d763cef2SBarry Smith . f - routine for evaluating the right-hand-side function 797d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 7980298fd71SBarry Smith function evaluation routine (may be NULL) 799d763cef2SBarry Smith 800d763cef2SBarry Smith Calling sequence of func: 80187828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Vec F,void *ctx); 802d763cef2SBarry Smith 803d763cef2SBarry Smith + t - current timestep 804d763cef2SBarry Smith . u - input vector 805d763cef2SBarry Smith . F - function vector 806d763cef2SBarry Smith - ctx - [optional] user-defined function context 807d763cef2SBarry Smith 808d763cef2SBarry Smith Level: beginner 809d763cef2SBarry Smith 810d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 811d763cef2SBarry Smith 812d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian() 813d763cef2SBarry Smith @*/ 814089b2837SJed Brown PetscErrorCode TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx) 815d763cef2SBarry Smith { 816089b2837SJed Brown PetscErrorCode ierr; 817089b2837SJed Brown SNES snes; 8180298fd71SBarry Smith Vec ralloc = NULL; 81924989b8cSPeter Brune DM dm; 820d763cef2SBarry Smith 821089b2837SJed Brown PetscFunctionBegin; 8220700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 823ca94891dSJed Brown if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 82424989b8cSPeter Brune 82524989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 82624989b8cSPeter Brune ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr); 827089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 828e856ceecSJed Brown if (!r && !ts->dm && ts->vec_sol) { 829e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 830e856ceecSJed Brown r = ralloc; 831e856ceecSJed Brown } 832089b2837SJed Brown ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 833e856ceecSJed Brown ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 834d763cef2SBarry Smith PetscFunctionReturn(0); 835d763cef2SBarry Smith } 836d763cef2SBarry Smith 8374a2ae208SSatish Balay #undef __FUNCT__ 838ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction" 839ef20d060SBarry Smith /*@C 840abd5a294SJed Brown TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE 841ef20d060SBarry Smith 842ef20d060SBarry Smith Logically Collective on TS 843ef20d060SBarry Smith 844ef20d060SBarry Smith Input Parameters: 845ef20d060SBarry Smith + ts - the TS context obtained from TSCreate() 846ef20d060SBarry Smith . f - routine for evaluating the solution 847ef20d060SBarry Smith - ctx - [optional] user-defined context for private data for the 8480298fd71SBarry Smith function evaluation routine (may be NULL) 849ef20d060SBarry Smith 850ef20d060SBarry Smith Calling sequence of func: 851ef20d060SBarry Smith $ func (TS ts,PetscReal t,Vec u,void *ctx); 852ef20d060SBarry Smith 853ef20d060SBarry Smith + t - current timestep 854ef20d060SBarry Smith . u - output vector 855ef20d060SBarry Smith - ctx - [optional] user-defined function context 856ef20d060SBarry Smith 857abd5a294SJed Brown Notes: 858abd5a294SJed Brown This routine is used for testing accuracy of time integration schemes when you already know the solution. 859abd5a294SJed Brown If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to 860abd5a294SJed Brown create closed-form solutions with non-physical forcing terms. 861abd5a294SJed Brown 8624f09c107SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 863abd5a294SJed Brown 864ef20d060SBarry Smith Level: beginner 865ef20d060SBarry Smith 866ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 867ef20d060SBarry Smith 8689b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction() 869ef20d060SBarry Smith @*/ 870ef20d060SBarry Smith PetscErrorCode TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 871ef20d060SBarry Smith { 872ef20d060SBarry Smith PetscErrorCode ierr; 873ef20d060SBarry Smith DM dm; 874ef20d060SBarry Smith 875ef20d060SBarry Smith PetscFunctionBegin; 876ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 877ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 878ef20d060SBarry Smith ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr); 879ef20d060SBarry Smith PetscFunctionReturn(0); 880ef20d060SBarry Smith } 881ef20d060SBarry Smith 882ef20d060SBarry Smith #undef __FUNCT__ 8839b7cd975SBarry Smith #define __FUNCT__ "TSSetForcingFunction" 8849b7cd975SBarry Smith /*@C 8859b7cd975SBarry Smith TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE 8869b7cd975SBarry Smith 8879b7cd975SBarry Smith Logically Collective on TS 8889b7cd975SBarry Smith 8899b7cd975SBarry Smith Input Parameters: 8909b7cd975SBarry Smith + ts - the TS context obtained from TSCreate() 8919b7cd975SBarry Smith . f - routine for evaluating the forcing function 8929b7cd975SBarry Smith - ctx - [optional] user-defined context for private data for the 8930298fd71SBarry Smith function evaluation routine (may be NULL) 8949b7cd975SBarry Smith 8959b7cd975SBarry Smith Calling sequence of func: 8969b7cd975SBarry Smith $ func (TS ts,PetscReal t,Vec u,void *ctx); 8979b7cd975SBarry Smith 8989b7cd975SBarry Smith + t - current timestep 8999b7cd975SBarry Smith . u - output vector 9009b7cd975SBarry Smith - ctx - [optional] user-defined function context 9019b7cd975SBarry Smith 9029b7cd975SBarry Smith Notes: 9039b7cd975SBarry Smith This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to 9049b7cd975SBarry Smith create closed-form solutions with a non-physical forcing term. 9059b7cd975SBarry Smith 9069b7cd975SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 9079b7cd975SBarry Smith 9089b7cd975SBarry Smith Level: beginner 9099b7cd975SBarry Smith 9109b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 9119b7cd975SBarry Smith 9129b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction() 9139b7cd975SBarry Smith @*/ 9149b7cd975SBarry Smith PetscErrorCode TSSetForcingFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 9159b7cd975SBarry Smith { 9169b7cd975SBarry Smith PetscErrorCode ierr; 9179b7cd975SBarry Smith DM dm; 9189b7cd975SBarry Smith 9199b7cd975SBarry Smith PetscFunctionBegin; 9209b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 9219b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 9229b7cd975SBarry Smith ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr); 9239b7cd975SBarry Smith PetscFunctionReturn(0); 9249b7cd975SBarry Smith } 9259b7cd975SBarry Smith 9269b7cd975SBarry Smith #undef __FUNCT__ 9274a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian" 928d763cef2SBarry Smith /*@C 929d763cef2SBarry Smith TSSetRHSJacobian - Sets the function to compute the Jacobian of F, 930b5abc632SBarry Smith where U_t = G(U,t), as well as the location to store the matrix. 931d763cef2SBarry Smith 9323f9fe445SBarry Smith Logically Collective on TS 933d763cef2SBarry Smith 934d763cef2SBarry Smith Input Parameters: 935d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 936e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 937e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 938d763cef2SBarry Smith . f - the Jacobian evaluation routine 939d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 9400298fd71SBarry Smith Jacobian evaluation routine (may be NULL) 941d763cef2SBarry Smith 942d763cef2SBarry Smith Calling sequence of func: 94387828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Mat *A,Mat *B,MatStructure *flag,void *ctx); 944d763cef2SBarry Smith 945d763cef2SBarry Smith + t - current timestep 946d763cef2SBarry Smith . u - input vector 947e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 948e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 949d763cef2SBarry Smith . flag - flag indicating information about the preconditioner matrix 95094b7f48cSBarry Smith structure (same as flag in KSPSetOperators()) 951d763cef2SBarry Smith - ctx - [optional] user-defined context for matrix evaluation routine 952d763cef2SBarry Smith 953d763cef2SBarry Smith Notes: 95494b7f48cSBarry Smith See KSPSetOperators() for important information about setting the flag 955d763cef2SBarry Smith output parameter in the routine func(). Be sure to read this information! 956d763cef2SBarry Smith 957d763cef2SBarry Smith The routine func() takes Mat * as the matrix arguments rather than Mat. 958d763cef2SBarry Smith This allows the matrix evaluation routine to replace A and/or B with a 95956335db2SHong Zhang completely new matrix structure (not just different matrix elements) 960d763cef2SBarry Smith when appropriate, for instance, if the nonzero structure is changing 961d763cef2SBarry Smith throughout the global iterations. 962d763cef2SBarry Smith 963d763cef2SBarry Smith Level: beginner 964d763cef2SBarry Smith 965d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian 966d763cef2SBarry Smith 967e1244c69SJed Brown .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse() 968d763cef2SBarry Smith 969d763cef2SBarry Smith @*/ 970e5d3d808SBarry Smith PetscErrorCode TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx) 971d763cef2SBarry Smith { 972277b19d0SLisandro Dalcin PetscErrorCode ierr; 973089b2837SJed Brown SNES snes; 97424989b8cSPeter Brune DM dm; 97524989b8cSPeter Brune TSIJacobian ijacobian; 976277b19d0SLisandro Dalcin 977d763cef2SBarry Smith PetscFunctionBegin; 9780700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 979e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 980e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 981e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 982e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 983d763cef2SBarry Smith 98424989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 98524989b8cSPeter Brune ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr); 986e1244c69SJed Brown if (f == TSComputeRHSJacobianConstant) { 987e1244c69SJed Brown /* Handle this case automatically for the user; otherwise user should call themselves. */ 988e1244c69SJed Brown ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr); 989e1244c69SJed Brown } 9900298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr); 991089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 9925f659677SPeter Brune if (!ijacobian) { 993e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 9940e4ef248SJed Brown } 995e5d3d808SBarry Smith if (Amat) { 996e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 9970e4ef248SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 998bbd56ea5SKarl Rupp 999e5d3d808SBarry Smith ts->Arhs = Amat; 10000e4ef248SJed Brown } 1001e5d3d808SBarry Smith if (Pmat) { 1002e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr); 10030e4ef248SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1004bbd56ea5SKarl Rupp 1005e5d3d808SBarry Smith ts->Brhs = Pmat; 10060e4ef248SJed Brown } 1007d763cef2SBarry Smith PetscFunctionReturn(0); 1008d763cef2SBarry Smith } 1009d763cef2SBarry Smith 1010316643e7SJed Brown 1011316643e7SJed Brown #undef __FUNCT__ 1012316643e7SJed Brown #define __FUNCT__ "TSSetIFunction" 1013316643e7SJed Brown /*@C 1014b5abc632SBarry Smith TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved. 1015316643e7SJed Brown 10163f9fe445SBarry Smith Logically Collective on TS 1017316643e7SJed Brown 1018316643e7SJed Brown Input Parameters: 1019316643e7SJed Brown + ts - the TS context obtained from TSCreate() 10200298fd71SBarry Smith . r - vector to hold the residual (or NULL to have it created internally) 1021316643e7SJed Brown . f - the function evaluation routine 10220298fd71SBarry Smith - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1023316643e7SJed Brown 1024316643e7SJed Brown Calling sequence of f: 1025316643e7SJed Brown $ f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx); 1026316643e7SJed Brown 1027316643e7SJed Brown + t - time at step/stage being solved 1028316643e7SJed Brown . u - state vector 1029316643e7SJed Brown . u_t - time derivative of state vector 1030316643e7SJed Brown . F - function vector 1031316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1032316643e7SJed Brown 1033316643e7SJed Brown Important: 1034d6cbdb99SBarry Smith The user MUST call either this routine, TSSetRHSFunction(). This routine must be used when not solving an ODE, for example a DAE. 1035316643e7SJed Brown 1036316643e7SJed Brown Level: beginner 1037316643e7SJed Brown 1038316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian 1039316643e7SJed Brown 1040d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian() 1041316643e7SJed Brown @*/ 1042089b2837SJed Brown PetscErrorCode TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx) 1043316643e7SJed Brown { 1044089b2837SJed Brown PetscErrorCode ierr; 1045089b2837SJed Brown SNES snes; 10460298fd71SBarry Smith Vec resalloc = NULL; 104724989b8cSPeter Brune DM dm; 1048316643e7SJed Brown 1049316643e7SJed Brown PetscFunctionBegin; 10500700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1051ca94891dSJed Brown if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2); 105224989b8cSPeter Brune 105324989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 105424989b8cSPeter Brune ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr); 105524989b8cSPeter Brune 1056089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1057e856ceecSJed Brown if (!res && !ts->dm && ts->vec_sol) { 1058e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr); 1059e856ceecSJed Brown res = resalloc; 1060e856ceecSJed Brown } 1061089b2837SJed Brown ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr); 1062e856ceecSJed Brown ierr = VecDestroy(&resalloc);CHKERRQ(ierr); 1063089b2837SJed Brown PetscFunctionReturn(0); 1064089b2837SJed Brown } 1065089b2837SJed Brown 1066089b2837SJed Brown #undef __FUNCT__ 1067089b2837SJed Brown #define __FUNCT__ "TSGetIFunction" 1068089b2837SJed Brown /*@C 1069089b2837SJed Brown TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1070089b2837SJed Brown 1071089b2837SJed Brown Not Collective 1072089b2837SJed Brown 1073089b2837SJed Brown Input Parameter: 1074089b2837SJed Brown . ts - the TS context 1075089b2837SJed Brown 1076089b2837SJed Brown Output Parameter: 10770298fd71SBarry Smith + r - vector to hold residual (or NULL) 10780298fd71SBarry Smith . func - the function to compute residual (or NULL) 10790298fd71SBarry Smith - ctx - the function context (or NULL) 1080089b2837SJed Brown 1081089b2837SJed Brown Level: advanced 1082089b2837SJed Brown 1083089b2837SJed Brown .keywords: TS, nonlinear, get, function 1084089b2837SJed Brown 1085089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction() 1086089b2837SJed Brown @*/ 1087089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx) 1088089b2837SJed Brown { 1089089b2837SJed Brown PetscErrorCode ierr; 1090089b2837SJed Brown SNES snes; 109124989b8cSPeter Brune DM dm; 1092089b2837SJed Brown 1093089b2837SJed Brown PetscFunctionBegin; 1094089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1095089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 10960298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 109724989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 109824989b8cSPeter Brune ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr); 1099089b2837SJed Brown PetscFunctionReturn(0); 1100089b2837SJed Brown } 1101089b2837SJed Brown 1102089b2837SJed Brown #undef __FUNCT__ 1103089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction" 1104089b2837SJed Brown /*@C 1105089b2837SJed Brown TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it. 1106089b2837SJed Brown 1107089b2837SJed Brown Not Collective 1108089b2837SJed Brown 1109089b2837SJed Brown Input Parameter: 1110089b2837SJed Brown . ts - the TS context 1111089b2837SJed Brown 1112089b2837SJed Brown Output Parameter: 11130298fd71SBarry Smith + r - vector to hold computed right hand side (or NULL) 11140298fd71SBarry Smith . func - the function to compute right hand side (or NULL) 11150298fd71SBarry Smith - ctx - the function context (or NULL) 1116089b2837SJed Brown 1117089b2837SJed Brown Level: advanced 1118089b2837SJed Brown 1119089b2837SJed Brown .keywords: TS, nonlinear, get, function 1120089b2837SJed Brown 1121089b2837SJed Brown .seealso: TSSetRhsfunction(), SNESGetFunction() 1122089b2837SJed Brown @*/ 1123089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx) 1124089b2837SJed Brown { 1125089b2837SJed Brown PetscErrorCode ierr; 1126089b2837SJed Brown SNES snes; 112724989b8cSPeter Brune DM dm; 1128089b2837SJed Brown 1129089b2837SJed Brown PetscFunctionBegin; 1130089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1131089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 11320298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 113324989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 113424989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr); 1135316643e7SJed Brown PetscFunctionReturn(0); 1136316643e7SJed Brown } 1137316643e7SJed Brown 1138316643e7SJed Brown #undef __FUNCT__ 1139316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian" 1140316643e7SJed Brown /*@C 1141a4f0a591SBarry Smith TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function 1142a4f0a591SBarry Smith you provided with TSSetIFunction(). 1143316643e7SJed Brown 11443f9fe445SBarry Smith Logically Collective on TS 1145316643e7SJed Brown 1146316643e7SJed Brown Input Parameters: 1147316643e7SJed Brown + ts - the TS context obtained from TSCreate() 1148e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1149e5d3d808SBarry Smith . Pmat - matrix used to compute preconditioner (usually the same as Amat) 1150316643e7SJed Brown . f - the Jacobian evaluation routine 11510298fd71SBarry Smith - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1152316643e7SJed Brown 1153316643e7SJed Brown Calling sequence of f: 1154e5d3d808SBarry Smith $ f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat *Amat,Mat *Pmat,MatStructure *flag,void *ctx); 1155316643e7SJed Brown 1156316643e7SJed Brown + t - time at step/stage being solved 11571b4a444bSJed Brown . U - state vector 11581b4a444bSJed Brown . U_t - time derivative of state vector 1159316643e7SJed Brown . a - shift 1160e5d3d808SBarry Smith . Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t 1161e5d3d808SBarry Smith . Pmat - matrix used for constructing preconditioner, usually the same as Amat 1162316643e7SJed Brown . flag - flag indicating information about the preconditioner matrix 1163316643e7SJed Brown structure (same as flag in KSPSetOperators()) 1164316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1165316643e7SJed Brown 1166316643e7SJed Brown Notes: 1167e5d3d808SBarry Smith The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve. 1168316643e7SJed Brown 1169a4f0a591SBarry Smith The matrix dF/dU + a*dF/dU_t you provide turns out to be 1170b5abc632SBarry Smith the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved. 1171a4f0a591SBarry Smith The time integrator internally approximates U_t by W+a*U where the positive "shift" 1172a4f0a591SBarry Smith a and vector W depend on the integration method, step size, and past states. For example with 1173a4f0a591SBarry Smith the backward Euler method a = 1/dt and W = -a*U(previous timestep) so 1174a4f0a591SBarry Smith W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt 1175a4f0a591SBarry Smith 1176316643e7SJed Brown Level: beginner 1177316643e7SJed Brown 1178316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian 1179316643e7SJed Brown 11808d359177SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault() 1181316643e7SJed Brown 1182316643e7SJed Brown @*/ 1183e5d3d808SBarry Smith PetscErrorCode TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx) 1184316643e7SJed Brown { 1185316643e7SJed Brown PetscErrorCode ierr; 1186089b2837SJed Brown SNES snes; 118724989b8cSPeter Brune DM dm; 1188316643e7SJed Brown 1189316643e7SJed Brown PetscFunctionBegin; 11900700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1191e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1192e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1193e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1194e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 119524989b8cSPeter Brune 119624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 119724989b8cSPeter Brune ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr); 119824989b8cSPeter Brune 1199089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1200e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1201316643e7SJed Brown PetscFunctionReturn(0); 1202316643e7SJed Brown } 1203316643e7SJed Brown 12044a2ae208SSatish Balay #undef __FUNCT__ 1205e1244c69SJed Brown #define __FUNCT__ "TSRHSJacobianSetReuse" 1206e1244c69SJed Brown /*@ 1207e1244c69SJed Brown TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating. Without this flag, TS will change the sign and 1208e1244c69SJed Brown shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute 1209e1244c69SJed Brown the entire Jacobian. The reuse flag must be set if the evaluation function will assume that the matrix entries have 1210e1244c69SJed Brown not been changed by the TS. 1211e1244c69SJed Brown 1212e1244c69SJed Brown Logically Collective 1213e1244c69SJed Brown 1214e1244c69SJed Brown Input Arguments: 1215e1244c69SJed Brown + ts - TS context obtained from TSCreate() 1216e1244c69SJed Brown - reuse - PETSC_TRUE if the RHS Jacobian 1217e1244c69SJed Brown 1218e1244c69SJed Brown Level: intermediate 1219e1244c69SJed Brown 1220e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 1221e1244c69SJed Brown @*/ 1222e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse) 1223e1244c69SJed Brown { 1224e1244c69SJed Brown PetscFunctionBegin; 1225e1244c69SJed Brown ts->rhsjacobian.reuse = reuse; 1226e1244c69SJed Brown PetscFunctionReturn(0); 1227e1244c69SJed Brown } 1228e1244c69SJed Brown 1229e1244c69SJed Brown #undef __FUNCT__ 123055849f57SBarry Smith #define __FUNCT__ "TSLoad" 123155849f57SBarry Smith /*@C 123255849f57SBarry Smith TSLoad - Loads a KSP that has been stored in binary with KSPView(). 123355849f57SBarry Smith 123455849f57SBarry Smith Collective on PetscViewer 123555849f57SBarry Smith 123655849f57SBarry Smith Input Parameters: 123755849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or 123855849f57SBarry Smith some related function before a call to TSLoad(). 123955849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() 124055849f57SBarry Smith 124155849f57SBarry Smith Level: intermediate 124255849f57SBarry Smith 124355849f57SBarry Smith Notes: 124455849f57SBarry Smith The type is determined by the data in the file, any type set into the TS before this call is ignored. 124555849f57SBarry Smith 124655849f57SBarry Smith Notes for advanced users: 124755849f57SBarry Smith Most users should not need to know the details of the binary storage 124855849f57SBarry Smith format, since TSLoad() and TSView() completely hide these details. 124955849f57SBarry Smith But for anyone who's interested, the standard binary matrix storage 125055849f57SBarry Smith format is 125155849f57SBarry Smith .vb 125255849f57SBarry Smith has not yet been determined 125355849f57SBarry Smith .ve 125455849f57SBarry Smith 125555849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad() 125655849f57SBarry Smith @*/ 1257f2c2a1b9SBarry Smith PetscErrorCode TSLoad(TS ts, PetscViewer viewer) 125855849f57SBarry Smith { 125955849f57SBarry Smith PetscErrorCode ierr; 126055849f57SBarry Smith PetscBool isbinary; 126155849f57SBarry Smith PetscInt classid; 126255849f57SBarry Smith char type[256]; 12632d53ad75SBarry Smith DMTS sdm; 1264ad6bc421SBarry Smith DM dm; 126555849f57SBarry Smith 126655849f57SBarry Smith PetscFunctionBegin; 1267f2c2a1b9SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 126855849f57SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 126955849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 127055849f57SBarry Smith if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()"); 127155849f57SBarry Smith 127255849f57SBarry Smith ierr = PetscViewerBinaryRead(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr); 1273ce94432eSBarry Smith if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file"); 127455849f57SBarry Smith ierr = PetscViewerBinaryRead(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr); 1275f2c2a1b9SBarry Smith ierr = TSSetType(ts, type);CHKERRQ(ierr); 1276f2c2a1b9SBarry Smith if (ts->ops->load) { 1277f2c2a1b9SBarry Smith ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr); 1278f2c2a1b9SBarry Smith } 1279ce94432eSBarry Smith ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr); 1280ad6bc421SBarry Smith ierr = DMLoad(dm,viewer);CHKERRQ(ierr); 1281ad6bc421SBarry Smith ierr = TSSetDM(ts,dm);CHKERRQ(ierr); 1282f2c2a1b9SBarry Smith ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr); 1283f2c2a1b9SBarry Smith ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr); 12842d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 12852d53ad75SBarry Smith ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr); 128655849f57SBarry Smith PetscFunctionReturn(0); 128755849f57SBarry Smith } 128855849f57SBarry Smith 12899804daf3SBarry Smith #include <petscdraw.h> 1290e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1291e04113cfSBarry Smith #include <petscviewersaws.h> 1292f05ece33SBarry Smith #endif 129355849f57SBarry Smith #undef __FUNCT__ 12944a2ae208SSatish Balay #define __FUNCT__ "TSView" 12957e2c5f70SBarry Smith /*@C 1296d763cef2SBarry Smith TSView - Prints the TS data structure. 1297d763cef2SBarry Smith 12984c49b128SBarry Smith Collective on TS 1299d763cef2SBarry Smith 1300d763cef2SBarry Smith Input Parameters: 1301d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1302d763cef2SBarry Smith - viewer - visualization context 1303d763cef2SBarry Smith 1304d763cef2SBarry Smith Options Database Key: 1305d763cef2SBarry Smith . -ts_view - calls TSView() at end of TSStep() 1306d763cef2SBarry Smith 1307d763cef2SBarry Smith Notes: 1308d763cef2SBarry Smith The available visualization contexts include 1309b0a32e0cSBarry Smith + PETSC_VIEWER_STDOUT_SELF - standard output (default) 1310b0a32e0cSBarry Smith - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 1311d763cef2SBarry Smith output where only the first processor opens 1312d763cef2SBarry Smith the file. All other processors send their 1313d763cef2SBarry Smith data to the first processor to print. 1314d763cef2SBarry Smith 1315d763cef2SBarry Smith The user can open an alternative visualization context with 1316b0a32e0cSBarry Smith PetscViewerASCIIOpen() - output to a specified file. 1317d763cef2SBarry Smith 1318d763cef2SBarry Smith Level: beginner 1319d763cef2SBarry Smith 1320d763cef2SBarry Smith .keywords: TS, timestep, view 1321d763cef2SBarry Smith 1322b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen() 1323d763cef2SBarry Smith @*/ 13247087cfbeSBarry Smith PetscErrorCode TSView(TS ts,PetscViewer viewer) 1325d763cef2SBarry Smith { 1326dfbe8321SBarry Smith PetscErrorCode ierr; 132719fd82e9SBarry Smith TSType type; 13282b0a91c0SBarry Smith PetscBool iascii,isstring,isundials,isbinary,isdraw; 13292d53ad75SBarry Smith DMTS sdm; 1330e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1331f05ece33SBarry Smith PetscBool isams; 1332f05ece33SBarry Smith #endif 1333d763cef2SBarry Smith 1334d763cef2SBarry Smith PetscFunctionBegin; 13350700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 13363050cee2SBarry Smith if (!viewer) { 1337ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr); 13383050cee2SBarry Smith } 13390700a824SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1340c9780b6fSBarry Smith PetscCheckSameComm(ts,1,viewer,2); 1341fd16b177SBarry Smith 1342251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1343251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 134455849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 13452b0a91c0SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 1346e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1347e04113cfSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&isams);CHKERRQ(ierr); 1348f05ece33SBarry Smith #endif 134932077d6dSBarry Smith if (iascii) { 1350dae58748SBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr); 135177431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr); 1352a83599f4SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum time=%G\n",ts->max_time);CHKERRQ(ierr); 1353d763cef2SBarry Smith if (ts->problem_type == TS_NONLINEAR) { 13545ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr); 1355c610991cSLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr); 1356d763cef2SBarry Smith } 13575ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr); 1358193ac0bcSJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr); 13592d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 13602d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 1361d52bd9f3SBarry Smith if (ts->ops->view) { 1362d52bd9f3SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1363d52bd9f3SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1364d52bd9f3SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1365d52bd9f3SBarry Smith } 13660f5bd95cSBarry Smith } else if (isstring) { 1367a313700dSBarry Smith ierr = TSGetType(ts,&type);CHKERRQ(ierr); 1368b0a32e0cSBarry Smith ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr); 136955849f57SBarry Smith } else if (isbinary) { 137055849f57SBarry Smith PetscInt classid = TS_FILE_CLASSID; 137155849f57SBarry Smith MPI_Comm comm; 137255849f57SBarry Smith PetscMPIInt rank; 137355849f57SBarry Smith char type[256]; 137455849f57SBarry Smith 137555849f57SBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 137655849f57SBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 137755849f57SBarry Smith if (!rank) { 137855849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 137955849f57SBarry Smith ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr); 138055849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 138155849f57SBarry Smith } 138255849f57SBarry Smith if (ts->ops->view) { 138355849f57SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 138455849f57SBarry Smith } 1385f2c2a1b9SBarry Smith ierr = DMView(ts->dm,viewer);CHKERRQ(ierr); 1386f2c2a1b9SBarry Smith ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr); 13872d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 13882d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 13892b0a91c0SBarry Smith } else if (isdraw) { 13902b0a91c0SBarry Smith PetscDraw draw; 13912b0a91c0SBarry Smith char str[36]; 139289fd9fafSBarry Smith PetscReal x,y,bottom,h; 13932b0a91c0SBarry Smith 13942b0a91c0SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 13952b0a91c0SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 13962b0a91c0SBarry Smith ierr = PetscStrcpy(str,"TS: ");CHKERRQ(ierr); 13972b0a91c0SBarry Smith ierr = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr); 13980298fd71SBarry Smith ierr = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 139989fd9fafSBarry Smith bottom = y - h; 14002b0a91c0SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 14012b0a91c0SBarry Smith if (ts->ops->view) { 14022b0a91c0SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 14032b0a91c0SBarry Smith } 14042b0a91c0SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 1405e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1406f05ece33SBarry Smith } else if (isams) { 1407d45a07a7SBarry Smith PetscMPIInt rank; 14082657e9d9SBarry Smith const char *name; 14092657e9d9SBarry Smith 14102657e9d9SBarry Smith ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr); 1411d45a07a7SBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 1412d45a07a7SBarry Smith if (!((PetscObject)ts)->amsmem && !rank) { 1413d45a07a7SBarry Smith char dir[1024]; 1414d45a07a7SBarry Smith 1415e04113cfSBarry Smith ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr); 1416a0931e03SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr); 14172657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT)); 14182657e9d9SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr); 14192657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE)); 1420d763cef2SBarry Smith } 14210acecf5bSBarry Smith if (ts->ops->view) { 14220acecf5bSBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 14230acecf5bSBarry Smith } 1424f05ece33SBarry Smith #endif 1425f05ece33SBarry Smith } 1426f05ece33SBarry Smith 1427b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1428251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr); 1429b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1430d763cef2SBarry Smith PetscFunctionReturn(0); 1431d763cef2SBarry Smith } 1432d763cef2SBarry Smith 1433d763cef2SBarry Smith 14344a2ae208SSatish Balay #undef __FUNCT__ 14354a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext" 1436b07ff414SBarry Smith /*@ 1437d763cef2SBarry Smith TSSetApplicationContext - Sets an optional user-defined context for 1438d763cef2SBarry Smith the timesteppers. 1439d763cef2SBarry Smith 14403f9fe445SBarry Smith Logically Collective on TS 1441d763cef2SBarry Smith 1442d763cef2SBarry Smith Input Parameters: 1443d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1444d763cef2SBarry Smith - usrP - optional user context 1445d763cef2SBarry Smith 1446d763cef2SBarry Smith Level: intermediate 1447d763cef2SBarry Smith 1448d763cef2SBarry Smith .keywords: TS, timestep, set, application, context 1449d763cef2SBarry Smith 1450d763cef2SBarry Smith .seealso: TSGetApplicationContext() 1451d763cef2SBarry Smith @*/ 14527087cfbeSBarry Smith PetscErrorCode TSSetApplicationContext(TS ts,void *usrP) 1453d763cef2SBarry Smith { 1454d763cef2SBarry Smith PetscFunctionBegin; 14550700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1456d763cef2SBarry Smith ts->user = usrP; 1457d763cef2SBarry Smith PetscFunctionReturn(0); 1458d763cef2SBarry Smith } 1459d763cef2SBarry Smith 14604a2ae208SSatish Balay #undef __FUNCT__ 14614a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext" 1462b07ff414SBarry Smith /*@ 1463d763cef2SBarry Smith TSGetApplicationContext - Gets the user-defined context for the 1464d763cef2SBarry Smith timestepper. 1465d763cef2SBarry Smith 1466d763cef2SBarry Smith Not Collective 1467d763cef2SBarry Smith 1468d763cef2SBarry Smith Input Parameter: 1469d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1470d763cef2SBarry Smith 1471d763cef2SBarry Smith Output Parameter: 1472d763cef2SBarry Smith . usrP - user context 1473d763cef2SBarry Smith 1474d763cef2SBarry Smith Level: intermediate 1475d763cef2SBarry Smith 1476d763cef2SBarry Smith .keywords: TS, timestep, get, application, context 1477d763cef2SBarry Smith 1478d763cef2SBarry Smith .seealso: TSSetApplicationContext() 1479d763cef2SBarry Smith @*/ 1480e71120c6SJed Brown PetscErrorCode TSGetApplicationContext(TS ts,void *usrP) 1481d763cef2SBarry Smith { 1482d763cef2SBarry Smith PetscFunctionBegin; 14830700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1484e71120c6SJed Brown *(void**)usrP = ts->user; 1485d763cef2SBarry Smith PetscFunctionReturn(0); 1486d763cef2SBarry Smith } 1487d763cef2SBarry Smith 14884a2ae208SSatish Balay #undef __FUNCT__ 14894a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber" 1490d763cef2SBarry Smith /*@ 1491b8123daeSJed Brown TSGetTimeStepNumber - Gets the number of time steps completed. 1492d763cef2SBarry Smith 1493d763cef2SBarry Smith Not Collective 1494d763cef2SBarry Smith 1495d763cef2SBarry Smith Input Parameter: 1496d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1497d763cef2SBarry Smith 1498d763cef2SBarry Smith Output Parameter: 1499b8123daeSJed Brown . iter - number of steps completed so far 1500d763cef2SBarry Smith 1501d763cef2SBarry Smith Level: intermediate 1502d763cef2SBarry Smith 1503d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number 1504b8123daeSJed Brown .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStep() 1505d763cef2SBarry Smith @*/ 15067087cfbeSBarry Smith PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *iter) 1507d763cef2SBarry Smith { 1508d763cef2SBarry Smith PetscFunctionBegin; 15090700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 15104482741eSBarry Smith PetscValidIntPointer(iter,2); 1511d763cef2SBarry Smith *iter = ts->steps; 1512d763cef2SBarry Smith PetscFunctionReturn(0); 1513d763cef2SBarry Smith } 1514d763cef2SBarry Smith 15154a2ae208SSatish Balay #undef __FUNCT__ 15164a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep" 1517d763cef2SBarry Smith /*@ 1518d763cef2SBarry Smith TSSetInitialTimeStep - Sets the initial timestep to be used, 1519d763cef2SBarry Smith as well as the initial time. 1520d763cef2SBarry Smith 15213f9fe445SBarry Smith Logically Collective on TS 1522d763cef2SBarry Smith 1523d763cef2SBarry Smith Input Parameters: 1524d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1525d763cef2SBarry Smith . initial_time - the initial time 1526d763cef2SBarry Smith - time_step - the size of the timestep 1527d763cef2SBarry Smith 1528d763cef2SBarry Smith Level: intermediate 1529d763cef2SBarry Smith 1530d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep() 1531d763cef2SBarry Smith 1532d763cef2SBarry Smith .keywords: TS, set, initial, timestep 1533d763cef2SBarry Smith @*/ 15347087cfbeSBarry Smith PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step) 1535d763cef2SBarry Smith { 1536e144a568SJed Brown PetscErrorCode ierr; 1537e144a568SJed Brown 1538d763cef2SBarry Smith PetscFunctionBegin; 15390700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1540e144a568SJed Brown ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 1541d8cd7023SBarry Smith ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr); 1542d763cef2SBarry Smith PetscFunctionReturn(0); 1543d763cef2SBarry Smith } 1544d763cef2SBarry Smith 15454a2ae208SSatish Balay #undef __FUNCT__ 15464a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep" 1547d763cef2SBarry Smith /*@ 1548d763cef2SBarry Smith TSSetTimeStep - Allows one to reset the timestep at any time, 1549d763cef2SBarry Smith useful for simple pseudo-timestepping codes. 1550d763cef2SBarry Smith 15513f9fe445SBarry Smith Logically Collective on TS 1552d763cef2SBarry Smith 1553d763cef2SBarry Smith Input Parameters: 1554d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1555d763cef2SBarry Smith - time_step - the size of the timestep 1556d763cef2SBarry Smith 1557d763cef2SBarry Smith Level: intermediate 1558d763cef2SBarry Smith 1559d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1560d763cef2SBarry Smith 1561d763cef2SBarry Smith .keywords: TS, set, timestep 1562d763cef2SBarry Smith @*/ 15637087cfbeSBarry Smith PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step) 1564d763cef2SBarry Smith { 1565d763cef2SBarry Smith PetscFunctionBegin; 15660700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1567c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,time_step,2); 1568d763cef2SBarry Smith ts->time_step = time_step; 156931748224SBarry Smith ts->time_step_orig = time_step; 1570d763cef2SBarry Smith PetscFunctionReturn(0); 1571d763cef2SBarry Smith } 1572d763cef2SBarry Smith 15734a2ae208SSatish Balay #undef __FUNCT__ 1574a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime" 1575a43b19c4SJed Brown /*@ 157649354f04SShri Abhyankar TSSetExactFinalTime - Determines whether to adapt the final time step to 157749354f04SShri Abhyankar match the exact final time, interpolate solution to the exact final time, 157849354f04SShri Abhyankar or just return at the final time TS computed. 1579a43b19c4SJed Brown 1580a43b19c4SJed Brown Logically Collective on TS 1581a43b19c4SJed Brown 1582a43b19c4SJed Brown Input Parameter: 1583a43b19c4SJed Brown + ts - the time-step context 158449354f04SShri Abhyankar - eftopt - exact final time option 1585a43b19c4SJed Brown 1586a43b19c4SJed Brown Level: beginner 1587a43b19c4SJed Brown 1588a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption 1589a43b19c4SJed Brown @*/ 159049354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt) 1591a43b19c4SJed Brown { 1592a43b19c4SJed Brown PetscFunctionBegin; 1593a43b19c4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 159449354f04SShri Abhyankar PetscValidLogicalCollectiveEnum(ts,eftopt,2); 159549354f04SShri Abhyankar ts->exact_final_time = eftopt; 1596a43b19c4SJed Brown PetscFunctionReturn(0); 1597a43b19c4SJed Brown } 1598a43b19c4SJed Brown 1599a43b19c4SJed Brown #undef __FUNCT__ 16004a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep" 1601d763cef2SBarry Smith /*@ 1602d763cef2SBarry Smith TSGetTimeStep - Gets the current timestep size. 1603d763cef2SBarry Smith 1604d763cef2SBarry Smith Not Collective 1605d763cef2SBarry Smith 1606d763cef2SBarry Smith Input Parameter: 1607d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1608d763cef2SBarry Smith 1609d763cef2SBarry Smith Output Parameter: 1610d763cef2SBarry Smith . dt - the current timestep size 1611d763cef2SBarry Smith 1612d763cef2SBarry Smith Level: intermediate 1613d763cef2SBarry Smith 1614d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1615d763cef2SBarry Smith 1616d763cef2SBarry Smith .keywords: TS, get, timestep 1617d763cef2SBarry Smith @*/ 16187087cfbeSBarry Smith PetscErrorCode TSGetTimeStep(TS ts,PetscReal *dt) 1619d763cef2SBarry Smith { 1620d763cef2SBarry Smith PetscFunctionBegin; 16210700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1622f7cf8827SBarry Smith PetscValidRealPointer(dt,2); 1623d763cef2SBarry Smith *dt = ts->time_step; 1624d763cef2SBarry Smith PetscFunctionReturn(0); 1625d763cef2SBarry Smith } 1626d763cef2SBarry Smith 16274a2ae208SSatish Balay #undef __FUNCT__ 16284a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution" 1629d8e5e3e6SSatish Balay /*@ 1630d763cef2SBarry Smith TSGetSolution - Returns the solution at the present timestep. It 1631d763cef2SBarry Smith is valid to call this routine inside the function that you are evaluating 1632d763cef2SBarry Smith in order to move to the new timestep. This vector not changed until 1633d763cef2SBarry Smith the solution at the next timestep has been calculated. 1634d763cef2SBarry Smith 1635d763cef2SBarry Smith Not Collective, but Vec returned is parallel if TS is parallel 1636d763cef2SBarry Smith 1637d763cef2SBarry Smith Input Parameter: 1638d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1639d763cef2SBarry Smith 1640d763cef2SBarry Smith Output Parameter: 1641d763cef2SBarry Smith . v - the vector containing the solution 1642d763cef2SBarry Smith 1643d763cef2SBarry Smith Level: intermediate 1644d763cef2SBarry Smith 1645d763cef2SBarry Smith .seealso: TSGetTimeStep() 1646d763cef2SBarry Smith 1647d763cef2SBarry Smith .keywords: TS, timestep, get, solution 1648d763cef2SBarry Smith @*/ 16497087cfbeSBarry Smith PetscErrorCode TSGetSolution(TS ts,Vec *v) 1650d763cef2SBarry Smith { 1651d763cef2SBarry Smith PetscFunctionBegin; 16520700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 16534482741eSBarry Smith PetscValidPointer(v,2); 16548737fe31SLisandro Dalcin *v = ts->vec_sol; 1655d763cef2SBarry Smith PetscFunctionReturn(0); 1656d763cef2SBarry Smith } 1657d763cef2SBarry Smith 1658bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */ 16594a2ae208SSatish Balay #undef __FUNCT__ 1660bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType" 1661d8e5e3e6SSatish Balay /*@ 1662bdad233fSMatthew Knepley TSSetProblemType - Sets the type of problem to be solved. 1663d763cef2SBarry Smith 1664bdad233fSMatthew Knepley Not collective 1665d763cef2SBarry Smith 1666bdad233fSMatthew Knepley Input Parameters: 1667bdad233fSMatthew Knepley + ts - The TS 1668bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 1669d763cef2SBarry Smith .vb 16700910c330SBarry Smith U_t - A U = 0 (linear) 16710910c330SBarry Smith U_t - A(t) U = 0 (linear) 16720910c330SBarry Smith F(t,U,U_t) = 0 (nonlinear) 1673d763cef2SBarry Smith .ve 1674d763cef2SBarry Smith 1675d763cef2SBarry Smith Level: beginner 1676d763cef2SBarry Smith 1677bdad233fSMatthew Knepley .keywords: TS, problem type 1678bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 1679d763cef2SBarry Smith @*/ 16807087cfbeSBarry Smith PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 1681a7cc72afSBarry Smith { 16829e2a6581SJed Brown PetscErrorCode ierr; 16839e2a6581SJed Brown 1684d763cef2SBarry Smith PetscFunctionBegin; 16850700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1686bdad233fSMatthew Knepley ts->problem_type = type; 16879e2a6581SJed Brown if (type == TS_LINEAR) { 16889e2a6581SJed Brown SNES snes; 16899e2a6581SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 16909e2a6581SJed Brown ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr); 16919e2a6581SJed Brown } 1692d763cef2SBarry Smith PetscFunctionReturn(0); 1693d763cef2SBarry Smith } 1694d763cef2SBarry Smith 1695bdad233fSMatthew Knepley #undef __FUNCT__ 1696bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType" 1697bdad233fSMatthew Knepley /*@C 1698bdad233fSMatthew Knepley TSGetProblemType - Gets the type of problem to be solved. 1699bdad233fSMatthew Knepley 1700bdad233fSMatthew Knepley Not collective 1701bdad233fSMatthew Knepley 1702bdad233fSMatthew Knepley Input Parameter: 1703bdad233fSMatthew Knepley . ts - The TS 1704bdad233fSMatthew Knepley 1705bdad233fSMatthew Knepley Output Parameter: 1706bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 1707bdad233fSMatthew Knepley .vb 1708089b2837SJed Brown M U_t = A U 1709089b2837SJed Brown M(t) U_t = A(t) U 1710b5abc632SBarry Smith F(t,U,U_t) 1711bdad233fSMatthew Knepley .ve 1712bdad233fSMatthew Knepley 1713bdad233fSMatthew Knepley Level: beginner 1714bdad233fSMatthew Knepley 1715bdad233fSMatthew Knepley .keywords: TS, problem type 1716bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 1717bdad233fSMatthew Knepley @*/ 17187087cfbeSBarry Smith PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 1719a7cc72afSBarry Smith { 1720bdad233fSMatthew Knepley PetscFunctionBegin; 17210700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 17224482741eSBarry Smith PetscValidIntPointer(type,2); 1723bdad233fSMatthew Knepley *type = ts->problem_type; 1724bdad233fSMatthew Knepley PetscFunctionReturn(0); 1725bdad233fSMatthew Knepley } 1726d763cef2SBarry Smith 17274a2ae208SSatish Balay #undef __FUNCT__ 17284a2ae208SSatish Balay #define __FUNCT__ "TSSetUp" 1729d763cef2SBarry Smith /*@ 1730d763cef2SBarry Smith TSSetUp - Sets up the internal data structures for the later use 1731d763cef2SBarry Smith of a timestepper. 1732d763cef2SBarry Smith 1733d763cef2SBarry Smith Collective on TS 1734d763cef2SBarry Smith 1735d763cef2SBarry Smith Input Parameter: 1736d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1737d763cef2SBarry Smith 1738d763cef2SBarry Smith Notes: 1739d763cef2SBarry Smith For basic use of the TS solvers the user need not explicitly call 1740d763cef2SBarry Smith TSSetUp(), since these actions will automatically occur during 1741d763cef2SBarry Smith the call to TSStep(). However, if one wishes to control this 1742d763cef2SBarry Smith phase separately, TSSetUp() should be called after TSCreate() 1743d763cef2SBarry Smith and optional routines of the form TSSetXXX(), but before TSStep(). 1744d763cef2SBarry Smith 1745d763cef2SBarry Smith Level: advanced 1746d763cef2SBarry Smith 1747d763cef2SBarry Smith .keywords: TS, timestep, setup 1748d763cef2SBarry Smith 1749d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy() 1750d763cef2SBarry Smith @*/ 17517087cfbeSBarry Smith PetscErrorCode TSSetUp(TS ts) 1752d763cef2SBarry Smith { 1753dfbe8321SBarry Smith PetscErrorCode ierr; 17546c6b9e74SPeter Brune DM dm; 17556c6b9e74SPeter Brune PetscErrorCode (*func)(SNES,Vec,Vec,void*); 17566c6b9e74SPeter Brune PetscErrorCode (*jac)(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 17576c6b9e74SPeter Brune TSIJacobian ijac; 17586c6b9e74SPeter Brune TSRHSJacobian rhsjac; 1759d763cef2SBarry Smith 1760d763cef2SBarry Smith PetscFunctionBegin; 17610700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1762277b19d0SLisandro Dalcin if (ts->setupcalled) PetscFunctionReturn(0); 1763277b19d0SLisandro Dalcin 17647adad957SLisandro Dalcin if (!((PetscObject)ts)->type_name) { 17659596e0b4SJed Brown ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr); 1766d763cef2SBarry Smith } 1767277b19d0SLisandro Dalcin 1768277b19d0SLisandro Dalcin if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first"); 1769277b19d0SLisandro Dalcin 1770552698daSJed Brown ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 17711c3436cfSJed Brown 1772e1244c69SJed Brown if (ts->rhsjacobian.reuse) { 1773e1244c69SJed Brown Mat Amat,Pmat; 1774e1244c69SJed Brown SNES snes; 1775e1244c69SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1776e1244c69SJed Brown ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr); 1777e1244c69SJed Brown /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would 1778e1244c69SJed Brown * have displaced the RHS matrix */ 1779e1244c69SJed Brown if (Amat == ts->Arhs) { 1780e1244c69SJed Brown ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr); 1781e1244c69SJed Brown ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr); 1782e1244c69SJed Brown ierr = MatDestroy(&Amat);CHKERRQ(ierr); 1783e1244c69SJed Brown } 1784e1244c69SJed Brown if (Pmat == ts->Brhs) { 1785e1244c69SJed Brown ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr); 1786e1244c69SJed Brown ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr); 1787e1244c69SJed Brown ierr = MatDestroy(&Pmat);CHKERRQ(ierr); 1788e1244c69SJed Brown } 1789e1244c69SJed Brown } 1790e1244c69SJed Brown 1791277b19d0SLisandro Dalcin if (ts->ops->setup) { 1792000e7ae3SMatthew Knepley ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr); 1793277b19d0SLisandro Dalcin } 1794277b19d0SLisandro Dalcin 17956c6b9e74SPeter Brune /* in the case where we've set a DMTSFunction or what have you, we need the default SNESFunction 17966c6b9e74SPeter Brune to be set right but can't do it elsewhere due to the overreliance on ctx=ts. 17976c6b9e74SPeter Brune */ 17986c6b9e74SPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 17990298fd71SBarry Smith ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr); 18006c6b9e74SPeter Brune if (!func) { 18016c6b9e74SPeter Brune ierr =DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr); 18026c6b9e74SPeter Brune } 18036c6b9e74SPeter Brune /* if the SNES doesn't have a jacobian set and the TS has an ijacobian or rhsjacobian set, set the SNES to use it. 18046c6b9e74SPeter Brune Otherwise, the SNES will use coloring internally to form the Jacobian. 18056c6b9e74SPeter Brune */ 18060298fd71SBarry Smith ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr); 18070298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr); 18080298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr); 18096c6b9e74SPeter Brune if (!jac && (ijac || rhsjac)) { 18106c6b9e74SPeter Brune ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr); 18116c6b9e74SPeter Brune } 1812277b19d0SLisandro Dalcin ts->setupcalled = PETSC_TRUE; 1813277b19d0SLisandro Dalcin PetscFunctionReturn(0); 1814277b19d0SLisandro Dalcin } 1815277b19d0SLisandro Dalcin 1816277b19d0SLisandro Dalcin #undef __FUNCT__ 1817277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset" 1818277b19d0SLisandro Dalcin /*@ 1819277b19d0SLisandro Dalcin TSReset - Resets a TS context and removes any allocated Vecs and Mats. 1820277b19d0SLisandro Dalcin 1821277b19d0SLisandro Dalcin Collective on TS 1822277b19d0SLisandro Dalcin 1823277b19d0SLisandro Dalcin Input Parameter: 1824277b19d0SLisandro Dalcin . ts - the TS context obtained from TSCreate() 1825277b19d0SLisandro Dalcin 1826277b19d0SLisandro Dalcin Level: beginner 1827277b19d0SLisandro Dalcin 1828277b19d0SLisandro Dalcin .keywords: TS, timestep, reset 1829277b19d0SLisandro Dalcin 1830277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy() 1831277b19d0SLisandro Dalcin @*/ 1832277b19d0SLisandro Dalcin PetscErrorCode TSReset(TS ts) 1833277b19d0SLisandro Dalcin { 1834277b19d0SLisandro Dalcin PetscErrorCode ierr; 1835277b19d0SLisandro Dalcin 1836277b19d0SLisandro Dalcin PetscFunctionBegin; 1837277b19d0SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1838277b19d0SLisandro Dalcin if (ts->ops->reset) { 1839277b19d0SLisandro Dalcin ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr); 1840277b19d0SLisandro Dalcin } 1841277b19d0SLisandro Dalcin if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);} 1842bbd56ea5SKarl Rupp 18434e684422SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 18444e684422SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1845214bc6a2SJed Brown ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr); 18466bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 1847e3d84a46SJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 1848e3d84a46SJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 184938637c2eSJed Brown ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr); 1850bbd56ea5SKarl Rupp 1851277b19d0SLisandro Dalcin ts->setupcalled = PETSC_FALSE; 1852d763cef2SBarry Smith PetscFunctionReturn(0); 1853d763cef2SBarry Smith } 1854d763cef2SBarry Smith 18554a2ae208SSatish Balay #undef __FUNCT__ 18564a2ae208SSatish Balay #define __FUNCT__ "TSDestroy" 1857d8e5e3e6SSatish Balay /*@ 1858d763cef2SBarry Smith TSDestroy - Destroys the timestepper context that was created 1859d763cef2SBarry Smith with TSCreate(). 1860d763cef2SBarry Smith 1861d763cef2SBarry Smith Collective on TS 1862d763cef2SBarry Smith 1863d763cef2SBarry Smith Input Parameter: 1864d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1865d763cef2SBarry Smith 1866d763cef2SBarry Smith Level: beginner 1867d763cef2SBarry Smith 1868d763cef2SBarry Smith .keywords: TS, timestepper, destroy 1869d763cef2SBarry Smith 1870d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve() 1871d763cef2SBarry Smith @*/ 18726bf464f9SBarry Smith PetscErrorCode TSDestroy(TS *ts) 1873d763cef2SBarry Smith { 18746849ba73SBarry Smith PetscErrorCode ierr; 1875d763cef2SBarry Smith 1876d763cef2SBarry Smith PetscFunctionBegin; 18776bf464f9SBarry Smith if (!*ts) PetscFunctionReturn(0); 18786bf464f9SBarry Smith PetscValidHeaderSpecific((*ts),TS_CLASSID,1); 18796bf464f9SBarry Smith if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);} 1880d763cef2SBarry Smith 18816bf464f9SBarry Smith ierr = TSReset((*ts));CHKERRQ(ierr); 1882277b19d0SLisandro Dalcin 1883e04113cfSBarry Smith /* if memory was published with SAWs then destroy it */ 1884e04113cfSBarry Smith ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr); 18856bf464f9SBarry Smith if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);} 18866d4c513bSLisandro Dalcin 188784df9cb4SJed Brown ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr); 18886bf464f9SBarry Smith ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr); 18896bf464f9SBarry Smith ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr); 18906bf464f9SBarry Smith ierr = TSMonitorCancel((*ts));CHKERRQ(ierr); 18916d4c513bSLisandro Dalcin 1892a79aaaedSSatish Balay ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr); 1893d763cef2SBarry Smith PetscFunctionReturn(0); 1894d763cef2SBarry Smith } 1895d763cef2SBarry Smith 18964a2ae208SSatish Balay #undef __FUNCT__ 18974a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES" 1898d8e5e3e6SSatish Balay /*@ 1899d763cef2SBarry Smith TSGetSNES - Returns the SNES (nonlinear solver) associated with 1900d763cef2SBarry Smith a TS (timestepper) context. Valid only for nonlinear problems. 1901d763cef2SBarry Smith 1902d763cef2SBarry Smith Not Collective, but SNES is parallel if TS is parallel 1903d763cef2SBarry Smith 1904d763cef2SBarry Smith Input Parameter: 1905d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1906d763cef2SBarry Smith 1907d763cef2SBarry Smith Output Parameter: 1908d763cef2SBarry Smith . snes - the nonlinear solver context 1909d763cef2SBarry Smith 1910d763cef2SBarry Smith Notes: 1911d763cef2SBarry Smith The user can then directly manipulate the SNES context to set various 1912d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 191394b7f48cSBarry Smith KSP, KSP, and PC contexts as well. 1914d763cef2SBarry Smith 1915d763cef2SBarry Smith TSGetSNES() does not work for integrators that do not use SNES; in 19160298fd71SBarry Smith this case TSGetSNES() returns NULL in snes. 1917d763cef2SBarry Smith 1918d763cef2SBarry Smith Level: beginner 1919d763cef2SBarry Smith 1920d763cef2SBarry Smith .keywords: timestep, get, SNES 1921d763cef2SBarry Smith @*/ 19227087cfbeSBarry Smith PetscErrorCode TSGetSNES(TS ts,SNES *snes) 1923d763cef2SBarry Smith { 1924d372ba47SLisandro Dalcin PetscErrorCode ierr; 1925d372ba47SLisandro Dalcin 1926d763cef2SBarry Smith PetscFunctionBegin; 19270700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 19284482741eSBarry Smith PetscValidPointer(snes,2); 1929d372ba47SLisandro Dalcin if (!ts->snes) { 1930ce94432eSBarry Smith ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr); 19310298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 1932d372ba47SLisandro Dalcin ierr = PetscLogObjectParent(ts,ts->snes);CHKERRQ(ierr); 1933d372ba47SLisandro Dalcin ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr); 1934496e6a7aSJed Brown if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 19359e2a6581SJed Brown if (ts->problem_type == TS_LINEAR) { 19369e2a6581SJed Brown ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); 19379e2a6581SJed Brown } 1938d372ba47SLisandro Dalcin } 1939d763cef2SBarry Smith *snes = ts->snes; 1940d763cef2SBarry Smith PetscFunctionReturn(0); 1941d763cef2SBarry Smith } 1942d763cef2SBarry Smith 19434a2ae208SSatish Balay #undef __FUNCT__ 1944deb2cd25SJed Brown #define __FUNCT__ "TSSetSNES" 1945deb2cd25SJed Brown /*@ 1946deb2cd25SJed Brown TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context 1947deb2cd25SJed Brown 1948deb2cd25SJed Brown Collective 1949deb2cd25SJed Brown 1950deb2cd25SJed Brown Input Parameter: 1951deb2cd25SJed Brown + ts - the TS context obtained from TSCreate() 1952deb2cd25SJed Brown - snes - the nonlinear solver context 1953deb2cd25SJed Brown 1954deb2cd25SJed Brown Notes: 1955deb2cd25SJed Brown Most users should have the TS created by calling TSGetSNES() 1956deb2cd25SJed Brown 1957deb2cd25SJed Brown Level: developer 1958deb2cd25SJed Brown 1959deb2cd25SJed Brown .keywords: timestep, set, SNES 1960deb2cd25SJed Brown @*/ 1961deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes) 1962deb2cd25SJed Brown { 1963deb2cd25SJed Brown PetscErrorCode ierr; 1964740132f1SEmil Constantinescu PetscErrorCode (*func)(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 1965deb2cd25SJed Brown 1966deb2cd25SJed Brown PetscFunctionBegin; 1967deb2cd25SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1968deb2cd25SJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,2); 1969deb2cd25SJed Brown ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr); 1970deb2cd25SJed Brown ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr); 1971bbd56ea5SKarl Rupp 1972deb2cd25SJed Brown ts->snes = snes; 1973bbd56ea5SKarl Rupp 19740298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 19750298fd71SBarry Smith ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr); 1976740132f1SEmil Constantinescu if (func == SNESTSFormJacobian) { 19770298fd71SBarry Smith ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1978740132f1SEmil Constantinescu } 1979deb2cd25SJed Brown PetscFunctionReturn(0); 1980deb2cd25SJed Brown } 1981deb2cd25SJed Brown 1982deb2cd25SJed Brown #undef __FUNCT__ 198394b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP" 1984d8e5e3e6SSatish Balay /*@ 198594b7f48cSBarry Smith TSGetKSP - Returns the KSP (linear solver) associated with 1986d763cef2SBarry Smith a TS (timestepper) context. 1987d763cef2SBarry Smith 198894b7f48cSBarry Smith Not Collective, but KSP is parallel if TS is parallel 1989d763cef2SBarry Smith 1990d763cef2SBarry Smith Input Parameter: 1991d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1992d763cef2SBarry Smith 1993d763cef2SBarry Smith Output Parameter: 199494b7f48cSBarry Smith . ksp - the nonlinear solver context 1995d763cef2SBarry Smith 1996d763cef2SBarry Smith Notes: 199794b7f48cSBarry Smith The user can then directly manipulate the KSP context to set various 1998d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 1999d763cef2SBarry Smith KSP and PC contexts as well. 2000d763cef2SBarry Smith 200194b7f48cSBarry Smith TSGetKSP() does not work for integrators that do not use KSP; 20020298fd71SBarry Smith in this case TSGetKSP() returns NULL in ksp. 2003d763cef2SBarry Smith 2004d763cef2SBarry Smith Level: beginner 2005d763cef2SBarry Smith 200694b7f48cSBarry Smith .keywords: timestep, get, KSP 2007d763cef2SBarry Smith @*/ 20087087cfbeSBarry Smith PetscErrorCode TSGetKSP(TS ts,KSP *ksp) 2009d763cef2SBarry Smith { 2010d372ba47SLisandro Dalcin PetscErrorCode ierr; 2011089b2837SJed Brown SNES snes; 2012d372ba47SLisandro Dalcin 2013d763cef2SBarry Smith PetscFunctionBegin; 20140700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 20154482741eSBarry Smith PetscValidPointer(ksp,2); 201617186662SBarry Smith if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first"); 2017e32f2f54SBarry Smith if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()"); 2018089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2019089b2837SJed Brown ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr); 2020d763cef2SBarry Smith PetscFunctionReturn(0); 2021d763cef2SBarry Smith } 2022d763cef2SBarry Smith 2023d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */ 2024d763cef2SBarry Smith 20254a2ae208SSatish Balay #undef __FUNCT__ 2026adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration" 2027adb62b0dSMatthew Knepley /*@ 2028adb62b0dSMatthew Knepley TSGetDuration - Gets the maximum number of timesteps to use and 2029adb62b0dSMatthew Knepley maximum time for iteration. 2030adb62b0dSMatthew Knepley 20313f9fe445SBarry Smith Not Collective 2032adb62b0dSMatthew Knepley 2033adb62b0dSMatthew Knepley Input Parameters: 2034adb62b0dSMatthew Knepley + ts - the TS context obtained from TSCreate() 20350298fd71SBarry Smith . maxsteps - maximum number of iterations to use, or NULL 20360298fd71SBarry Smith - maxtime - final time to iterate to, or NULL 2037adb62b0dSMatthew Knepley 2038adb62b0dSMatthew Knepley Level: intermediate 2039adb62b0dSMatthew Knepley 2040adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time 2041adb62b0dSMatthew Knepley @*/ 20427087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 2043adb62b0dSMatthew Knepley { 2044adb62b0dSMatthew Knepley PetscFunctionBegin; 20450700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2046abc0a331SBarry Smith if (maxsteps) { 20474482741eSBarry Smith PetscValidIntPointer(maxsteps,2); 2048adb62b0dSMatthew Knepley *maxsteps = ts->max_steps; 2049adb62b0dSMatthew Knepley } 2050abc0a331SBarry Smith if (maxtime) { 20514482741eSBarry Smith PetscValidScalarPointer(maxtime,3); 2052adb62b0dSMatthew Knepley *maxtime = ts->max_time; 2053adb62b0dSMatthew Knepley } 2054adb62b0dSMatthew Knepley PetscFunctionReturn(0); 2055adb62b0dSMatthew Knepley } 2056adb62b0dSMatthew Knepley 2057adb62b0dSMatthew Knepley #undef __FUNCT__ 20584a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration" 2059d763cef2SBarry Smith /*@ 2060d763cef2SBarry Smith TSSetDuration - Sets the maximum number of timesteps to use and 2061d763cef2SBarry Smith maximum time for iteration. 2062d763cef2SBarry Smith 20633f9fe445SBarry Smith Logically Collective on TS 2064d763cef2SBarry Smith 2065d763cef2SBarry Smith Input Parameters: 2066d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2067d763cef2SBarry Smith . maxsteps - maximum number of iterations to use 2068d763cef2SBarry Smith - maxtime - final time to iterate to 2069d763cef2SBarry Smith 2070d763cef2SBarry Smith Options Database Keys: 2071d763cef2SBarry Smith . -ts_max_steps <maxsteps> - Sets maxsteps 20723bca7d26SBarry Smith . -ts_final_time <maxtime> - Sets maxtime 2073d763cef2SBarry Smith 2074d763cef2SBarry Smith Notes: 2075d763cef2SBarry Smith The default maximum number of iterations is 5000. Default time is 5.0 2076d763cef2SBarry Smith 2077d763cef2SBarry Smith Level: intermediate 2078d763cef2SBarry Smith 2079d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations 2080a43b19c4SJed Brown 2081a43b19c4SJed Brown .seealso: TSSetExactFinalTime() 2082d763cef2SBarry Smith @*/ 20837087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime) 2084d763cef2SBarry Smith { 2085d763cef2SBarry Smith PetscFunctionBegin; 20860700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2087c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(ts,maxsteps,2); 2088c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,maxtime,2); 208939b7ec4bSSean Farley if (maxsteps >= 0) ts->max_steps = maxsteps; 209039b7ec4bSSean Farley if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime; 2091d763cef2SBarry Smith PetscFunctionReturn(0); 2092d763cef2SBarry Smith } 2093d763cef2SBarry Smith 20944a2ae208SSatish Balay #undef __FUNCT__ 20954a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution" 2096d763cef2SBarry Smith /*@ 2097d763cef2SBarry Smith TSSetSolution - Sets the initial solution vector 2098d763cef2SBarry Smith for use by the TS routines. 2099d763cef2SBarry Smith 21003f9fe445SBarry Smith Logically Collective on TS and Vec 2101d763cef2SBarry Smith 2102d763cef2SBarry Smith Input Parameters: 2103d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 21040910c330SBarry Smith - u - the solution vector 2105d763cef2SBarry Smith 2106d763cef2SBarry Smith Level: beginner 2107d763cef2SBarry Smith 2108d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions 2109d763cef2SBarry Smith @*/ 21100910c330SBarry Smith PetscErrorCode TSSetSolution(TS ts,Vec u) 2111d763cef2SBarry Smith { 21128737fe31SLisandro Dalcin PetscErrorCode ierr; 2113496e6a7aSJed Brown DM dm; 21148737fe31SLisandro Dalcin 2115d763cef2SBarry Smith PetscFunctionBegin; 21160700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 21170910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,2); 21180910c330SBarry Smith ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr); 21196bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 2120bbd56ea5SKarl Rupp 21210910c330SBarry Smith ts->vec_sol = u; 2122bbd56ea5SKarl Rupp 2123496e6a7aSJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 21240910c330SBarry Smith ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr); 2125d763cef2SBarry Smith PetscFunctionReturn(0); 2126d763cef2SBarry Smith } 2127d763cef2SBarry Smith 2128e74ef692SMatthew Knepley #undef __FUNCT__ 2129e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep" 2130ac226902SBarry Smith /*@C 2131000e7ae3SMatthew Knepley TSSetPreStep - Sets the general-purpose function 21323f2090d5SJed Brown called once at the beginning of each time step. 2133000e7ae3SMatthew Knepley 21343f9fe445SBarry Smith Logically Collective on TS 2135000e7ae3SMatthew Knepley 2136000e7ae3SMatthew Knepley Input Parameters: 2137000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 2138000e7ae3SMatthew Knepley - func - The function 2139000e7ae3SMatthew Knepley 2140000e7ae3SMatthew Knepley Calling sequence of func: 2141000e7ae3SMatthew Knepley . func (TS ts); 2142000e7ae3SMatthew Knepley 2143000e7ae3SMatthew Knepley Level: intermediate 2144000e7ae3SMatthew Knepley 2145b8123daeSJed Brown Note: 2146b8123daeSJed Brown If a step is rejected, TSStep() will call this routine again before each attempt. 2147b8123daeSJed Brown The last completed time step number can be queried using TSGetTimeStepNumber(), the 2148b8123daeSJed Brown size of the step being attempted can be obtained using TSGetTimeStep(). 2149b8123daeSJed Brown 2150000e7ae3SMatthew Knepley .keywords: TS, timestep 2151b8123daeSJed Brown .seealso: TSSetPreStage(), TSSetPostStep(), TSStep() 2152000e7ae3SMatthew Knepley @*/ 21537087cfbeSBarry Smith PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS)) 2154000e7ae3SMatthew Knepley { 2155000e7ae3SMatthew Knepley PetscFunctionBegin; 21560700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2157ae60f76fSBarry Smith ts->prestep = func; 2158000e7ae3SMatthew Knepley PetscFunctionReturn(0); 2159000e7ae3SMatthew Knepley } 2160000e7ae3SMatthew Knepley 2161e74ef692SMatthew Knepley #undef __FUNCT__ 21623f2090d5SJed Brown #define __FUNCT__ "TSPreStep" 216309ee8438SJed Brown /*@ 21643f2090d5SJed Brown TSPreStep - Runs the user-defined pre-step function. 21653f2090d5SJed Brown 21663f2090d5SJed Brown Collective on TS 21673f2090d5SJed Brown 21683f2090d5SJed Brown Input Parameters: 21693f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 21703f2090d5SJed Brown 21713f2090d5SJed Brown Notes: 21723f2090d5SJed Brown TSPreStep() is typically used within time stepping implementations, 21733f2090d5SJed Brown so most users would not generally call this routine themselves. 21743f2090d5SJed Brown 21753f2090d5SJed Brown Level: developer 21763f2090d5SJed Brown 21773f2090d5SJed Brown .keywords: TS, timestep 2178b8123daeSJed Brown .seealso: TSSetPreStep(), TSPreStage(), TSPostStep() 21793f2090d5SJed Brown @*/ 21807087cfbeSBarry Smith PetscErrorCode TSPreStep(TS ts) 21813f2090d5SJed Brown { 21823f2090d5SJed Brown PetscErrorCode ierr; 21833f2090d5SJed Brown 21843f2090d5SJed Brown PetscFunctionBegin; 21850700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2186ae60f76fSBarry Smith if (ts->prestep) { 2187ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestep),(ts)); 2188312ce896SJed Brown } 21893f2090d5SJed Brown PetscFunctionReturn(0); 21903f2090d5SJed Brown } 21913f2090d5SJed Brown 21923f2090d5SJed Brown #undef __FUNCT__ 2193b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage" 2194b8123daeSJed Brown /*@C 2195b8123daeSJed Brown TSSetPreStage - Sets the general-purpose function 2196b8123daeSJed Brown called once at the beginning of each stage. 2197b8123daeSJed Brown 2198b8123daeSJed Brown Logically Collective on TS 2199b8123daeSJed Brown 2200b8123daeSJed Brown Input Parameters: 2201b8123daeSJed Brown + ts - The TS context obtained from TSCreate() 2202b8123daeSJed Brown - func - The function 2203b8123daeSJed Brown 2204b8123daeSJed Brown Calling sequence of func: 2205b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime); 2206b8123daeSJed Brown 2207b8123daeSJed Brown Level: intermediate 2208b8123daeSJed Brown 2209b8123daeSJed Brown Note: 2210b8123daeSJed Brown There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 2211b8123daeSJed Brown The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 2212b8123daeSJed Brown attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 2213b8123daeSJed Brown 2214b8123daeSJed Brown .keywords: TS, timestep 2215b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 2216b8123daeSJed Brown @*/ 2217b8123daeSJed Brown PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal)) 2218b8123daeSJed Brown { 2219b8123daeSJed Brown PetscFunctionBegin; 2220b8123daeSJed Brown PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2221ae60f76fSBarry Smith ts->prestage = func; 2222b8123daeSJed Brown PetscFunctionReturn(0); 2223b8123daeSJed Brown } 2224b8123daeSJed Brown 2225b8123daeSJed Brown #undef __FUNCT__ 2226b8123daeSJed Brown #define __FUNCT__ "TSPreStage" 2227b8123daeSJed Brown /*@ 2228b8123daeSJed Brown TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage() 2229b8123daeSJed Brown 2230b8123daeSJed Brown Collective on TS 2231b8123daeSJed Brown 2232b8123daeSJed Brown Input Parameters: 2233b8123daeSJed Brown . ts - The TS context obtained from TSCreate() 2234b8123daeSJed Brown 2235b8123daeSJed Brown Notes: 2236b8123daeSJed Brown TSPreStage() is typically used within time stepping implementations, 2237b8123daeSJed Brown most users would not generally call this routine themselves. 2238b8123daeSJed Brown 2239b8123daeSJed Brown Level: developer 2240b8123daeSJed Brown 2241b8123daeSJed Brown .keywords: TS, timestep 2242b8123daeSJed Brown .seealso: TSSetPreStep(), TSPreStep(), TSPostStep() 2243b8123daeSJed Brown @*/ 2244b8123daeSJed Brown PetscErrorCode TSPreStage(TS ts, PetscReal stagetime) 2245b8123daeSJed Brown { 2246b8123daeSJed Brown PetscErrorCode ierr; 2247b8123daeSJed Brown 2248b8123daeSJed Brown PetscFunctionBegin; 2249b8123daeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2250ae60f76fSBarry Smith if (ts->prestage) { 2251ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestage),(ts,stagetime)); 2252b8123daeSJed Brown } 2253b8123daeSJed Brown PetscFunctionReturn(0); 2254b8123daeSJed Brown } 2255b8123daeSJed Brown 2256b8123daeSJed Brown #undef __FUNCT__ 2257e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep" 2258ac226902SBarry Smith /*@C 2259000e7ae3SMatthew Knepley TSSetPostStep - Sets the general-purpose function 22603f2090d5SJed Brown called once at the end of each time step. 2261000e7ae3SMatthew Knepley 22623f9fe445SBarry Smith Logically Collective on TS 2263000e7ae3SMatthew Knepley 2264000e7ae3SMatthew Knepley Input Parameters: 2265000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 2266000e7ae3SMatthew Knepley - func - The function 2267000e7ae3SMatthew Knepley 2268000e7ae3SMatthew Knepley Calling sequence of func: 2269b8123daeSJed Brown $ func (TS ts); 2270000e7ae3SMatthew Knepley 2271000e7ae3SMatthew Knepley Level: intermediate 2272000e7ae3SMatthew Knepley 2273000e7ae3SMatthew Knepley .keywords: TS, timestep 2274b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime() 2275000e7ae3SMatthew Knepley @*/ 22767087cfbeSBarry Smith PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS)) 2277000e7ae3SMatthew Knepley { 2278000e7ae3SMatthew Knepley PetscFunctionBegin; 22790700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2280ae60f76fSBarry Smith ts->poststep = func; 2281000e7ae3SMatthew Knepley PetscFunctionReturn(0); 2282000e7ae3SMatthew Knepley } 2283000e7ae3SMatthew Knepley 2284e74ef692SMatthew Knepley #undef __FUNCT__ 22853f2090d5SJed Brown #define __FUNCT__ "TSPostStep" 228609ee8438SJed Brown /*@ 22873f2090d5SJed Brown TSPostStep - Runs the user-defined post-step function. 22883f2090d5SJed Brown 22893f2090d5SJed Brown Collective on TS 22903f2090d5SJed Brown 22913f2090d5SJed Brown Input Parameters: 22923f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 22933f2090d5SJed Brown 22943f2090d5SJed Brown Notes: 22953f2090d5SJed Brown TSPostStep() is typically used within time stepping implementations, 22963f2090d5SJed Brown so most users would not generally call this routine themselves. 22973f2090d5SJed Brown 22983f2090d5SJed Brown Level: developer 22993f2090d5SJed Brown 23003f2090d5SJed Brown .keywords: TS, timestep 23013f2090d5SJed Brown @*/ 23027087cfbeSBarry Smith PetscErrorCode TSPostStep(TS ts) 23033f2090d5SJed Brown { 23043f2090d5SJed Brown PetscErrorCode ierr; 23053f2090d5SJed Brown 23063f2090d5SJed Brown PetscFunctionBegin; 23070700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2308ae60f76fSBarry Smith if (ts->poststep) { 2309ae60f76fSBarry Smith PetscStackCallStandard((*ts->poststep),(ts)); 231072ac3e02SJed Brown } 23113f2090d5SJed Brown PetscFunctionReturn(0); 23123f2090d5SJed Brown } 23133f2090d5SJed Brown 2314d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */ 2315d763cef2SBarry Smith 23164a2ae208SSatish Balay #undef __FUNCT__ 2317a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet" 2318d763cef2SBarry Smith /*@C 2319a6570f20SBarry Smith TSMonitorSet - Sets an ADDITIONAL function that is to be used at every 2320d763cef2SBarry Smith timestep to display the iteration's progress. 2321d763cef2SBarry Smith 23223f9fe445SBarry Smith Logically Collective on TS 2323d763cef2SBarry Smith 2324d763cef2SBarry Smith Input Parameters: 2325d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2326e213d8f1SJed Brown . monitor - monitoring routine 2327329f5518SBarry Smith . mctx - [optional] user-defined context for private data for the 23280298fd71SBarry Smith monitor routine (use NULL if no context is desired) 2329b3006f0bSLois Curfman McInnes - monitordestroy - [optional] routine that frees monitor context 23300298fd71SBarry Smith (may be NULL) 2331d763cef2SBarry Smith 2332e213d8f1SJed Brown Calling sequence of monitor: 23330910c330SBarry Smith $ int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx) 2334d763cef2SBarry Smith 2335d763cef2SBarry Smith + ts - the TS context 233688c05cc5SBarry Smith . 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 233788c05cc5SBarry Smith been interpolated to) 23381f06c33eSBarry Smith . time - current time 23390910c330SBarry Smith . u - current iterate 2340d763cef2SBarry Smith - mctx - [optional] monitoring context 2341d763cef2SBarry Smith 2342d763cef2SBarry Smith Notes: 2343d763cef2SBarry Smith This routine adds an additional monitor to the list of monitors that 2344d763cef2SBarry Smith already has been loaded. 2345d763cef2SBarry Smith 2346025f1a04SBarry Smith Fortran notes: Only a single monitor function can be set for each TS object 2347025f1a04SBarry Smith 2348d763cef2SBarry Smith Level: intermediate 2349d763cef2SBarry Smith 2350d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 2351d763cef2SBarry Smith 2352a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel() 2353d763cef2SBarry Smith @*/ 2354c2efdce3SBarry Smith PetscErrorCode TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**)) 2355d763cef2SBarry Smith { 2356d763cef2SBarry Smith PetscFunctionBegin; 23570700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 235817186662SBarry Smith if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 2359d763cef2SBarry Smith ts->monitor[ts->numbermonitors] = monitor; 23608704b422SBarry Smith ts->monitordestroy[ts->numbermonitors] = mdestroy; 2361d763cef2SBarry Smith ts->monitorcontext[ts->numbermonitors++] = (void*)mctx; 2362d763cef2SBarry Smith PetscFunctionReturn(0); 2363d763cef2SBarry Smith } 2364d763cef2SBarry Smith 23654a2ae208SSatish Balay #undef __FUNCT__ 2366a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel" 2367d763cef2SBarry Smith /*@C 2368a6570f20SBarry Smith TSMonitorCancel - Clears all the monitors that have been set on a time-step object. 2369d763cef2SBarry Smith 23703f9fe445SBarry Smith Logically Collective on TS 2371d763cef2SBarry Smith 2372d763cef2SBarry Smith Input Parameters: 2373d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2374d763cef2SBarry Smith 2375d763cef2SBarry Smith Notes: 2376d763cef2SBarry Smith There is no way to remove a single, specific monitor. 2377d763cef2SBarry Smith 2378d763cef2SBarry Smith Level: intermediate 2379d763cef2SBarry Smith 2380d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 2381d763cef2SBarry Smith 2382a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet() 2383d763cef2SBarry Smith @*/ 23847087cfbeSBarry Smith PetscErrorCode TSMonitorCancel(TS ts) 2385d763cef2SBarry Smith { 2386d952e501SBarry Smith PetscErrorCode ierr; 2387d952e501SBarry Smith PetscInt i; 2388d952e501SBarry Smith 2389d763cef2SBarry Smith PetscFunctionBegin; 23900700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2391d952e501SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 23928704b422SBarry Smith if (ts->monitordestroy[i]) { 23938704b422SBarry Smith ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr); 2394d952e501SBarry Smith } 2395d952e501SBarry Smith } 2396d763cef2SBarry Smith ts->numbermonitors = 0; 2397d763cef2SBarry Smith PetscFunctionReturn(0); 2398d763cef2SBarry Smith } 2399d763cef2SBarry Smith 24004a2ae208SSatish Balay #undef __FUNCT__ 2401a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault" 2402d8e5e3e6SSatish Balay /*@ 2403a6570f20SBarry Smith TSMonitorDefault - Sets the Default monitor 24045516499fSSatish Balay 24055516499fSSatish Balay Level: intermediate 240641251cbbSSatish Balay 24075516499fSSatish Balay .keywords: TS, set, monitor 24085516499fSSatish Balay 240941251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet() 241041251cbbSSatish Balay @*/ 2411649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy) 2412d763cef2SBarry Smith { 2413dfbe8321SBarry Smith PetscErrorCode ierr; 2414ce94432eSBarry Smith PetscViewer viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)ts)); 2415d132466eSBarry Smith 2416d763cef2SBarry Smith PetscFunctionBegin; 2417649052a6SBarry Smith ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 2418971832b6SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g\n",step,(double)ts->time_step,(double)ptime);CHKERRQ(ierr); 2419649052a6SBarry Smith ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 2420d763cef2SBarry Smith PetscFunctionReturn(0); 2421d763cef2SBarry Smith } 2422d763cef2SBarry Smith 24234a2ae208SSatish Balay #undef __FUNCT__ 2424cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages" 2425cd652676SJed Brown /*@ 2426cd652676SJed Brown TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available. 2427cd652676SJed Brown 2428cd652676SJed Brown Logically Collective on TS 2429cd652676SJed Brown 2430cd652676SJed Brown Input Argument: 2431cd652676SJed Brown . ts - time stepping context 2432cd652676SJed Brown 2433cd652676SJed Brown Output Argument: 2434cd652676SJed Brown . flg - PETSC_TRUE or PETSC_FALSE 2435cd652676SJed Brown 2436cd652676SJed Brown Level: intermediate 2437cd652676SJed Brown 2438cd652676SJed Brown .keywords: TS, set 2439cd652676SJed Brown 2440cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep() 2441cd652676SJed Brown @*/ 2442cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg) 2443cd652676SJed Brown { 2444cd652676SJed Brown PetscFunctionBegin; 2445cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2446cd652676SJed Brown ts->retain_stages = flg; 2447cd652676SJed Brown PetscFunctionReturn(0); 2448cd652676SJed Brown } 2449cd652676SJed Brown 2450cd652676SJed Brown #undef __FUNCT__ 2451cd652676SJed Brown #define __FUNCT__ "TSInterpolate" 2452cd652676SJed Brown /*@ 2453cd652676SJed Brown TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval 2454cd652676SJed Brown 2455cd652676SJed Brown Collective on TS 2456cd652676SJed Brown 2457cd652676SJed Brown Input Argument: 2458cd652676SJed Brown + ts - time stepping context 2459cd652676SJed Brown - t - time to interpolate to 2460cd652676SJed Brown 2461cd652676SJed Brown Output Argument: 24620910c330SBarry Smith . U - state at given time 2463cd652676SJed Brown 2464cd652676SJed Brown Notes: 2465cd652676SJed Brown The user should call TSSetRetainStages() before taking a step in which interpolation will be requested. 2466cd652676SJed Brown 2467cd652676SJed Brown Level: intermediate 2468cd652676SJed Brown 2469cd652676SJed Brown Developer Notes: 2470cd652676SJed Brown TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints. 2471cd652676SJed Brown 2472cd652676SJed Brown .keywords: TS, set 2473cd652676SJed Brown 2474cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep() 2475cd652676SJed Brown @*/ 24760910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U) 2477cd652676SJed Brown { 2478cd652676SJed Brown PetscErrorCode ierr; 2479cd652676SJed Brown 2480cd652676SJed Brown PetscFunctionBegin; 2481cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2482b06615a5SLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 2483ce94432eSBarry Smith if (t < ts->ptime - ts->time_step_prev || t > ts->ptime) SETERRQ3(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Requested time %G not in last time steps [%G,%G]",t,ts->ptime-ts->time_step_prev,ts->ptime); 2484ce94432eSBarry Smith if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name); 24850910c330SBarry Smith ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr); 2486cd652676SJed Brown PetscFunctionReturn(0); 2487cd652676SJed Brown } 2488cd652676SJed Brown 2489cd652676SJed Brown #undef __FUNCT__ 24904a2ae208SSatish Balay #define __FUNCT__ "TSStep" 2491d763cef2SBarry Smith /*@ 24926d9e5789SSean Farley TSStep - Steps one time step 2493d763cef2SBarry Smith 2494d763cef2SBarry Smith Collective on TS 2495d763cef2SBarry Smith 2496d763cef2SBarry Smith Input Parameter: 2497d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2498d763cef2SBarry Smith 24996d9e5789SSean Farley Level: intermediate 2500d763cef2SBarry Smith 2501b8123daeSJed Brown Notes: 2502b8123daeSJed Brown The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may 2503b8123daeSJed Brown be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages. 2504b8123daeSJed Brown 250525cb2221SBarry Smith This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the 250625cb2221SBarry Smith time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep. 250725cb2221SBarry Smith 2508d763cef2SBarry Smith .keywords: TS, timestep, solve 2509d763cef2SBarry Smith 251025cb2221SBarry Smith .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate() 2511d763cef2SBarry Smith @*/ 2512193ac0bcSJed Brown PetscErrorCode TSStep(TS ts) 2513d763cef2SBarry Smith { 2514362cd11cSLisandro Dalcin PetscReal ptime_prev; 2515dfbe8321SBarry Smith PetscErrorCode ierr; 2516d763cef2SBarry Smith 2517d763cef2SBarry Smith PetscFunctionBegin; 25180700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2519d405a339SMatthew Knepley ierr = TSSetUp(ts);CHKERRQ(ierr); 2520d405a339SMatthew Knepley 2521362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_ITERATING; 2522362cd11cSLisandro Dalcin ptime_prev = ts->ptime; 2523bbd56ea5SKarl Rupp 2524d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 2525193ac0bcSJed Brown ierr = (*ts->ops->step)(ts);CHKERRQ(ierr); 2526d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 2527bbd56ea5SKarl Rupp 2528362cd11cSLisandro Dalcin ts->time_step_prev = ts->ptime - ptime_prev; 2529362cd11cSLisandro Dalcin 2530362cd11cSLisandro Dalcin if (ts->reason < 0) { 2531cef5090cSJed Brown if (ts->errorifstepfailed) { 2532cef5090cSJed Brown if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) { 2533ce94432eSBarry Smith 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]); 2534ce94432eSBarry Smith } else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 2535cef5090cSJed Brown } 2536362cd11cSLisandro Dalcin } else if (!ts->reason) { 2537db4deed7SKarl Rupp if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 2538db4deed7SKarl Rupp else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 2539362cd11cSLisandro Dalcin } 2540d763cef2SBarry Smith PetscFunctionReturn(0); 2541d763cef2SBarry Smith } 2542d763cef2SBarry Smith 25434a2ae208SSatish Balay #undef __FUNCT__ 254405175c85SJed Brown #define __FUNCT__ "TSEvaluateStep" 254505175c85SJed Brown /*@ 254605175c85SJed Brown TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy. 254705175c85SJed Brown 25481c3436cfSJed Brown Collective on TS 254905175c85SJed Brown 255005175c85SJed Brown Input Arguments: 25511c3436cfSJed Brown + ts - time stepping context 25521c3436cfSJed Brown . order - desired order of accuracy 25530298fd71SBarry Smith - done - whether the step was evaluated at this order (pass NULL to generate an error if not available) 255405175c85SJed Brown 255505175c85SJed Brown Output Arguments: 25560910c330SBarry Smith . U - state at the end of the current step 255705175c85SJed Brown 255805175c85SJed Brown Level: advanced 255905175c85SJed Brown 2560108c343cSJed Brown Notes: 2561108c343cSJed Brown This function cannot be called until all stages have been evaluated. 2562108c343cSJed Brown It is normally called by adaptive controllers before a step has been accepted and may also be called by the user after TSStep() has returned. 2563108c343cSJed Brown 25641c3436cfSJed Brown .seealso: TSStep(), TSAdapt 256505175c85SJed Brown @*/ 25660910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done) 256705175c85SJed Brown { 256805175c85SJed Brown PetscErrorCode ierr; 256905175c85SJed Brown 257005175c85SJed Brown PetscFunctionBegin; 257105175c85SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 257205175c85SJed Brown PetscValidType(ts,1); 25730910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 2574ce94432eSBarry Smith if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name); 25750910c330SBarry Smith ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr); 257605175c85SJed Brown PetscFunctionReturn(0); 257705175c85SJed Brown } 257805175c85SJed Brown 257905175c85SJed Brown #undef __FUNCT__ 25806a4d4014SLisandro Dalcin #define __FUNCT__ "TSSolve" 25816a4d4014SLisandro Dalcin /*@ 25826a4d4014SLisandro Dalcin TSSolve - Steps the requested number of timesteps. 25836a4d4014SLisandro Dalcin 25846a4d4014SLisandro Dalcin Collective on TS 25856a4d4014SLisandro Dalcin 25866a4d4014SLisandro Dalcin Input Parameter: 25876a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 2588cc708dedSBarry Smith - u - the solution vector (can be null if TSSetSolution() was used, otherwise must contain the initial conditions) 25895a3a76d0SJed Brown 25906a4d4014SLisandro Dalcin Level: beginner 25916a4d4014SLisandro Dalcin 25925a3a76d0SJed Brown Notes: 25935a3a76d0SJed Brown The final time returned by this function may be different from the time of the internally 25945a3a76d0SJed Brown held state accessible by TSGetSolution() and TSGetTime() because the method may have 25955a3a76d0SJed Brown stepped over the final time. 25965a3a76d0SJed Brown 25976a4d4014SLisandro Dalcin .keywords: TS, timestep, solve 25986a4d4014SLisandro Dalcin 25996a4d4014SLisandro Dalcin .seealso: TSCreate(), TSSetSolution(), TSStep() 26006a4d4014SLisandro Dalcin @*/ 2601cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u) 26026a4d4014SLisandro Dalcin { 26034d7d938eSLisandro Dalcin PetscBool flg; 26044d7d938eSLisandro Dalcin PetscViewer viewer; 2605b06615a5SLisandro Dalcin Vec solution; 26066a4d4014SLisandro Dalcin PetscErrorCode ierr; 2607cffb1e40SBarry Smith PetscViewerFormat format; 2608f22f69f0SBarry Smith 26096a4d4014SLisandro Dalcin PetscFunctionBegin; 26100700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2611f2c2a1b9SBarry Smith if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2); 261249354f04SShri Abhyankar 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 */ 2613b06615a5SLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,2); 26140910c330SBarry Smith if (!ts->vec_sol || u == ts->vec_sol) { 2615b06615a5SLisandro Dalcin ierr = VecDuplicate(u,&solution);CHKERRQ(ierr); 2616b06615a5SLisandro Dalcin ierr = TSSetSolution(ts,solution);CHKERRQ(ierr); 2617b06615a5SLisandro Dalcin ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */ 26185a3a76d0SJed Brown } 26190910c330SBarry Smith ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr); 2620bbd56ea5SKarl Rupp } else if (u) { 26210910c330SBarry Smith ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 26225a3a76d0SJed Brown } 2623b5d403baSSean Farley ierr = TSSetUp(ts);CHKERRQ(ierr); 26246a4d4014SLisandro Dalcin /* reset time step and iteration counters */ 2625193ac0bcSJed Brown ts->steps = 0; 26265ef26d82SJed Brown ts->ksp_its = 0; 26275ef26d82SJed Brown ts->snes_its = 0; 2628c610991cSLisandro Dalcin ts->num_snes_failures = 0; 2629c610991cSLisandro Dalcin ts->reject = 0; 2630193ac0bcSJed Brown ts->reason = TS_CONVERGED_ITERATING; 2631193ac0bcSJed Brown 2632f05ece33SBarry Smith ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,"-ts_view_pre",&viewer,&format,&flg);CHKERRQ(ierr); 2633f05ece33SBarry Smith if (flg && !PetscPreLoadingOn) { 2634f05ece33SBarry Smith ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr); 2635f05ece33SBarry Smith ierr = TSView(ts,viewer);CHKERRQ(ierr); 2636f05ece33SBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 2637f05ece33SBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 2638f05ece33SBarry Smith } 2639f05ece33SBarry Smith 2640193ac0bcSJed Brown if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 2641193ac0bcSJed Brown ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr); 26420910c330SBarry Smith ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr); 2643cc708dedSBarry Smith ts->solvetime = ts->ptime; 2644193ac0bcSJed Brown } else { 26456a4d4014SLisandro Dalcin /* steps the requested number of timesteps. */ 2646db4deed7SKarl Rupp if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 2647db4deed7SKarl Rupp else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 2648e1a7a14fSJed Brown while (!ts->reason) { 2649b06615a5SLisandro Dalcin ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 2650193ac0bcSJed Brown ierr = TSStep(ts);CHKERRQ(ierr); 2651193ac0bcSJed Brown ierr = TSPostStep(ts);CHKERRQ(ierr); 2652193ac0bcSJed Brown } 265349354f04SShri Abhyankar if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) { 26540910c330SBarry Smith ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr); 2655cc708dedSBarry Smith ts->solvetime = ts->max_time; 2656b06615a5SLisandro Dalcin solution = u; 26570574a7fbSJed Brown } else { 2658ad6bc421SBarry Smith if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 2659cc708dedSBarry Smith ts->solvetime = ts->ptime; 2660b06615a5SLisandro Dalcin solution = ts->vec_sol; 26610574a7fbSJed Brown } 2662b06615a5SLisandro Dalcin ierr = TSMonitor(ts,ts->steps,ts->solvetime,solution);CHKERRQ(ierr); 2663193ac0bcSJed Brown } 2664ce94432eSBarry Smith ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,"-ts_view",&viewer,&format,&flg);CHKERRQ(ierr); 26654d7d938eSLisandro Dalcin if (flg && !PetscPreLoadingOn) { 2666cffb1e40SBarry Smith ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr); 26674d7d938eSLisandro Dalcin ierr = TSView(ts,viewer);CHKERRQ(ierr); 2668cffb1e40SBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 2669cffb1e40SBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 26702b0a91c0SBarry Smith } 2671*56f85f32SBarry Smith ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr); 26726a4d4014SLisandro Dalcin PetscFunctionReturn(0); 26736a4d4014SLisandro Dalcin } 26746a4d4014SLisandro Dalcin 26756a4d4014SLisandro Dalcin #undef __FUNCT__ 26764a2ae208SSatish Balay #define __FUNCT__ "TSMonitor" 2677228d79bcSJed Brown /*@ 2678228d79bcSJed Brown TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet() 2679228d79bcSJed Brown 2680228d79bcSJed Brown Collective on TS 2681228d79bcSJed Brown 2682228d79bcSJed Brown Input Parameters: 2683228d79bcSJed Brown + ts - time stepping context obtained from TSCreate() 2684228d79bcSJed Brown . step - step number that has just completed 2685228d79bcSJed Brown . ptime - model time of the state 26860910c330SBarry Smith - u - state at the current model time 2687228d79bcSJed Brown 2688228d79bcSJed Brown Notes: 2689228d79bcSJed Brown TSMonitor() is typically used within the time stepping implementations. 2690228d79bcSJed Brown Users might call this function when using the TSStep() interface instead of TSSolve(). 2691228d79bcSJed Brown 2692228d79bcSJed Brown Level: advanced 2693228d79bcSJed Brown 2694228d79bcSJed Brown .keywords: TS, timestep 2695228d79bcSJed Brown @*/ 26960910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u) 2697d763cef2SBarry Smith { 26986849ba73SBarry Smith PetscErrorCode ierr; 2699a7cc72afSBarry Smith PetscInt i,n = ts->numbermonitors; 2700d763cef2SBarry Smith 2701d763cef2SBarry Smith PetscFunctionBegin; 2702b06615a5SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2703b06615a5SLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,4); 2704d763cef2SBarry Smith for (i=0; i<n; i++) { 27050910c330SBarry Smith ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr); 2706d763cef2SBarry Smith } 2707d763cef2SBarry Smith PetscFunctionReturn(0); 2708d763cef2SBarry Smith } 2709d763cef2SBarry Smith 2710d763cef2SBarry Smith /* ------------------------------------------------------------------------*/ 27110b039ecaSBarry Smith struct _n_TSMonitorLGCtx { 27120b039ecaSBarry Smith PetscDrawLG lg; 27130b039ecaSBarry Smith PetscInt howoften; /* when > 0 uses step % howoften, when negative only final solution plotted */ 2714201da799SBarry Smith PetscInt ksp_its,snes_its; 27150b039ecaSBarry Smith }; 27160b039ecaSBarry Smith 2717d763cef2SBarry Smith 27184a2ae208SSatish Balay #undef __FUNCT__ 2719a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate" 2720d763cef2SBarry Smith /*@C 2721a9f9c1f6SBarry Smith TSMonitorLGCtxCreate - Creates a line graph context for use with 2722a9f9c1f6SBarry Smith TS to monitor the solution process graphically in various ways 2723d763cef2SBarry Smith 2724d763cef2SBarry Smith Collective on TS 2725d763cef2SBarry Smith 2726d763cef2SBarry Smith Input Parameters: 2727d763cef2SBarry Smith + host - the X display to open, or null for the local machine 2728d763cef2SBarry Smith . label - the title to put in the title bar 27297c922b88SBarry Smith . x, y - the screen coordinates of the upper left coordinate of the window 2730a9f9c1f6SBarry Smith . m, n - the screen width and height in pixels 2731a9f9c1f6SBarry Smith - howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time 2732d763cef2SBarry Smith 2733d763cef2SBarry Smith Output Parameter: 27340b039ecaSBarry Smith . ctx - the context 2735d763cef2SBarry Smith 2736d763cef2SBarry Smith Options Database Key: 27374f09c107SBarry Smith + -ts_monitor_lg_timestep - automatically sets line graph monitor 27384f09c107SBarry Smith . -ts_monitor_lg_solution - 273999fdda47SBarry Smith . -ts_monitor_lg_error - 274099fdda47SBarry Smith . -ts_monitor_lg_ksp_iterations - 274199fdda47SBarry Smith . -ts_monitor_lg_snes_iterations - 274299fdda47SBarry Smith - -lg_indicate_data_points <true,false> - indicate the data points (at each time step) on the plot; default is true 2743d763cef2SBarry Smith 2744d763cef2SBarry Smith Notes: 2745a9f9c1f6SBarry Smith Use TSMonitorLGCtxDestroy() to destroy. 2746d763cef2SBarry Smith 2747d763cef2SBarry Smith Level: intermediate 2748d763cef2SBarry Smith 27497c922b88SBarry Smith .keywords: TS, monitor, line graph, residual, seealso 2750d763cef2SBarry Smith 27514f09c107SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError() 27527c922b88SBarry Smith 2753d763cef2SBarry Smith @*/ 2754a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx) 2755d763cef2SBarry Smith { 2756b0a32e0cSBarry Smith PetscDraw win; 2757dfbe8321SBarry Smith PetscErrorCode ierr; 275899fdda47SBarry Smith PetscBool flg = PETSC_TRUE; 2759d763cef2SBarry Smith 2760d763cef2SBarry Smith PetscFunctionBegin; 2761201da799SBarry Smith ierr = PetscNew(struct _n_TSMonitorLGCtx,ctx);CHKERRQ(ierr); 2762a80ad3e0SBarry Smith ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&win);CHKERRQ(ierr); 27633fbbecb0SBarry Smith ierr = PetscDrawSetFromOptions(win);CHKERRQ(ierr); 27640b039ecaSBarry Smith ierr = PetscDrawLGCreate(win,1,&(*ctx)->lg);CHKERRQ(ierr); 27650298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-lg_indicate_data_points",&flg,NULL);CHKERRQ(ierr); 276699fdda47SBarry Smith if (flg) { 27670b039ecaSBarry Smith ierr = PetscDrawLGIndicateDataPoints((*ctx)->lg);CHKERRQ(ierr); 276899fdda47SBarry Smith } 27690b039ecaSBarry Smith ierr = PetscLogObjectParent((*ctx)->lg,win);CHKERRQ(ierr); 2770a9f9c1f6SBarry Smith (*ctx)->howoften = howoften; 2771d763cef2SBarry Smith PetscFunctionReturn(0); 2772d763cef2SBarry Smith } 2773d763cef2SBarry Smith 27744a2ae208SSatish Balay #undef __FUNCT__ 27754f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep" 2776b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx) 2777d763cef2SBarry Smith { 27780b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 2779c32365f1SBarry Smith PetscReal x = ptime,y; 2780dfbe8321SBarry Smith PetscErrorCode ierr; 2781d763cef2SBarry Smith 2782d763cef2SBarry Smith PetscFunctionBegin; 2783b06615a5SLisandro Dalcin if (!step) { 2784a9f9c1f6SBarry Smith PetscDrawAxis axis; 2785a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 2786a9f9c1f6SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time step");CHKERRQ(ierr); 2787a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 2788a9f9c1f6SBarry Smith } 2789c32365f1SBarry Smith ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr); 27900b039ecaSBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 2791b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 27920b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 27933923b477SBarry Smith } 2794d763cef2SBarry Smith PetscFunctionReturn(0); 2795d763cef2SBarry Smith } 2796d763cef2SBarry Smith 27974a2ae208SSatish Balay #undef __FUNCT__ 2798a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy" 2799d763cef2SBarry Smith /*@C 2800a9f9c1f6SBarry Smith TSMonitorLGCtxDestroy - Destroys a line graph context that was created 2801a9f9c1f6SBarry Smith with TSMonitorLGCtxCreate(). 2802d763cef2SBarry Smith 28030b039ecaSBarry Smith Collective on TSMonitorLGCtx 2804d763cef2SBarry Smith 2805d763cef2SBarry Smith Input Parameter: 28060b039ecaSBarry Smith . ctx - the monitor context 2807d763cef2SBarry Smith 2808d763cef2SBarry Smith Level: intermediate 2809d763cef2SBarry Smith 2810d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy 2811d763cef2SBarry Smith 28124f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep(); 2813d763cef2SBarry Smith @*/ 2814a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx) 2815d763cef2SBarry Smith { 2816b0a32e0cSBarry Smith PetscDraw draw; 2817dfbe8321SBarry Smith PetscErrorCode ierr; 2818d763cef2SBarry Smith 2819d763cef2SBarry Smith PetscFunctionBegin; 28200b039ecaSBarry Smith ierr = PetscDrawLGGetDraw((*ctx)->lg,&draw);CHKERRQ(ierr); 28216bf464f9SBarry Smith ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 28220b039ecaSBarry Smith ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr); 28230b039ecaSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 2824d763cef2SBarry Smith PetscFunctionReturn(0); 2825d763cef2SBarry Smith } 2826d763cef2SBarry Smith 28274a2ae208SSatish Balay #undef __FUNCT__ 28284a2ae208SSatish Balay #define __FUNCT__ "TSGetTime" 2829d763cef2SBarry Smith /*@ 2830b8123daeSJed Brown TSGetTime - Gets the time of the most recently completed step. 2831d763cef2SBarry Smith 2832d763cef2SBarry Smith Not Collective 2833d763cef2SBarry Smith 2834d763cef2SBarry Smith Input Parameter: 2835d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2836d763cef2SBarry Smith 2837d763cef2SBarry Smith Output Parameter: 2838d763cef2SBarry Smith . t - the current time 2839d763cef2SBarry Smith 2840d763cef2SBarry Smith Level: beginner 2841d763cef2SBarry Smith 2842b8123daeSJed Brown Note: 2843b8123daeSJed Brown When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(), 2844b8123daeSJed Brown TSSetPreStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated. 2845b8123daeSJed Brown 2846d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 2847d763cef2SBarry Smith 2848d763cef2SBarry Smith .keywords: TS, get, time 2849d763cef2SBarry Smith @*/ 28507087cfbeSBarry Smith PetscErrorCode TSGetTime(TS ts,PetscReal *t) 2851d763cef2SBarry Smith { 2852d763cef2SBarry Smith PetscFunctionBegin; 28530700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2854f7cf8827SBarry Smith PetscValidRealPointer(t,2); 2855d763cef2SBarry Smith *t = ts->ptime; 2856d763cef2SBarry Smith PetscFunctionReturn(0); 2857d763cef2SBarry Smith } 2858d763cef2SBarry Smith 28594a2ae208SSatish Balay #undef __FUNCT__ 28606a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime" 28616a4d4014SLisandro Dalcin /*@ 28626a4d4014SLisandro Dalcin TSSetTime - Allows one to reset the time. 28636a4d4014SLisandro Dalcin 28643f9fe445SBarry Smith Logically Collective on TS 28656a4d4014SLisandro Dalcin 28666a4d4014SLisandro Dalcin Input Parameters: 28676a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 28686a4d4014SLisandro Dalcin - time - the time 28696a4d4014SLisandro Dalcin 28706a4d4014SLisandro Dalcin Level: intermediate 28716a4d4014SLisandro Dalcin 28726a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration() 28736a4d4014SLisandro Dalcin 28746a4d4014SLisandro Dalcin .keywords: TS, set, time 28756a4d4014SLisandro Dalcin @*/ 28767087cfbeSBarry Smith PetscErrorCode TSSetTime(TS ts, PetscReal t) 28776a4d4014SLisandro Dalcin { 28786a4d4014SLisandro Dalcin PetscFunctionBegin; 28790700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2880c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,t,2); 28816a4d4014SLisandro Dalcin ts->ptime = t; 28826a4d4014SLisandro Dalcin PetscFunctionReturn(0); 28836a4d4014SLisandro Dalcin } 28846a4d4014SLisandro Dalcin 28856a4d4014SLisandro Dalcin #undef __FUNCT__ 28864a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix" 2887d763cef2SBarry Smith /*@C 2888d763cef2SBarry Smith TSSetOptionsPrefix - Sets the prefix used for searching for all 2889d763cef2SBarry Smith TS options in the database. 2890d763cef2SBarry Smith 28913f9fe445SBarry Smith Logically Collective on TS 2892d763cef2SBarry Smith 2893d763cef2SBarry Smith Input Parameter: 2894d763cef2SBarry Smith + ts - The TS context 2895d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 2896d763cef2SBarry Smith 2897d763cef2SBarry Smith Notes: 2898d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 2899d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 2900d763cef2SBarry Smith hyphen. 2901d763cef2SBarry Smith 2902d763cef2SBarry Smith Level: advanced 2903d763cef2SBarry Smith 2904d763cef2SBarry Smith .keywords: TS, set, options, prefix, database 2905d763cef2SBarry Smith 2906d763cef2SBarry Smith .seealso: TSSetFromOptions() 2907d763cef2SBarry Smith 2908d763cef2SBarry Smith @*/ 29097087cfbeSBarry Smith PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[]) 2910d763cef2SBarry Smith { 2911dfbe8321SBarry Smith PetscErrorCode ierr; 2912089b2837SJed Brown SNES snes; 2913d763cef2SBarry Smith 2914d763cef2SBarry Smith PetscFunctionBegin; 29150700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2916d763cef2SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 2917089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2918089b2837SJed Brown ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr); 2919d763cef2SBarry Smith PetscFunctionReturn(0); 2920d763cef2SBarry Smith } 2921d763cef2SBarry Smith 2922d763cef2SBarry Smith 29234a2ae208SSatish Balay #undef __FUNCT__ 29244a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix" 2925d763cef2SBarry Smith /*@C 2926d763cef2SBarry Smith TSAppendOptionsPrefix - Appends to the prefix used for searching for all 2927d763cef2SBarry Smith TS options in the database. 2928d763cef2SBarry Smith 29293f9fe445SBarry Smith Logically Collective on TS 2930d763cef2SBarry Smith 2931d763cef2SBarry Smith Input Parameter: 2932d763cef2SBarry Smith + ts - The TS context 2933d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 2934d763cef2SBarry Smith 2935d763cef2SBarry Smith Notes: 2936d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 2937d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 2938d763cef2SBarry Smith hyphen. 2939d763cef2SBarry Smith 2940d763cef2SBarry Smith Level: advanced 2941d763cef2SBarry Smith 2942d763cef2SBarry Smith .keywords: TS, append, options, prefix, database 2943d763cef2SBarry Smith 2944d763cef2SBarry Smith .seealso: TSGetOptionsPrefix() 2945d763cef2SBarry Smith 2946d763cef2SBarry Smith @*/ 29477087cfbeSBarry Smith PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[]) 2948d763cef2SBarry Smith { 2949dfbe8321SBarry Smith PetscErrorCode ierr; 2950089b2837SJed Brown SNES snes; 2951d763cef2SBarry Smith 2952d763cef2SBarry Smith PetscFunctionBegin; 29530700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2954d763cef2SBarry Smith ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 2955089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2956089b2837SJed Brown ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr); 2957d763cef2SBarry Smith PetscFunctionReturn(0); 2958d763cef2SBarry Smith } 2959d763cef2SBarry Smith 29604a2ae208SSatish Balay #undef __FUNCT__ 29614a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix" 2962d763cef2SBarry Smith /*@C 2963d763cef2SBarry Smith TSGetOptionsPrefix - Sets the prefix used for searching for all 2964d763cef2SBarry Smith TS options in the database. 2965d763cef2SBarry Smith 2966d763cef2SBarry Smith Not Collective 2967d763cef2SBarry Smith 2968d763cef2SBarry Smith Input Parameter: 2969d763cef2SBarry Smith . ts - The TS context 2970d763cef2SBarry Smith 2971d763cef2SBarry Smith Output Parameter: 2972d763cef2SBarry Smith . prefix - A pointer to the prefix string used 2973d763cef2SBarry Smith 2974d763cef2SBarry Smith Notes: On the fortran side, the user should pass in a string 'prifix' of 2975d763cef2SBarry Smith sufficient length to hold the prefix. 2976d763cef2SBarry Smith 2977d763cef2SBarry Smith Level: intermediate 2978d763cef2SBarry Smith 2979d763cef2SBarry Smith .keywords: TS, get, options, prefix, database 2980d763cef2SBarry Smith 2981d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix() 2982d763cef2SBarry Smith @*/ 29837087cfbeSBarry Smith PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[]) 2984d763cef2SBarry Smith { 2985dfbe8321SBarry Smith PetscErrorCode ierr; 2986d763cef2SBarry Smith 2987d763cef2SBarry Smith PetscFunctionBegin; 29880700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 29894482741eSBarry Smith PetscValidPointer(prefix,2); 2990d763cef2SBarry Smith ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 2991d763cef2SBarry Smith PetscFunctionReturn(0); 2992d763cef2SBarry Smith } 2993d763cef2SBarry Smith 29944a2ae208SSatish Balay #undef __FUNCT__ 29954a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian" 2996d763cef2SBarry Smith /*@C 2997d763cef2SBarry Smith TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 2998d763cef2SBarry Smith 2999d763cef2SBarry Smith Not Collective, but parallel objects are returned if TS is parallel 3000d763cef2SBarry Smith 3001d763cef2SBarry Smith Input Parameter: 3002d763cef2SBarry Smith . ts - The TS context obtained from TSCreate() 3003d763cef2SBarry Smith 3004d763cef2SBarry Smith Output Parameters: 3005e4357dc4SBarry Smith + Amat - The (approximate) Jacobian J of G, where U_t = G(U,t) (or NULL) 3006e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat (or NULL) 3007e4357dc4SBarry Smith . func - Function to compute the Jacobian of the RHS (or NULL) 3008e4357dc4SBarry Smith - ctx - User-defined context for Jacobian evaluation routine (or NULL) 3009d763cef2SBarry Smith 30100298fd71SBarry Smith Notes: You can pass in NULL for any return argument you do not need. 3011d763cef2SBarry Smith 3012d763cef2SBarry Smith Level: intermediate 3013d763cef2SBarry Smith 301426d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 3015d763cef2SBarry Smith 3016d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian 3017d763cef2SBarry Smith @*/ 3018e4357dc4SBarry Smith PetscErrorCode TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx) 3019d763cef2SBarry Smith { 3020089b2837SJed Brown PetscErrorCode ierr; 3021089b2837SJed Brown SNES snes; 302224989b8cSPeter Brune DM dm; 3023089b2837SJed Brown 3024d763cef2SBarry Smith PetscFunctionBegin; 3025089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3026e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 302724989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 302824989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr); 3029d763cef2SBarry Smith PetscFunctionReturn(0); 3030d763cef2SBarry Smith } 3031d763cef2SBarry Smith 30321713a123SBarry Smith #undef __FUNCT__ 30332eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian" 30342eca1d9cSJed Brown /*@C 30352eca1d9cSJed Brown TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 30362eca1d9cSJed Brown 30372eca1d9cSJed Brown Not Collective, but parallel objects are returned if TS is parallel 30382eca1d9cSJed Brown 30392eca1d9cSJed Brown Input Parameter: 30402eca1d9cSJed Brown . ts - The TS context obtained from TSCreate() 30412eca1d9cSJed Brown 30422eca1d9cSJed Brown Output Parameters: 3043e4357dc4SBarry Smith + Amat - The (approximate) Jacobian of F(t,U,U_t) 3044e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, often the same as Amat 30452eca1d9cSJed Brown . f - The function to compute the matrices 30462eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine 30472eca1d9cSJed Brown 30480298fd71SBarry Smith Notes: You can pass in NULL for any return argument you do not need. 30492eca1d9cSJed Brown 30502eca1d9cSJed Brown Level: advanced 30512eca1d9cSJed Brown 30522eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 30532eca1d9cSJed Brown 30542eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian 30552eca1d9cSJed Brown @*/ 3056e4357dc4SBarry Smith PetscErrorCode TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx) 30572eca1d9cSJed Brown { 3058089b2837SJed Brown PetscErrorCode ierr; 3059089b2837SJed Brown SNES snes; 306024989b8cSPeter Brune DM dm; 30610910c330SBarry Smith 30622eca1d9cSJed Brown PetscFunctionBegin; 3063089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3064f7d39f7aSBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 3065e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 306624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 306724989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr); 30682eca1d9cSJed Brown PetscFunctionReturn(0); 30692eca1d9cSJed Brown } 30702eca1d9cSJed Brown 30716083293cSBarry Smith 30722eca1d9cSJed Brown #undef __FUNCT__ 307383a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution" 30741713a123SBarry Smith /*@C 307583a4ac43SBarry Smith TSMonitorDrawSolution - Monitors progress of the TS solvers by calling 30761713a123SBarry Smith VecView() for the solution at each timestep 30771713a123SBarry Smith 30781713a123SBarry Smith Collective on TS 30791713a123SBarry Smith 30801713a123SBarry Smith Input Parameters: 30811713a123SBarry Smith + ts - the TS context 30821713a123SBarry Smith . step - current time-step 3083142b95e3SSatish Balay . ptime - current time 30840298fd71SBarry Smith - dummy - either a viewer or NULL 30851713a123SBarry Smith 308699fdda47SBarry Smith Options Database: 308799fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 308899fdda47SBarry Smith 308999fdda47SBarry Smith Notes: the initial solution and current solution are not displayed with a common axis scaling so generally the option -ts_monitor_draw_solution_initial 309099fdda47SBarry Smith will look bad 309199fdda47SBarry Smith 30921713a123SBarry Smith Level: intermediate 30931713a123SBarry Smith 30941713a123SBarry Smith .keywords: TS, vector, monitor, view 30951713a123SBarry Smith 3096a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 30971713a123SBarry Smith @*/ 30980910c330SBarry Smith PetscErrorCode TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 30991713a123SBarry Smith { 3100dfbe8321SBarry Smith PetscErrorCode ierr; 310183a4ac43SBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 3102473a3ab2SBarry Smith PetscDraw draw; 31031713a123SBarry Smith 31041713a123SBarry Smith PetscFunctionBegin; 31056083293cSBarry Smith if (!step && ictx->showinitial) { 31066083293cSBarry Smith if (!ictx->initialsolution) { 31070910c330SBarry Smith ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr); 31081713a123SBarry Smith } 31090910c330SBarry Smith ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr); 31106083293cSBarry Smith } 3111b06615a5SLisandro Dalcin if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 31120dcf80beSBarry Smith 31136083293cSBarry Smith if (ictx->showinitial) { 31146083293cSBarry Smith PetscReal pause; 31156083293cSBarry Smith ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr); 31166083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr); 31176083293cSBarry Smith ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr); 31186083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr); 31196083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr); 31206083293cSBarry Smith } 31210910c330SBarry Smith ierr = VecView(u,ictx->viewer);CHKERRQ(ierr); 3122473a3ab2SBarry Smith if (ictx->showtimestepandtime) { 3123473a3ab2SBarry Smith PetscReal xl,yl,xr,yr,tw,w,h; 3124473a3ab2SBarry Smith char time[32]; 3125473a3ab2SBarry Smith size_t len; 3126473a3ab2SBarry Smith 3127473a3ab2SBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 3128473a3ab2SBarry Smith ierr = PetscSNPrintf(time,32,"Timestep %d Time %f",(int)step,(double)ptime);CHKERRQ(ierr); 3129473a3ab2SBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 3130473a3ab2SBarry Smith ierr = PetscStrlen(time,&len);CHKERRQ(ierr); 31310298fd71SBarry Smith ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr); 3132473a3ab2SBarry Smith w = xl + .5*(xr - xl) - .5*len*tw; 3133473a3ab2SBarry Smith h = yl + .95*(yr - yl); 3134473a3ab2SBarry Smith ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 3135473a3ab2SBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 3136473a3ab2SBarry Smith } 3137473a3ab2SBarry Smith 31386083293cSBarry Smith if (ictx->showinitial) { 31396083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr); 31406083293cSBarry Smith } 31411713a123SBarry Smith PetscFunctionReturn(0); 31421713a123SBarry Smith } 31431713a123SBarry Smith 31442d5ee99bSBarry Smith #undef __FUNCT__ 31452d5ee99bSBarry Smith #define __FUNCT__ "TSMonitorDrawSolutionPhase" 31462d5ee99bSBarry Smith /*@C 31472d5ee99bSBarry Smith TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram 31482d5ee99bSBarry Smith 31492d5ee99bSBarry Smith Collective on TS 31502d5ee99bSBarry Smith 31512d5ee99bSBarry Smith Input Parameters: 31522d5ee99bSBarry Smith + ts - the TS context 31532d5ee99bSBarry Smith . step - current time-step 31542d5ee99bSBarry Smith . ptime - current time 31552d5ee99bSBarry Smith - dummy - either a viewer or NULL 31562d5ee99bSBarry Smith 31572d5ee99bSBarry Smith Level: intermediate 31582d5ee99bSBarry Smith 31592d5ee99bSBarry Smith .keywords: TS, vector, monitor, view 31602d5ee99bSBarry Smith 31612d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 31622d5ee99bSBarry Smith @*/ 31632d5ee99bSBarry Smith PetscErrorCode TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 31642d5ee99bSBarry Smith { 31652d5ee99bSBarry Smith PetscErrorCode ierr; 31662d5ee99bSBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 31672d5ee99bSBarry Smith PetscDraw draw; 31682d5ee99bSBarry Smith MPI_Comm comm; 31692d5ee99bSBarry Smith PetscInt n; 31702d5ee99bSBarry Smith PetscMPIInt size; 31712d5ee99bSBarry Smith PetscReal xl,yl,xr,yr,tw,w,h; 31722d5ee99bSBarry Smith char time[32]; 31732d5ee99bSBarry Smith size_t len; 31742d5ee99bSBarry Smith const PetscScalar *U; 31752d5ee99bSBarry Smith 31762d5ee99bSBarry Smith PetscFunctionBegin; 31772d5ee99bSBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 31782d5ee99bSBarry Smith ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr); 31792d5ee99bSBarry Smith if (size != 1) SETERRQ(comm,PETSC_ERR_SUP,"Only allowed for sequential runs"); 31802d5ee99bSBarry Smith ierr = VecGetSize(u,&n);CHKERRQ(ierr); 31812d5ee99bSBarry Smith if (n != 2) SETERRQ(comm,PETSC_ERR_SUP,"Only for ODEs with two unknowns"); 31822d5ee99bSBarry Smith 31832d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 31842d5ee99bSBarry Smith 31852d5ee99bSBarry Smith ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr); 31864b363babSBarry Smith ierr = PetscDrawAxisGetLimits(ictx->axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr); 3187ba5783adSMatthew G Knepley if ((PetscRealPart(U[0]) < xl) || (PetscRealPart(U[1]) < yl) || (PetscRealPart(U[0]) > xr) || (PetscRealPart(U[1]) > yr)) { 3188a4494fc1SBarry Smith ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 3189a4494fc1SBarry Smith PetscFunctionReturn(0); 3190a4494fc1SBarry Smith } 31912d5ee99bSBarry Smith if (!step) ictx->color++; 31922d5ee99bSBarry Smith ierr = PetscDrawPoint(draw,PetscRealPart(U[0]),PetscRealPart(U[1]),ictx->color);CHKERRQ(ierr); 31932d5ee99bSBarry Smith ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 31942d5ee99bSBarry Smith 31952d5ee99bSBarry Smith if (ictx->showtimestepandtime) { 31964b363babSBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 31972d5ee99bSBarry Smith ierr = PetscSNPrintf(time,32,"Timestep %d Time %f",(int)step,(double)ptime);CHKERRQ(ierr); 31982d5ee99bSBarry Smith ierr = PetscStrlen(time,&len);CHKERRQ(ierr); 31992d5ee99bSBarry Smith ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr); 32002d5ee99bSBarry Smith w = xl + .5*(xr - xl) - .5*len*tw; 32012d5ee99bSBarry Smith h = yl + .95*(yr - yl); 32022d5ee99bSBarry Smith ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 32032d5ee99bSBarry Smith } 32042d5ee99bSBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 32052d5ee99bSBarry Smith PetscFunctionReturn(0); 32062d5ee99bSBarry Smith } 32072d5ee99bSBarry Smith 32081713a123SBarry Smith 32096c699258SBarry Smith #undef __FUNCT__ 321083a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy" 32116083293cSBarry Smith /*@C 321283a4ac43SBarry Smith TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution() 32136083293cSBarry Smith 32146083293cSBarry Smith Collective on TS 32156083293cSBarry Smith 32166083293cSBarry Smith Input Parameters: 32176083293cSBarry Smith . ctx - the monitor context 32186083293cSBarry Smith 32196083293cSBarry Smith Level: intermediate 32206083293cSBarry Smith 32216083293cSBarry Smith .keywords: TS, vector, monitor, view 32226083293cSBarry Smith 322383a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError() 32246083293cSBarry Smith @*/ 322583a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx) 32266083293cSBarry Smith { 32276083293cSBarry Smith PetscErrorCode ierr; 32286083293cSBarry Smith 32296083293cSBarry Smith PetscFunctionBegin; 32304b363babSBarry Smith ierr = PetscDrawAxisDestroy(&(*ictx)->axis);CHKERRQ(ierr); 323183a4ac43SBarry Smith ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr); 323283a4ac43SBarry Smith ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr); 323383a4ac43SBarry Smith ierr = PetscFree(*ictx);CHKERRQ(ierr); 32346083293cSBarry Smith PetscFunctionReturn(0); 32356083293cSBarry Smith } 32366083293cSBarry Smith 32376083293cSBarry Smith #undef __FUNCT__ 323883a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate" 32396083293cSBarry Smith /*@C 324083a4ac43SBarry Smith TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx 32416083293cSBarry Smith 32426083293cSBarry Smith Collective on TS 32436083293cSBarry Smith 32446083293cSBarry Smith Input Parameter: 32456083293cSBarry Smith . ts - time-step context 32466083293cSBarry Smith 32476083293cSBarry Smith Output Patameter: 32486083293cSBarry Smith . ctx - the monitor context 32496083293cSBarry Smith 325099fdda47SBarry Smith Options Database: 325199fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 325299fdda47SBarry Smith 32536083293cSBarry Smith Level: intermediate 32546083293cSBarry Smith 32556083293cSBarry Smith .keywords: TS, vector, monitor, view 32566083293cSBarry Smith 325783a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx() 32586083293cSBarry Smith @*/ 325983a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx) 32606083293cSBarry Smith { 32616083293cSBarry Smith PetscErrorCode ierr; 32626083293cSBarry Smith 32636083293cSBarry Smith PetscFunctionBegin; 326483a4ac43SBarry Smith ierr = PetscNew(struct _n_TSMonitorDrawCtx,ctx);CHKERRQ(ierr); 326583a4ac43SBarry Smith ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr); 3266e9457bf7SBarry Smith ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr); 3267bbd56ea5SKarl Rupp 326883a4ac43SBarry Smith (*ctx)->howoften = howoften; 3269473a3ab2SBarry Smith (*ctx)->showinitial = PETSC_FALSE; 32700298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr); 3271473a3ab2SBarry Smith 3272473a3ab2SBarry Smith (*ctx)->showtimestepandtime = PETSC_FALSE; 32730298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr); 32742d5ee99bSBarry Smith (*ctx)->color = PETSC_DRAW_WHITE; 32756083293cSBarry Smith PetscFunctionReturn(0); 32766083293cSBarry Smith } 32776083293cSBarry Smith 32786083293cSBarry Smith #undef __FUNCT__ 327983a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError" 32803a471f94SBarry Smith /*@C 328183a4ac43SBarry Smith TSMonitorDrawError - Monitors progress of the TS solvers by calling 32823a471f94SBarry Smith VecView() for the error at each timestep 32833a471f94SBarry Smith 32843a471f94SBarry Smith Collective on TS 32853a471f94SBarry Smith 32863a471f94SBarry Smith Input Parameters: 32873a471f94SBarry Smith + ts - the TS context 32883a471f94SBarry Smith . step - current time-step 32893a471f94SBarry Smith . ptime - current time 32900298fd71SBarry Smith - dummy - either a viewer or NULL 32913a471f94SBarry Smith 32923a471f94SBarry Smith Level: intermediate 32933a471f94SBarry Smith 32943a471f94SBarry Smith .keywords: TS, vector, monitor, view 32953a471f94SBarry Smith 32963a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 32973a471f94SBarry Smith @*/ 32980910c330SBarry Smith PetscErrorCode TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 32993a471f94SBarry Smith { 33003a471f94SBarry Smith PetscErrorCode ierr; 330183a4ac43SBarry Smith TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy; 330283a4ac43SBarry Smith PetscViewer viewer = ctx->viewer; 33033a471f94SBarry Smith Vec work; 33043a471f94SBarry Smith 33053a471f94SBarry Smith PetscFunctionBegin; 3306b06615a5SLisandro Dalcin if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 33070910c330SBarry Smith ierr = VecDuplicate(u,&work);CHKERRQ(ierr); 33083a471f94SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr); 33090910c330SBarry Smith ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr); 33103a471f94SBarry Smith ierr = VecView(work,viewer);CHKERRQ(ierr); 33113a471f94SBarry Smith ierr = VecDestroy(&work);CHKERRQ(ierr); 33123a471f94SBarry Smith PetscFunctionReturn(0); 33133a471f94SBarry Smith } 33143a471f94SBarry Smith 33152a34c10cSBarry Smith #include <petsc-private/dmimpl.h> 33163a471f94SBarry Smith #undef __FUNCT__ 33176c699258SBarry Smith #define __FUNCT__ "TSSetDM" 33186c699258SBarry Smith /*@ 33196c699258SBarry Smith TSSetDM - Sets the DM that may be used by some preconditioners 33206c699258SBarry Smith 33213f9fe445SBarry Smith Logically Collective on TS and DM 33226c699258SBarry Smith 33236c699258SBarry Smith Input Parameters: 33246c699258SBarry Smith + ts - the preconditioner context 33256c699258SBarry Smith - dm - the dm 33266c699258SBarry Smith 33276c699258SBarry Smith Level: intermediate 33286c699258SBarry Smith 33296c699258SBarry Smith 33306c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM() 33316c699258SBarry Smith @*/ 33327087cfbeSBarry Smith PetscErrorCode TSSetDM(TS ts,DM dm) 33336c699258SBarry Smith { 33346c699258SBarry Smith PetscErrorCode ierr; 3335089b2837SJed Brown SNES snes; 3336942e3340SBarry Smith DMTS tsdm; 33376c699258SBarry Smith 33386c699258SBarry Smith PetscFunctionBegin; 33390700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 334070663e4aSLisandro Dalcin ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr); 3341942e3340SBarry Smith if (ts->dm) { /* Move the DMTS context over to the new DM unless the new DM already has one */ 33422a34c10cSBarry Smith if (ts->dm->dmts && !dm->dmts) { 3343942e3340SBarry Smith ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr); 3344942e3340SBarry Smith ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr); 334524989b8cSPeter Brune if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */ 334624989b8cSPeter Brune tsdm->originaldm = dm; 334724989b8cSPeter Brune } 334824989b8cSPeter Brune } 33496bf464f9SBarry Smith ierr = DMDestroy(&ts->dm);CHKERRQ(ierr); 335024989b8cSPeter Brune } 33516c699258SBarry Smith ts->dm = dm; 3352bbd56ea5SKarl Rupp 3353089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3354089b2837SJed Brown ierr = SNESSetDM(snes,dm);CHKERRQ(ierr); 33556c699258SBarry Smith PetscFunctionReturn(0); 33566c699258SBarry Smith } 33576c699258SBarry Smith 33586c699258SBarry Smith #undef __FUNCT__ 33596c699258SBarry Smith #define __FUNCT__ "TSGetDM" 33606c699258SBarry Smith /*@ 33616c699258SBarry Smith TSGetDM - Gets the DM that may be used by some preconditioners 33626c699258SBarry Smith 33633f9fe445SBarry Smith Not Collective 33646c699258SBarry Smith 33656c699258SBarry Smith Input Parameter: 33666c699258SBarry Smith . ts - the preconditioner context 33676c699258SBarry Smith 33686c699258SBarry Smith Output Parameter: 33696c699258SBarry Smith . dm - the dm 33706c699258SBarry Smith 33716c699258SBarry Smith Level: intermediate 33726c699258SBarry Smith 33736c699258SBarry Smith 33746c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM() 33756c699258SBarry Smith @*/ 33767087cfbeSBarry Smith PetscErrorCode TSGetDM(TS ts,DM *dm) 33776c699258SBarry Smith { 3378496e6a7aSJed Brown PetscErrorCode ierr; 3379496e6a7aSJed Brown 33806c699258SBarry Smith PetscFunctionBegin; 33810700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3382496e6a7aSJed Brown if (!ts->dm) { 3383ce94432eSBarry Smith ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr); 3384496e6a7aSJed Brown if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 3385496e6a7aSJed Brown } 33866c699258SBarry Smith *dm = ts->dm; 33876c699258SBarry Smith PetscFunctionReturn(0); 33886c699258SBarry Smith } 33891713a123SBarry Smith 33900f5c6efeSJed Brown #undef __FUNCT__ 33910f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction" 33920f5c6efeSJed Brown /*@ 33930f5c6efeSJed Brown SNESTSFormFunction - Function to evaluate nonlinear residual 33940f5c6efeSJed Brown 33953f9fe445SBarry Smith Logically Collective on SNES 33960f5c6efeSJed Brown 33970f5c6efeSJed Brown Input Parameter: 3398d42a1c89SJed Brown + snes - nonlinear solver 33990910c330SBarry Smith . U - the current state at which to evaluate the residual 3400d42a1c89SJed Brown - ctx - user context, must be a TS 34010f5c6efeSJed Brown 34020f5c6efeSJed Brown Output Parameter: 34030f5c6efeSJed Brown . F - the nonlinear residual 34040f5c6efeSJed Brown 34050f5c6efeSJed Brown Notes: 34060f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 34070f5c6efeSJed Brown It is most frequently passed to MatFDColoringSetFunction(). 34080f5c6efeSJed Brown 34090f5c6efeSJed Brown Level: advanced 34100f5c6efeSJed Brown 34110f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction() 34120f5c6efeSJed Brown @*/ 34130910c330SBarry Smith PetscErrorCode SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx) 34140f5c6efeSJed Brown { 34150f5c6efeSJed Brown TS ts = (TS)ctx; 34160f5c6efeSJed Brown PetscErrorCode ierr; 34170f5c6efeSJed Brown 34180f5c6efeSJed Brown PetscFunctionBegin; 34190f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 34200910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 34210f5c6efeSJed Brown PetscValidHeaderSpecific(F,VEC_CLASSID,3); 34220f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,4); 34230910c330SBarry Smith ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr); 34240f5c6efeSJed Brown PetscFunctionReturn(0); 34250f5c6efeSJed Brown } 34260f5c6efeSJed Brown 34270f5c6efeSJed Brown #undef __FUNCT__ 34280f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian" 34290f5c6efeSJed Brown /*@ 34300f5c6efeSJed Brown SNESTSFormJacobian - Function to evaluate the Jacobian 34310f5c6efeSJed Brown 34320f5c6efeSJed Brown Collective on SNES 34330f5c6efeSJed Brown 34340f5c6efeSJed Brown Input Parameter: 34350f5c6efeSJed Brown + snes - nonlinear solver 34360910c330SBarry Smith . U - the current state at which to evaluate the residual 34370f5c6efeSJed Brown - ctx - user context, must be a TS 34380f5c6efeSJed Brown 34390f5c6efeSJed Brown Output Parameter: 34400f5c6efeSJed Brown + A - the Jacobian 34410f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A) 34420f5c6efeSJed Brown - flag - indicates any structure change in the matrix 34430f5c6efeSJed Brown 34440f5c6efeSJed Brown Notes: 34450f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 34460f5c6efeSJed Brown 34470f5c6efeSJed Brown Level: developer 34480f5c6efeSJed Brown 34490f5c6efeSJed Brown .seealso: SNESSetJacobian() 34500f5c6efeSJed Brown @*/ 34510910c330SBarry Smith PetscErrorCode SNESTSFormJacobian(SNES snes,Vec U,Mat *A,Mat *B,MatStructure *flag,void *ctx) 34520f5c6efeSJed Brown { 34530f5c6efeSJed Brown TS ts = (TS)ctx; 34540f5c6efeSJed Brown PetscErrorCode ierr; 34550f5c6efeSJed Brown 34560f5c6efeSJed Brown PetscFunctionBegin; 34570f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 34580910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 34590f5c6efeSJed Brown PetscValidPointer(A,3); 34600f5c6efeSJed Brown PetscValidHeaderSpecific(*A,MAT_CLASSID,3); 34610f5c6efeSJed Brown PetscValidPointer(B,4); 34620f5c6efeSJed Brown PetscValidHeaderSpecific(*B,MAT_CLASSID,4); 34630f5c6efeSJed Brown PetscValidPointer(flag,5); 34640f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,6); 34650910c330SBarry Smith ierr = (ts->ops->snesjacobian)(snes,U,A,B,flag,ts);CHKERRQ(ierr); 34660f5c6efeSJed Brown PetscFunctionReturn(0); 34670f5c6efeSJed Brown } 3468325fc9f4SBarry Smith 34690e4ef248SJed Brown #undef __FUNCT__ 34700e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear" 34710e4ef248SJed Brown /*@C 34720e4ef248SJed Brown TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only 34730e4ef248SJed Brown 34740e4ef248SJed Brown Collective on TS 34750e4ef248SJed Brown 34760e4ef248SJed Brown Input Arguments: 34770e4ef248SJed Brown + ts - time stepping context 34780e4ef248SJed Brown . t - time at which to evaluate 34790910c330SBarry Smith . U - state at which to evaluate 34800e4ef248SJed Brown - ctx - context 34810e4ef248SJed Brown 34820e4ef248SJed Brown Output Arguments: 34830e4ef248SJed Brown . F - right hand side 34840e4ef248SJed Brown 34850e4ef248SJed Brown Level: intermediate 34860e4ef248SJed Brown 34870e4ef248SJed Brown Notes: 34880e4ef248SJed Brown This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems. 34890e4ef248SJed Brown The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian(). 34900e4ef248SJed Brown 34910e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 34920e4ef248SJed Brown @*/ 34930910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx) 34940e4ef248SJed Brown { 34950e4ef248SJed Brown PetscErrorCode ierr; 34960e4ef248SJed Brown Mat Arhs,Brhs; 34970e4ef248SJed Brown MatStructure flg2; 34980e4ef248SJed Brown 34990e4ef248SJed Brown PetscFunctionBegin; 35000e4ef248SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 35010910c330SBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,&Arhs,&Brhs,&flg2);CHKERRQ(ierr); 35020910c330SBarry Smith ierr = MatMult(Arhs,U,F);CHKERRQ(ierr); 35030e4ef248SJed Brown PetscFunctionReturn(0); 35040e4ef248SJed Brown } 35050e4ef248SJed Brown 35060e4ef248SJed Brown #undef __FUNCT__ 35070e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant" 35080e4ef248SJed Brown /*@C 35090e4ef248SJed Brown TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 35100e4ef248SJed Brown 35110e4ef248SJed Brown Collective on TS 35120e4ef248SJed Brown 35130e4ef248SJed Brown Input Arguments: 35140e4ef248SJed Brown + ts - time stepping context 35150e4ef248SJed Brown . t - time at which to evaluate 35160910c330SBarry Smith . U - state at which to evaluate 35170e4ef248SJed Brown - ctx - context 35180e4ef248SJed Brown 35190e4ef248SJed Brown Output Arguments: 35200e4ef248SJed Brown + A - pointer to operator 35210e4ef248SJed Brown . B - pointer to preconditioning matrix 35220e4ef248SJed Brown - flg - matrix structure flag 35230e4ef248SJed Brown 35240e4ef248SJed Brown Level: intermediate 35250e4ef248SJed Brown 35260e4ef248SJed Brown Notes: 35270e4ef248SJed Brown This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems. 35280e4ef248SJed Brown 35290e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear() 35300e4ef248SJed Brown @*/ 35310910c330SBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat *A,Mat *B,MatStructure *flg,void *ctx) 35320e4ef248SJed Brown { 35330e4ef248SJed Brown PetscFunctionBegin; 35340e4ef248SJed Brown *flg = SAME_PRECONDITIONER; 35350e4ef248SJed Brown PetscFunctionReturn(0); 35360e4ef248SJed Brown } 35370e4ef248SJed Brown 35380026cea9SSean Farley #undef __FUNCT__ 35390026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear" 35400026cea9SSean Farley /*@C 35410026cea9SSean Farley TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 35420026cea9SSean Farley 35430026cea9SSean Farley Collective on TS 35440026cea9SSean Farley 35450026cea9SSean Farley Input Arguments: 35460026cea9SSean Farley + ts - time stepping context 35470026cea9SSean Farley . t - time at which to evaluate 35480910c330SBarry Smith . U - state at which to evaluate 35490910c330SBarry Smith . Udot - time derivative of state vector 35500026cea9SSean Farley - ctx - context 35510026cea9SSean Farley 35520026cea9SSean Farley Output Arguments: 35530026cea9SSean Farley . F - left hand side 35540026cea9SSean Farley 35550026cea9SSean Farley Level: intermediate 35560026cea9SSean Farley 35570026cea9SSean Farley Notes: 35580910c330SBarry Smith The assumption here is that the left hand side is of the form A*Udot (and not A*Udot + B*U). For other cases, the 35590026cea9SSean Farley user is required to write their own TSComputeIFunction. 35600026cea9SSean Farley This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems. 35610026cea9SSean Farley The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian(). 35620026cea9SSean Farley 35630026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant() 35640026cea9SSean Farley @*/ 35650910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx) 35660026cea9SSean Farley { 35670026cea9SSean Farley PetscErrorCode ierr; 35680026cea9SSean Farley Mat A,B; 35690026cea9SSean Farley MatStructure flg2; 35700026cea9SSean Farley 35710026cea9SSean Farley PetscFunctionBegin; 35720298fd71SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 35730910c330SBarry Smith ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,&A,&B,&flg2,PETSC_TRUE);CHKERRQ(ierr); 35740910c330SBarry Smith ierr = MatMult(A,Udot,F);CHKERRQ(ierr); 35750026cea9SSean Farley PetscFunctionReturn(0); 35760026cea9SSean Farley } 35770026cea9SSean Farley 35780026cea9SSean Farley #undef __FUNCT__ 35790026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant" 35800026cea9SSean Farley /*@C 3581b41af12eSJed Brown TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE 35820026cea9SSean Farley 35830026cea9SSean Farley Collective on TS 35840026cea9SSean Farley 35850026cea9SSean Farley Input Arguments: 35860026cea9SSean Farley + ts - time stepping context 35870026cea9SSean Farley . t - time at which to evaluate 35880910c330SBarry Smith . U - state at which to evaluate 35890910c330SBarry Smith . Udot - time derivative of state vector 35900026cea9SSean Farley . shift - shift to apply 35910026cea9SSean Farley - ctx - context 35920026cea9SSean Farley 35930026cea9SSean Farley Output Arguments: 35940026cea9SSean Farley + A - pointer to operator 35950026cea9SSean Farley . B - pointer to preconditioning matrix 35960026cea9SSean Farley - flg - matrix structure flag 35970026cea9SSean Farley 3598b41af12eSJed Brown Level: advanced 35990026cea9SSean Farley 36000026cea9SSean Farley Notes: 36010026cea9SSean Farley This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems. 36020026cea9SSean Farley 3603b41af12eSJed Brown It is only appropriate for problems of the form 3604b41af12eSJed Brown 3605b41af12eSJed Brown $ M Udot = F(U,t) 3606b41af12eSJed Brown 3607b41af12eSJed Brown where M is constant and F is non-stiff. The user must pass M to TSSetIJacobian(). The current implementation only 3608b41af12eSJed Brown works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing 3609b41af12eSJed Brown an implicit operator of the form 3610b41af12eSJed Brown 3611b41af12eSJed Brown $ shift*M + J 3612b41af12eSJed Brown 3613b41af12eSJed Brown where J is the Jacobian of -F(U). Support may be added in a future version of PETSc, but for now, the user must store 3614b41af12eSJed Brown a copy of M or reassemble it when requested. 3615b41af12eSJed Brown 36160026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear() 36170026cea9SSean Farley @*/ 36180910c330SBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat *A,Mat *B,MatStructure *flg,void *ctx) 36190026cea9SSean Farley { 3620b41af12eSJed Brown PetscErrorCode ierr; 3621b41af12eSJed Brown 36220026cea9SSean Farley PetscFunctionBegin; 3623b41af12eSJed Brown ierr = MatScale(*A, shift / ts->ijacobian.shift);CHKERRQ(ierr); 3624b41af12eSJed Brown ts->ijacobian.shift = shift; 36250026cea9SSean Farley *flg = SAME_PRECONDITIONER; 36260026cea9SSean Farley PetscFunctionReturn(0); 36270026cea9SSean Farley } 3628b41af12eSJed Brown 3629e817cc15SEmil Constantinescu #undef __FUNCT__ 3630e817cc15SEmil Constantinescu #define __FUNCT__ "TSGetEquationType" 3631e817cc15SEmil Constantinescu /*@ 3632e817cc15SEmil Constantinescu TSGetEquationType - Gets the type of the equation that TS is solving. 3633e817cc15SEmil Constantinescu 3634e817cc15SEmil Constantinescu Not Collective 3635e817cc15SEmil Constantinescu 3636e817cc15SEmil Constantinescu Input Parameter: 3637e817cc15SEmil Constantinescu . ts - the TS context 3638e817cc15SEmil Constantinescu 3639e817cc15SEmil Constantinescu Output Parameter: 36404e6b9ce4SEmil Constantinescu . equation_type - see TSEquationType 3641e817cc15SEmil Constantinescu 3642e817cc15SEmil Constantinescu Level: beginner 3643e817cc15SEmil Constantinescu 3644e817cc15SEmil Constantinescu .keywords: TS, equation type 3645e817cc15SEmil Constantinescu 3646e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType 3647e817cc15SEmil Constantinescu @*/ 3648e817cc15SEmil Constantinescu PetscErrorCode TSGetEquationType(TS ts,TSEquationType *equation_type) 3649e817cc15SEmil Constantinescu { 3650e817cc15SEmil Constantinescu PetscFunctionBegin; 3651e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3652e817cc15SEmil Constantinescu PetscValidPointer(equation_type,2); 3653e817cc15SEmil Constantinescu *equation_type = ts->equation_type; 3654e817cc15SEmil Constantinescu PetscFunctionReturn(0); 3655e817cc15SEmil Constantinescu } 3656e817cc15SEmil Constantinescu 3657e817cc15SEmil Constantinescu #undef __FUNCT__ 3658e817cc15SEmil Constantinescu #define __FUNCT__ "TSSetEquationType" 3659e817cc15SEmil Constantinescu /*@ 3660e817cc15SEmil Constantinescu TSSetEquationType - Sets the type of the equation that TS is solving. 3661e817cc15SEmil Constantinescu 3662e817cc15SEmil Constantinescu Not Collective 3663e817cc15SEmil Constantinescu 3664e817cc15SEmil Constantinescu Input Parameter: 3665e817cc15SEmil Constantinescu + ts - the TS context 36664e6b9ce4SEmil Constantinescu . equation_type - see TSEquationType 3667e817cc15SEmil Constantinescu 3668e817cc15SEmil Constantinescu Level: advanced 3669e817cc15SEmil Constantinescu 3670e817cc15SEmil Constantinescu .keywords: TS, equation type 3671e817cc15SEmil Constantinescu 3672e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType 3673e817cc15SEmil Constantinescu @*/ 3674e817cc15SEmil Constantinescu PetscErrorCode TSSetEquationType(TS ts,TSEquationType equation_type) 3675e817cc15SEmil Constantinescu { 3676e817cc15SEmil Constantinescu PetscFunctionBegin; 3677e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3678e817cc15SEmil Constantinescu ts->equation_type = equation_type; 3679e817cc15SEmil Constantinescu PetscFunctionReturn(0); 3680e817cc15SEmil Constantinescu } 36810026cea9SSean Farley 36824af1b03aSJed Brown #undef __FUNCT__ 36834af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason" 36844af1b03aSJed Brown /*@ 36854af1b03aSJed Brown TSGetConvergedReason - Gets the reason the TS iteration was stopped. 36864af1b03aSJed Brown 36874af1b03aSJed Brown Not Collective 36884af1b03aSJed Brown 36894af1b03aSJed Brown Input Parameter: 36904af1b03aSJed Brown . ts - the TS context 36914af1b03aSJed Brown 36924af1b03aSJed Brown Output Parameter: 36934af1b03aSJed Brown . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 36944af1b03aSJed Brown manual pages for the individual convergence tests for complete lists 36954af1b03aSJed Brown 3696487e0bb9SJed Brown Level: beginner 36974af1b03aSJed Brown 3698cd652676SJed Brown Notes: 3699cd652676SJed Brown Can only be called after the call to TSSolve() is complete. 37004af1b03aSJed Brown 37014af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test 37024af1b03aSJed Brown 37034af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason 37044af1b03aSJed Brown @*/ 37054af1b03aSJed Brown PetscErrorCode TSGetConvergedReason(TS ts,TSConvergedReason *reason) 37064af1b03aSJed Brown { 37074af1b03aSJed Brown PetscFunctionBegin; 37084af1b03aSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 37094af1b03aSJed Brown PetscValidPointer(reason,2); 37104af1b03aSJed Brown *reason = ts->reason; 37114af1b03aSJed Brown PetscFunctionReturn(0); 37124af1b03aSJed Brown } 37134af1b03aSJed Brown 3714fb1732b5SBarry Smith #undef __FUNCT__ 3715d6ad946cSShri Abhyankar #define __FUNCT__ "TSSetConvergedReason" 3716d6ad946cSShri Abhyankar /*@ 3717d6ad946cSShri Abhyankar TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve. 3718d6ad946cSShri Abhyankar 3719d6ad946cSShri Abhyankar Not Collective 3720d6ad946cSShri Abhyankar 3721d6ad946cSShri Abhyankar Input Parameter: 3722d6ad946cSShri Abhyankar + ts - the TS context 3723d6ad946cSShri Abhyankar . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 3724d6ad946cSShri Abhyankar manual pages for the individual convergence tests for complete lists 3725d6ad946cSShri Abhyankar 3726f5abba47SShri Abhyankar Level: advanced 3727d6ad946cSShri Abhyankar 3728d6ad946cSShri Abhyankar Notes: 3729d6ad946cSShri Abhyankar Can only be called during TSSolve() is active. 3730d6ad946cSShri Abhyankar 3731d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test 3732d6ad946cSShri Abhyankar 3733d6ad946cSShri Abhyankar .seealso: TSConvergedReason 3734d6ad946cSShri Abhyankar @*/ 3735d6ad946cSShri Abhyankar PetscErrorCode TSSetConvergedReason(TS ts,TSConvergedReason reason) 3736d6ad946cSShri Abhyankar { 3737d6ad946cSShri Abhyankar PetscFunctionBegin; 3738d6ad946cSShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3739d6ad946cSShri Abhyankar ts->reason = reason; 3740d6ad946cSShri Abhyankar PetscFunctionReturn(0); 3741d6ad946cSShri Abhyankar } 3742d6ad946cSShri Abhyankar 3743d6ad946cSShri Abhyankar #undef __FUNCT__ 3744cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime" 3745cc708dedSBarry Smith /*@ 3746cc708dedSBarry Smith TSGetSolveTime - Gets the time after a call to TSSolve() 3747cc708dedSBarry Smith 3748cc708dedSBarry Smith Not Collective 3749cc708dedSBarry Smith 3750cc708dedSBarry Smith Input Parameter: 3751cc708dedSBarry Smith . ts - the TS context 3752cc708dedSBarry Smith 3753cc708dedSBarry Smith Output Parameter: 3754cc708dedSBarry Smith . ftime - the final time. This time should correspond to the final time set with TSSetDuration() 3755cc708dedSBarry Smith 3756487e0bb9SJed Brown Level: beginner 3757cc708dedSBarry Smith 3758cc708dedSBarry Smith Notes: 3759cc708dedSBarry Smith Can only be called after the call to TSSolve() is complete. 3760cc708dedSBarry Smith 3761cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test 3762cc708dedSBarry Smith 3763cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason 3764cc708dedSBarry Smith @*/ 3765cc708dedSBarry Smith PetscErrorCode TSGetSolveTime(TS ts,PetscReal *ftime) 3766cc708dedSBarry Smith { 3767cc708dedSBarry Smith PetscFunctionBegin; 3768cc708dedSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3769cc708dedSBarry Smith PetscValidPointer(ftime,2); 3770cc708dedSBarry Smith *ftime = ts->solvetime; 3771cc708dedSBarry Smith PetscFunctionReturn(0); 3772cc708dedSBarry Smith } 3773cc708dedSBarry Smith 3774cc708dedSBarry Smith #undef __FUNCT__ 37755ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations" 37769f67acb7SJed Brown /*@ 37775ef26d82SJed Brown TSGetSNESIterations - Gets the total number of nonlinear iterations 37789f67acb7SJed Brown used by the time integrator. 37799f67acb7SJed Brown 37809f67acb7SJed Brown Not Collective 37819f67acb7SJed Brown 37829f67acb7SJed Brown Input Parameter: 37839f67acb7SJed Brown . ts - TS context 37849f67acb7SJed Brown 37859f67acb7SJed Brown Output Parameter: 37869f67acb7SJed Brown . nits - number of nonlinear iterations 37879f67acb7SJed Brown 37889f67acb7SJed Brown Notes: 37899f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 37909f67acb7SJed Brown 37919f67acb7SJed Brown Level: intermediate 37929f67acb7SJed Brown 37939f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations 37949f67acb7SJed Brown 37955ef26d82SJed Brown .seealso: TSGetKSPIterations() 37969f67acb7SJed Brown @*/ 37975ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits) 37989f67acb7SJed Brown { 37999f67acb7SJed Brown PetscFunctionBegin; 38009f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 38019f67acb7SJed Brown PetscValidIntPointer(nits,2); 38025ef26d82SJed Brown *nits = ts->snes_its; 38039f67acb7SJed Brown PetscFunctionReturn(0); 38049f67acb7SJed Brown } 38059f67acb7SJed Brown 38069f67acb7SJed Brown #undef __FUNCT__ 38075ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations" 38089f67acb7SJed Brown /*@ 38095ef26d82SJed Brown TSGetKSPIterations - Gets the total number of linear iterations 38109f67acb7SJed Brown used by the time integrator. 38119f67acb7SJed Brown 38129f67acb7SJed Brown Not Collective 38139f67acb7SJed Brown 38149f67acb7SJed Brown Input Parameter: 38159f67acb7SJed Brown . ts - TS context 38169f67acb7SJed Brown 38179f67acb7SJed Brown Output Parameter: 38189f67acb7SJed Brown . lits - number of linear iterations 38199f67acb7SJed Brown 38209f67acb7SJed Brown Notes: 38219f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 38229f67acb7SJed Brown 38239f67acb7SJed Brown Level: intermediate 38249f67acb7SJed Brown 38259f67acb7SJed Brown .keywords: TS, get, number, linear, iterations 38269f67acb7SJed Brown 38275ef26d82SJed Brown .seealso: TSGetSNESIterations(), SNESGetKSPIterations() 38289f67acb7SJed Brown @*/ 38295ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits) 38309f67acb7SJed Brown { 38319f67acb7SJed Brown PetscFunctionBegin; 38329f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 38339f67acb7SJed Brown PetscValidIntPointer(lits,2); 38345ef26d82SJed Brown *lits = ts->ksp_its; 38359f67acb7SJed Brown PetscFunctionReturn(0); 38369f67acb7SJed Brown } 38379f67acb7SJed Brown 38389f67acb7SJed Brown #undef __FUNCT__ 3839cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections" 3840cef5090cSJed Brown /*@ 3841cef5090cSJed Brown TSGetStepRejections - Gets the total number of rejected steps. 3842cef5090cSJed Brown 3843cef5090cSJed Brown Not Collective 3844cef5090cSJed Brown 3845cef5090cSJed Brown Input Parameter: 3846cef5090cSJed Brown . ts - TS context 3847cef5090cSJed Brown 3848cef5090cSJed Brown Output Parameter: 3849cef5090cSJed Brown . rejects - number of steps rejected 3850cef5090cSJed Brown 3851cef5090cSJed Brown Notes: 3852cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 3853cef5090cSJed Brown 3854cef5090cSJed Brown Level: intermediate 3855cef5090cSJed Brown 3856cef5090cSJed Brown .keywords: TS, get, number 3857cef5090cSJed Brown 38585ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails() 3859cef5090cSJed Brown @*/ 3860cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects) 3861cef5090cSJed Brown { 3862cef5090cSJed Brown PetscFunctionBegin; 3863cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3864cef5090cSJed Brown PetscValidIntPointer(rejects,2); 3865cef5090cSJed Brown *rejects = ts->reject; 3866cef5090cSJed Brown PetscFunctionReturn(0); 3867cef5090cSJed Brown } 3868cef5090cSJed Brown 3869cef5090cSJed Brown #undef __FUNCT__ 3870cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures" 3871cef5090cSJed Brown /*@ 3872cef5090cSJed Brown TSGetSNESFailures - Gets the total number of failed SNES solves 3873cef5090cSJed Brown 3874cef5090cSJed Brown Not Collective 3875cef5090cSJed Brown 3876cef5090cSJed Brown Input Parameter: 3877cef5090cSJed Brown . ts - TS context 3878cef5090cSJed Brown 3879cef5090cSJed Brown Output Parameter: 3880cef5090cSJed Brown . fails - number of failed nonlinear solves 3881cef5090cSJed Brown 3882cef5090cSJed Brown Notes: 3883cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 3884cef5090cSJed Brown 3885cef5090cSJed Brown Level: intermediate 3886cef5090cSJed Brown 3887cef5090cSJed Brown .keywords: TS, get, number 3888cef5090cSJed Brown 38895ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures() 3890cef5090cSJed Brown @*/ 3891cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails) 3892cef5090cSJed Brown { 3893cef5090cSJed Brown PetscFunctionBegin; 3894cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3895cef5090cSJed Brown PetscValidIntPointer(fails,2); 3896cef5090cSJed Brown *fails = ts->num_snes_failures; 3897cef5090cSJed Brown PetscFunctionReturn(0); 3898cef5090cSJed Brown } 3899cef5090cSJed Brown 3900cef5090cSJed Brown #undef __FUNCT__ 3901cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections" 3902cef5090cSJed Brown /*@ 3903cef5090cSJed Brown TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails 3904cef5090cSJed Brown 3905cef5090cSJed Brown Not Collective 3906cef5090cSJed Brown 3907cef5090cSJed Brown Input Parameter: 3908cef5090cSJed Brown + ts - TS context 3909cef5090cSJed Brown - rejects - maximum number of rejected steps, pass -1 for unlimited 3910cef5090cSJed Brown 3911cef5090cSJed Brown Notes: 3912cef5090cSJed Brown The counter is reset to zero for each step 3913cef5090cSJed Brown 3914cef5090cSJed Brown Options Database Key: 3915cef5090cSJed Brown . -ts_max_reject - Maximum number of step rejections before a step fails 3916cef5090cSJed Brown 3917cef5090cSJed Brown Level: intermediate 3918cef5090cSJed Brown 3919cef5090cSJed Brown .keywords: TS, set, maximum, number 3920cef5090cSJed Brown 39215ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 3922cef5090cSJed Brown @*/ 3923cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects) 3924cef5090cSJed Brown { 3925cef5090cSJed Brown PetscFunctionBegin; 3926cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3927cef5090cSJed Brown ts->max_reject = rejects; 3928cef5090cSJed Brown PetscFunctionReturn(0); 3929cef5090cSJed Brown } 3930cef5090cSJed Brown 3931cef5090cSJed Brown #undef __FUNCT__ 3932cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures" 3933cef5090cSJed Brown /*@ 3934cef5090cSJed Brown TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves 3935cef5090cSJed Brown 3936cef5090cSJed Brown Not Collective 3937cef5090cSJed Brown 3938cef5090cSJed Brown Input Parameter: 3939cef5090cSJed Brown + ts - TS context 3940cef5090cSJed Brown - fails - maximum number of failed nonlinear solves, pass -1 for unlimited 3941cef5090cSJed Brown 3942cef5090cSJed Brown Notes: 3943cef5090cSJed Brown The counter is reset to zero for each successive call to TSSolve(). 3944cef5090cSJed Brown 3945cef5090cSJed Brown Options Database Key: 3946cef5090cSJed Brown . -ts_max_snes_failures - Maximum number of nonlinear solve failures 3947cef5090cSJed Brown 3948cef5090cSJed Brown Level: intermediate 3949cef5090cSJed Brown 3950cef5090cSJed Brown .keywords: TS, set, maximum, number 3951cef5090cSJed Brown 39525ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason() 3953cef5090cSJed Brown @*/ 3954cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails) 3955cef5090cSJed Brown { 3956cef5090cSJed Brown PetscFunctionBegin; 3957cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3958cef5090cSJed Brown ts->max_snes_failures = fails; 3959cef5090cSJed Brown PetscFunctionReturn(0); 3960cef5090cSJed Brown } 3961cef5090cSJed Brown 3962cef5090cSJed Brown #undef __FUNCT__ 3963cef5090cSJed Brown #define __FUNCT__ "TSSetErrorIfStepFails()" 3964cef5090cSJed Brown /*@ 3965cef5090cSJed Brown TSSetErrorIfStepFails - Error if no step succeeds 3966cef5090cSJed Brown 3967cef5090cSJed Brown Not Collective 3968cef5090cSJed Brown 3969cef5090cSJed Brown Input Parameter: 3970cef5090cSJed Brown + ts - TS context 3971cef5090cSJed Brown - err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure 3972cef5090cSJed Brown 3973cef5090cSJed Brown Options Database Key: 3974cef5090cSJed Brown . -ts_error_if_step_fails - Error if no step succeeds 3975cef5090cSJed Brown 3976cef5090cSJed Brown Level: intermediate 3977cef5090cSJed Brown 3978cef5090cSJed Brown .keywords: TS, set, error 3979cef5090cSJed Brown 39805ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 3981cef5090cSJed Brown @*/ 3982cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err) 3983cef5090cSJed Brown { 3984cef5090cSJed Brown PetscFunctionBegin; 3985cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3986cef5090cSJed Brown ts->errorifstepfailed = err; 3987cef5090cSJed Brown PetscFunctionReturn(0); 3988cef5090cSJed Brown } 3989cef5090cSJed Brown 3990cef5090cSJed Brown #undef __FUNCT__ 3991fb1732b5SBarry Smith #define __FUNCT__ "TSMonitorSolutionBinary" 3992fb1732b5SBarry Smith /*@C 3993fb1732b5SBarry Smith TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file 3994fb1732b5SBarry Smith 3995fb1732b5SBarry Smith Collective on TS 3996fb1732b5SBarry Smith 3997fb1732b5SBarry Smith Input Parameters: 3998fb1732b5SBarry Smith + ts - the TS context 3999fb1732b5SBarry Smith . step - current time-step 4000fb1732b5SBarry Smith . ptime - current time 40010910c330SBarry Smith . u - current state 4002fb1732b5SBarry Smith - viewer - binary viewer 4003fb1732b5SBarry Smith 4004fb1732b5SBarry Smith Level: intermediate 4005fb1732b5SBarry Smith 4006fb1732b5SBarry Smith .keywords: TS, vector, monitor, view 4007fb1732b5SBarry Smith 4008fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 4009fb1732b5SBarry Smith @*/ 40100910c330SBarry Smith PetscErrorCode TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec u,void *viewer) 4011fb1732b5SBarry Smith { 4012fb1732b5SBarry Smith PetscErrorCode ierr; 4013ed81e22dSJed Brown PetscViewer v = (PetscViewer)viewer; 4014fb1732b5SBarry Smith 4015fb1732b5SBarry Smith PetscFunctionBegin; 40160910c330SBarry Smith ierr = VecView(u,v);CHKERRQ(ierr); 4017ed81e22dSJed Brown PetscFunctionReturn(0); 4018ed81e22dSJed Brown } 4019ed81e22dSJed Brown 4020ed81e22dSJed Brown #undef __FUNCT__ 4021ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK" 4022ed81e22dSJed Brown /*@C 4023ed81e22dSJed Brown TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep. 4024ed81e22dSJed Brown 4025ed81e22dSJed Brown Collective on TS 4026ed81e22dSJed Brown 4027ed81e22dSJed Brown Input Parameters: 4028ed81e22dSJed Brown + ts - the TS context 4029ed81e22dSJed Brown . step - current time-step 4030ed81e22dSJed Brown . ptime - current time 40310910c330SBarry Smith . u - current state 4032ed81e22dSJed Brown - filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 4033ed81e22dSJed Brown 4034ed81e22dSJed Brown Level: intermediate 4035ed81e22dSJed Brown 4036ed81e22dSJed Brown Notes: 4037ed81e22dSJed Brown The VTK format does not allow writing multiple time steps in the same file, therefore a different file will be written for each time step. 4038ed81e22dSJed Brown These are named according to the file name template. 4039ed81e22dSJed Brown 4040ed81e22dSJed Brown This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy(). 4041ed81e22dSJed Brown 4042ed81e22dSJed Brown .keywords: TS, vector, monitor, view 4043ed81e22dSJed Brown 4044ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 4045ed81e22dSJed Brown @*/ 40460910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate) 4047ed81e22dSJed Brown { 4048ed81e22dSJed Brown PetscErrorCode ierr; 4049ed81e22dSJed Brown char filename[PETSC_MAX_PATH_LEN]; 4050ed81e22dSJed Brown PetscViewer viewer; 4051ed81e22dSJed Brown 4052ed81e22dSJed Brown PetscFunctionBegin; 40538caf3d72SBarry Smith ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr); 4054ce94432eSBarry Smith ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr); 40550910c330SBarry Smith ierr = VecView(u,viewer);CHKERRQ(ierr); 4056ed81e22dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 4057ed81e22dSJed Brown PetscFunctionReturn(0); 4058ed81e22dSJed Brown } 4059ed81e22dSJed Brown 4060ed81e22dSJed Brown #undef __FUNCT__ 4061ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy" 4062ed81e22dSJed Brown /*@C 4063ed81e22dSJed Brown TSMonitorSolutionVTKDestroy - Destroy context for monitoring 4064ed81e22dSJed Brown 4065ed81e22dSJed Brown Collective on TS 4066ed81e22dSJed Brown 4067ed81e22dSJed Brown Input Parameters: 4068ed81e22dSJed Brown . filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 4069ed81e22dSJed Brown 4070ed81e22dSJed Brown Level: intermediate 4071ed81e22dSJed Brown 4072ed81e22dSJed Brown Note: 4073ed81e22dSJed Brown This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK(). 4074ed81e22dSJed Brown 4075ed81e22dSJed Brown .keywords: TS, vector, monitor, view 4076ed81e22dSJed Brown 4077ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK() 4078ed81e22dSJed Brown @*/ 4079ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate) 4080ed81e22dSJed Brown { 4081ed81e22dSJed Brown PetscErrorCode ierr; 4082ed81e22dSJed Brown 4083ed81e22dSJed Brown PetscFunctionBegin; 4084ed81e22dSJed Brown ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr); 4085fb1732b5SBarry Smith PetscFunctionReturn(0); 4086fb1732b5SBarry Smith } 4087fb1732b5SBarry Smith 408884df9cb4SJed Brown #undef __FUNCT__ 4089552698daSJed Brown #define __FUNCT__ "TSGetAdapt" 409084df9cb4SJed Brown /*@ 4091552698daSJed Brown TSGetAdapt - Get the adaptive controller context for the current method 409284df9cb4SJed Brown 4093ed81e22dSJed Brown Collective on TS if controller has not been created yet 409484df9cb4SJed Brown 409584df9cb4SJed Brown Input Arguments: 4096ed81e22dSJed Brown . ts - time stepping context 409784df9cb4SJed Brown 409884df9cb4SJed Brown Output Arguments: 4099ed81e22dSJed Brown . adapt - adaptive controller 410084df9cb4SJed Brown 410184df9cb4SJed Brown Level: intermediate 410284df9cb4SJed Brown 4103ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose() 410484df9cb4SJed Brown @*/ 4105552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt) 410684df9cb4SJed Brown { 410784df9cb4SJed Brown PetscErrorCode ierr; 410884df9cb4SJed Brown 410984df9cb4SJed Brown PetscFunctionBegin; 411084df9cb4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 411184df9cb4SJed Brown PetscValidPointer(adapt,2); 411284df9cb4SJed Brown if (!ts->adapt) { 4113ce94432eSBarry Smith ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr); 41141c3436cfSJed Brown ierr = PetscLogObjectParent(ts,ts->adapt);CHKERRQ(ierr); 41151c3436cfSJed Brown ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr); 411684df9cb4SJed Brown } 411784df9cb4SJed Brown *adapt = ts->adapt; 411884df9cb4SJed Brown PetscFunctionReturn(0); 411984df9cb4SJed Brown } 4120d6ebe24aSShri Abhyankar 4121d6ebe24aSShri Abhyankar #undef __FUNCT__ 41221c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances" 41231c3436cfSJed Brown /*@ 41241c3436cfSJed Brown TSSetTolerances - Set tolerances for local truncation error when using adaptive controller 41251c3436cfSJed Brown 41261c3436cfSJed Brown Logically Collective 41271c3436cfSJed Brown 41281c3436cfSJed Brown Input Arguments: 41291c3436cfSJed Brown + ts - time integration context 41301c3436cfSJed Brown . atol - scalar absolute tolerances, PETSC_DECIDE to leave current value 41310298fd71SBarry Smith . vatol - vector of absolute tolerances or NULL, used in preference to atol if present 41321c3436cfSJed Brown . rtol - scalar relative tolerances, PETSC_DECIDE to leave current value 41330298fd71SBarry Smith - vrtol - vector of relative tolerances or NULL, used in preference to atol if present 41341c3436cfSJed Brown 41351c3436cfSJed Brown Level: beginner 41361c3436cfSJed Brown 4137c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances() 41381c3436cfSJed Brown @*/ 41391c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol) 41401c3436cfSJed Brown { 41411c3436cfSJed Brown PetscErrorCode ierr; 41421c3436cfSJed Brown 41431c3436cfSJed Brown PetscFunctionBegin; 4144c5033834SJed Brown if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol; 41451c3436cfSJed Brown if (vatol) { 41461c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr); 41471c3436cfSJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 4148bbd56ea5SKarl Rupp 41491c3436cfSJed Brown ts->vatol = vatol; 41501c3436cfSJed Brown } 4151c5033834SJed Brown if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol; 41521c3436cfSJed Brown if (vrtol) { 41531c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr); 41541c3436cfSJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 4155bbd56ea5SKarl Rupp 41561c3436cfSJed Brown ts->vrtol = vrtol; 41571c3436cfSJed Brown } 41581c3436cfSJed Brown PetscFunctionReturn(0); 41591c3436cfSJed Brown } 41601c3436cfSJed Brown 41611c3436cfSJed Brown #undef __FUNCT__ 4162c5033834SJed Brown #define __FUNCT__ "TSGetTolerances" 4163c5033834SJed Brown /*@ 4164c5033834SJed Brown TSGetTolerances - Get tolerances for local truncation error when using adaptive controller 4165c5033834SJed Brown 4166c5033834SJed Brown Logically Collective 4167c5033834SJed Brown 4168c5033834SJed Brown Input Arguments: 4169c5033834SJed Brown . ts - time integration context 4170c5033834SJed Brown 4171c5033834SJed Brown Output Arguments: 41720298fd71SBarry Smith + atol - scalar absolute tolerances, NULL to ignore 41730298fd71SBarry Smith . vatol - vector of absolute tolerances, NULL to ignore 41740298fd71SBarry Smith . rtol - scalar relative tolerances, NULL to ignore 41750298fd71SBarry Smith - vrtol - vector of relative tolerances, NULL to ignore 4176c5033834SJed Brown 4177c5033834SJed Brown Level: beginner 4178c5033834SJed Brown 4179c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances() 4180c5033834SJed Brown @*/ 4181c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol) 4182c5033834SJed Brown { 4183c5033834SJed Brown PetscFunctionBegin; 4184c5033834SJed Brown if (atol) *atol = ts->atol; 4185c5033834SJed Brown if (vatol) *vatol = ts->vatol; 4186c5033834SJed Brown if (rtol) *rtol = ts->rtol; 4187c5033834SJed Brown if (vrtol) *vrtol = ts->vrtol; 4188c5033834SJed Brown PetscFunctionReturn(0); 4189c5033834SJed Brown } 4190c5033834SJed Brown 4191c5033834SJed Brown #undef __FUNCT__ 41921c3436cfSJed Brown #define __FUNCT__ "TSErrorNormWRMS" 41931c3436cfSJed Brown /*@ 41941c3436cfSJed Brown TSErrorNormWRMS - compute a weighted norm of the difference between a vector and the current state 41951c3436cfSJed Brown 41961c3436cfSJed Brown Collective on TS 41971c3436cfSJed Brown 41981c3436cfSJed Brown Input Arguments: 41991c3436cfSJed Brown + ts - time stepping context 42001c3436cfSJed Brown - Y - state vector to be compared to ts->vec_sol 42011c3436cfSJed Brown 42021c3436cfSJed Brown Output Arguments: 42031c3436cfSJed Brown . norm - weighted norm, a value of 1.0 is considered small 42041c3436cfSJed Brown 42051c3436cfSJed Brown Level: developer 42061c3436cfSJed Brown 42071c3436cfSJed Brown .seealso: TSSetTolerances() 42081c3436cfSJed Brown @*/ 42091c3436cfSJed Brown PetscErrorCode TSErrorNormWRMS(TS ts,Vec Y,PetscReal *norm) 42101c3436cfSJed Brown { 42111c3436cfSJed Brown PetscErrorCode ierr; 42121c3436cfSJed Brown PetscInt i,n,N; 42130910c330SBarry Smith const PetscScalar *u,*y; 42140910c330SBarry Smith Vec U; 42151c3436cfSJed Brown PetscReal sum,gsum; 42161c3436cfSJed Brown 42171c3436cfSJed Brown PetscFunctionBegin; 42181c3436cfSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 42191c3436cfSJed Brown PetscValidHeaderSpecific(Y,VEC_CLASSID,2); 42201c3436cfSJed Brown PetscValidPointer(norm,3); 42210910c330SBarry Smith U = ts->vec_sol; 42220910c330SBarry Smith PetscCheckSameTypeAndComm(U,1,Y,2); 4223ce94432eSBarry Smith if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"Y cannot be the TS solution vector"); 42241c3436cfSJed Brown 42250910c330SBarry Smith ierr = VecGetSize(U,&N);CHKERRQ(ierr); 42260910c330SBarry Smith ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 42270910c330SBarry Smith ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 42281c3436cfSJed Brown ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 42291c3436cfSJed Brown sum = 0.; 4230ceefc113SJed Brown if (ts->vatol && ts->vrtol) { 4231ceefc113SJed Brown const PetscScalar *atol,*rtol; 4232ceefc113SJed Brown ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 4233ceefc113SJed Brown ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 4234ceefc113SJed Brown for (i=0; i<n; i++) { 42350910c330SBarry Smith PetscReal tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 42360910c330SBarry Smith sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 4237ceefc113SJed Brown } 4238ceefc113SJed Brown ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 4239ceefc113SJed Brown ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 4240ceefc113SJed Brown } else if (ts->vatol) { /* vector atol, scalar rtol */ 4241ceefc113SJed Brown const PetscScalar *atol; 4242ceefc113SJed Brown ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 4243ceefc113SJed Brown for (i=0; i<n; i++) { 42440910c330SBarry Smith PetscReal tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 42450910c330SBarry Smith sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 4246ceefc113SJed Brown } 4247ceefc113SJed Brown ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 4248ceefc113SJed Brown } else if (ts->vrtol) { /* scalar atol, vector rtol */ 4249ceefc113SJed Brown const PetscScalar *rtol; 4250ceefc113SJed Brown ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 4251ceefc113SJed Brown for (i=0; i<n; i++) { 42520910c330SBarry Smith PetscReal tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 42530910c330SBarry Smith sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 4254ceefc113SJed Brown } 4255ceefc113SJed Brown ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 4256ceefc113SJed Brown } else { /* scalar atol, scalar rtol */ 42571c3436cfSJed Brown for (i=0; i<n; i++) { 42580910c330SBarry Smith PetscReal tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 42590910c330SBarry Smith sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 42601c3436cfSJed Brown } 4261ceefc113SJed Brown } 42620910c330SBarry Smith ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 42631c3436cfSJed Brown ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 42641c3436cfSJed Brown 4265ce94432eSBarry Smith ierr = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 42661c3436cfSJed Brown *norm = PetscSqrtReal(gsum / N); 4267ce94432eSBarry Smith if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 42681c3436cfSJed Brown PetscFunctionReturn(0); 42691c3436cfSJed Brown } 42701c3436cfSJed Brown 42711c3436cfSJed Brown #undef __FUNCT__ 42728d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal" 42738d59e960SJed Brown /*@ 42748d59e960SJed Brown TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler 42758d59e960SJed Brown 42768d59e960SJed Brown Logically Collective on TS 42778d59e960SJed Brown 42788d59e960SJed Brown Input Arguments: 42798d59e960SJed Brown + ts - time stepping context 42808d59e960SJed Brown - cfltime - maximum stable time step if using forward Euler (value can be different on each process) 42818d59e960SJed Brown 42828d59e960SJed Brown Note: 42838d59e960SJed Brown After calling this function, the global CFL time can be obtained by calling TSGetCFLTime() 42848d59e960SJed Brown 42858d59e960SJed Brown Level: intermediate 42868d59e960SJed Brown 42878d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL 42888d59e960SJed Brown @*/ 42898d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime) 42908d59e960SJed Brown { 42918d59e960SJed Brown PetscFunctionBegin; 42928d59e960SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 42938d59e960SJed Brown ts->cfltime_local = cfltime; 42948d59e960SJed Brown ts->cfltime = -1.; 42958d59e960SJed Brown PetscFunctionReturn(0); 42968d59e960SJed Brown } 42978d59e960SJed Brown 42988d59e960SJed Brown #undef __FUNCT__ 42998d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime" 43008d59e960SJed Brown /*@ 43018d59e960SJed Brown TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler 43028d59e960SJed Brown 43038d59e960SJed Brown Collective on TS 43048d59e960SJed Brown 43058d59e960SJed Brown Input Arguments: 43068d59e960SJed Brown . ts - time stepping context 43078d59e960SJed Brown 43088d59e960SJed Brown Output Arguments: 43098d59e960SJed Brown . cfltime - maximum stable time step for forward Euler 43108d59e960SJed Brown 43118d59e960SJed Brown Level: advanced 43128d59e960SJed Brown 43138d59e960SJed Brown .seealso: TSSetCFLTimeLocal() 43148d59e960SJed Brown @*/ 43158d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime) 43168d59e960SJed Brown { 43178d59e960SJed Brown PetscErrorCode ierr; 43188d59e960SJed Brown 43198d59e960SJed Brown PetscFunctionBegin; 43208d59e960SJed Brown if (ts->cfltime < 0) { 4321ce94432eSBarry Smith ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 43228d59e960SJed Brown } 43238d59e960SJed Brown *cfltime = ts->cfltime; 43248d59e960SJed Brown PetscFunctionReturn(0); 43258d59e960SJed Brown } 43268d59e960SJed Brown 43278d59e960SJed Brown #undef __FUNCT__ 4328d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds" 4329d6ebe24aSShri Abhyankar /*@ 4330d6ebe24aSShri Abhyankar TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu 4331d6ebe24aSShri Abhyankar 4332d6ebe24aSShri Abhyankar Input Parameters: 4333d6ebe24aSShri Abhyankar . ts - the TS context. 4334d6ebe24aSShri Abhyankar . xl - lower bound. 4335d6ebe24aSShri Abhyankar . xu - upper bound. 4336d6ebe24aSShri Abhyankar 4337d6ebe24aSShri Abhyankar Notes: 4338d6ebe24aSShri Abhyankar If this routine is not called then the lower and upper bounds are set to 433933c0c2ddSJed Brown SNES_VI_NINF and SNES_VI_INF respectively during SNESSetUp(). 4340d6ebe24aSShri Abhyankar 43412bd2b0e6SSatish Balay Level: advanced 43422bd2b0e6SSatish Balay 4343d6ebe24aSShri Abhyankar @*/ 4344d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu) 4345d6ebe24aSShri Abhyankar { 4346d6ebe24aSShri Abhyankar PetscErrorCode ierr; 4347d6ebe24aSShri Abhyankar SNES snes; 4348d6ebe24aSShri Abhyankar 4349d6ebe24aSShri Abhyankar PetscFunctionBegin; 4350d6ebe24aSShri Abhyankar ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4351d6ebe24aSShri Abhyankar ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr); 4352d6ebe24aSShri Abhyankar PetscFunctionReturn(0); 4353d6ebe24aSShri Abhyankar } 4354d6ebe24aSShri Abhyankar 4355325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 4356c6db04a5SJed Brown #include <mex.h> 4357325fc9f4SBarry Smith 4358325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext; 4359325fc9f4SBarry Smith 4360325fc9f4SBarry Smith #undef __FUNCT__ 4361325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab" 4362325fc9f4SBarry Smith /* 4363325fc9f4SBarry Smith TSComputeFunction_Matlab - Calls the function that has been set with 4364325fc9f4SBarry Smith TSSetFunctionMatlab(). 4365325fc9f4SBarry Smith 4366325fc9f4SBarry Smith Collective on TS 4367325fc9f4SBarry Smith 4368325fc9f4SBarry Smith Input Parameters: 4369325fc9f4SBarry Smith + snes - the TS context 43700910c330SBarry Smith - u - input vector 4371325fc9f4SBarry Smith 4372325fc9f4SBarry Smith Output Parameter: 4373325fc9f4SBarry Smith . y - function vector, as set by TSSetFunction() 4374325fc9f4SBarry Smith 4375325fc9f4SBarry Smith Notes: 4376325fc9f4SBarry Smith TSComputeFunction() is typically used within nonlinear solvers 4377325fc9f4SBarry Smith implementations, so most users would not generally call this routine 4378325fc9f4SBarry Smith themselves. 4379325fc9f4SBarry Smith 4380325fc9f4SBarry Smith Level: developer 4381325fc9f4SBarry Smith 4382325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 4383325fc9f4SBarry Smith 4384325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 4385325fc9f4SBarry Smith */ 43860910c330SBarry Smith PetscErrorCode TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx) 4387325fc9f4SBarry Smith { 4388325fc9f4SBarry Smith PetscErrorCode ierr; 4389325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 4390325fc9f4SBarry Smith int nlhs = 1,nrhs = 7; 4391325fc9f4SBarry Smith mxArray *plhs[1],*prhs[7]; 4392325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,ly = 0,ls = 0; 4393325fc9f4SBarry Smith 4394325fc9f4SBarry Smith PetscFunctionBegin; 4395325fc9f4SBarry Smith PetscValidHeaderSpecific(snes,TS_CLASSID,1); 43960910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 43970910c330SBarry Smith PetscValidHeaderSpecific(udot,VEC_CLASSID,4); 4398325fc9f4SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,5); 43990910c330SBarry Smith PetscCheckSameComm(snes,1,u,3); 4400325fc9f4SBarry Smith PetscCheckSameComm(snes,1,y,5); 4401325fc9f4SBarry Smith 4402325fc9f4SBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 44030910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 44040910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr); 44050910c330SBarry Smith ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr); 4406bbd56ea5SKarl Rupp 4407325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 4408325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar(time); 4409325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 4410325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 4411325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)ly); 4412325fc9f4SBarry Smith prhs[5] = mxCreateString(sctx->funcname); 4413325fc9f4SBarry Smith prhs[6] = sctx->ctx; 4414325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr); 4415325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 4416325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 4417325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 4418325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 4419325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 4420325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 4421325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 4422325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 4423325fc9f4SBarry Smith PetscFunctionReturn(0); 4424325fc9f4SBarry Smith } 4425325fc9f4SBarry Smith 4426325fc9f4SBarry Smith 4427325fc9f4SBarry Smith #undef __FUNCT__ 4428325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab" 4429325fc9f4SBarry Smith /* 4430325fc9f4SBarry Smith TSSetFunctionMatlab - Sets the function evaluation routine and function 4431325fc9f4SBarry Smith vector for use by the TS routines in solving ODEs 4432e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 4433325fc9f4SBarry Smith 4434325fc9f4SBarry Smith Logically Collective on TS 4435325fc9f4SBarry Smith 4436325fc9f4SBarry Smith Input Parameters: 4437325fc9f4SBarry Smith + ts - the TS context 4438325fc9f4SBarry Smith - func - function evaluation routine 4439325fc9f4SBarry Smith 4440325fc9f4SBarry Smith Calling sequence of func: 44410910c330SBarry Smith $ func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx); 4442325fc9f4SBarry Smith 4443325fc9f4SBarry Smith Level: beginner 4444325fc9f4SBarry Smith 4445325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 4446325fc9f4SBarry Smith 4447325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 4448325fc9f4SBarry Smith */ 4449cdcf91faSSean Farley PetscErrorCode TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx) 4450325fc9f4SBarry Smith { 4451325fc9f4SBarry Smith PetscErrorCode ierr; 4452325fc9f4SBarry Smith TSMatlabContext *sctx; 4453325fc9f4SBarry Smith 4454325fc9f4SBarry Smith PetscFunctionBegin; 4455325fc9f4SBarry Smith /* currently sctx is memory bleed */ 4456325fc9f4SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 4457325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 4458325fc9f4SBarry Smith /* 4459325fc9f4SBarry Smith This should work, but it doesn't 4460325fc9f4SBarry Smith sctx->ctx = ctx; 4461325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 4462325fc9f4SBarry Smith */ 4463325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 4464bbd56ea5SKarl Rupp 44650298fd71SBarry Smith ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr); 4466325fc9f4SBarry Smith PetscFunctionReturn(0); 4467325fc9f4SBarry Smith } 4468325fc9f4SBarry Smith 4469325fc9f4SBarry Smith #undef __FUNCT__ 4470325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab" 4471325fc9f4SBarry Smith /* 4472325fc9f4SBarry Smith TSComputeJacobian_Matlab - Calls the function that has been set with 4473325fc9f4SBarry Smith TSSetJacobianMatlab(). 4474325fc9f4SBarry Smith 4475325fc9f4SBarry Smith Collective on TS 4476325fc9f4SBarry Smith 4477325fc9f4SBarry Smith Input Parameters: 4478cdcf91faSSean Farley + ts - the TS context 44790910c330SBarry Smith . u - input vector 4480325fc9f4SBarry Smith . A, B - the matrices 4481325fc9f4SBarry Smith - ctx - user context 4482325fc9f4SBarry Smith 4483325fc9f4SBarry Smith Output Parameter: 4484325fc9f4SBarry Smith . flag - structure of the matrix 4485325fc9f4SBarry Smith 4486325fc9f4SBarry Smith Level: developer 4487325fc9f4SBarry Smith 4488325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 4489325fc9f4SBarry Smith 4490325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 4491325fc9f4SBarry Smith @*/ 44920910c330SBarry Smith PetscErrorCode TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat *A,Mat *B,MatStructure *flag, void *ctx) 4493325fc9f4SBarry Smith { 4494325fc9f4SBarry Smith PetscErrorCode ierr; 4495325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 4496325fc9f4SBarry Smith int nlhs = 2,nrhs = 9; 4497325fc9f4SBarry Smith mxArray *plhs[2],*prhs[9]; 4498325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0; 4499325fc9f4SBarry Smith 4500325fc9f4SBarry Smith PetscFunctionBegin; 4501cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 45020910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 4503325fc9f4SBarry Smith 45040910c330SBarry Smith /* call Matlab function in ctx with arguments u and y */ 4505325fc9f4SBarry Smith 4506cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 45070910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 45080910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr); 45090910c330SBarry Smith ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr); 45100910c330SBarry Smith ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr); 4511bbd56ea5SKarl Rupp 4512325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 4513325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar((double)time); 4514325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 4515325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 4516325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)shift); 4517325fc9f4SBarry Smith prhs[5] = mxCreateDoubleScalar((double)lA); 4518325fc9f4SBarry Smith prhs[6] = mxCreateDoubleScalar((double)lB); 4519325fc9f4SBarry Smith prhs[7] = mxCreateString(sctx->funcname); 4520325fc9f4SBarry Smith prhs[8] = sctx->ctx; 4521325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr); 4522325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 4523325fc9f4SBarry Smith *flag = (MatStructure) mxGetScalar(plhs[1]);CHKERRQ(ierr); 4524325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 4525325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 4526325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 4527325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 4528325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 4529325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 4530325fc9f4SBarry Smith mxDestroyArray(prhs[6]); 4531325fc9f4SBarry Smith mxDestroyArray(prhs[7]); 4532325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 4533325fc9f4SBarry Smith mxDestroyArray(plhs[1]); 4534325fc9f4SBarry Smith PetscFunctionReturn(0); 4535325fc9f4SBarry Smith } 4536325fc9f4SBarry Smith 4537325fc9f4SBarry Smith 4538325fc9f4SBarry Smith #undef __FUNCT__ 4539325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab" 4540325fc9f4SBarry Smith /* 4541325fc9f4SBarry Smith TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 4542e3c5b3baSBarry Smith 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 4543325fc9f4SBarry Smith 4544325fc9f4SBarry Smith Logically Collective on TS 4545325fc9f4SBarry Smith 4546325fc9f4SBarry Smith Input Parameters: 4547cdcf91faSSean Farley + ts - the TS context 4548325fc9f4SBarry Smith . A,B - Jacobian matrices 4549325fc9f4SBarry Smith . func - function evaluation routine 4550325fc9f4SBarry Smith - ctx - user context 4551325fc9f4SBarry Smith 4552325fc9f4SBarry Smith Calling sequence of func: 45530910c330SBarry Smith $ flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx); 4554325fc9f4SBarry Smith 4555325fc9f4SBarry Smith 4556325fc9f4SBarry Smith Level: developer 4557325fc9f4SBarry Smith 4558325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 4559325fc9f4SBarry Smith 4560325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 4561325fc9f4SBarry Smith */ 4562cdcf91faSSean Farley PetscErrorCode TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx) 4563325fc9f4SBarry Smith { 4564325fc9f4SBarry Smith PetscErrorCode ierr; 4565325fc9f4SBarry Smith TSMatlabContext *sctx; 4566325fc9f4SBarry Smith 4567325fc9f4SBarry Smith PetscFunctionBegin; 4568325fc9f4SBarry Smith /* currently sctx is memory bleed */ 4569325fc9f4SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 4570325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 4571325fc9f4SBarry Smith /* 4572325fc9f4SBarry Smith This should work, but it doesn't 4573325fc9f4SBarry Smith sctx->ctx = ctx; 4574325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 4575325fc9f4SBarry Smith */ 4576325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 4577bbd56ea5SKarl Rupp 4578cdcf91faSSean Farley ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 4579325fc9f4SBarry Smith PetscFunctionReturn(0); 4580325fc9f4SBarry Smith } 4581325fc9f4SBarry Smith 4582b5b1a830SBarry Smith #undef __FUNCT__ 4583b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab" 4584b5b1a830SBarry Smith /* 4585b5b1a830SBarry Smith TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab(). 4586b5b1a830SBarry Smith 4587b5b1a830SBarry Smith Collective on TS 4588b5b1a830SBarry Smith 4589b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 4590b5b1a830SBarry Smith @*/ 45910910c330SBarry Smith PetscErrorCode TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx) 4592b5b1a830SBarry Smith { 4593b5b1a830SBarry Smith PetscErrorCode ierr; 4594b5b1a830SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 4595a530c242SBarry Smith int nlhs = 1,nrhs = 6; 4596b5b1a830SBarry Smith mxArray *plhs[1],*prhs[6]; 4597b5b1a830SBarry Smith long long int lx = 0,ls = 0; 4598b5b1a830SBarry Smith 4599b5b1a830SBarry Smith PetscFunctionBegin; 4600cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 46010910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,4); 4602b5b1a830SBarry Smith 4603cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 46040910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 4605bbd56ea5SKarl Rupp 4606b5b1a830SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 4607b5b1a830SBarry Smith prhs[1] = mxCreateDoubleScalar((double)it); 4608b5b1a830SBarry Smith prhs[2] = mxCreateDoubleScalar((double)time); 4609b5b1a830SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lx); 4610b5b1a830SBarry Smith prhs[4] = mxCreateString(sctx->funcname); 4611b5b1a830SBarry Smith prhs[5] = sctx->ctx; 4612b5b1a830SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr); 4613b5b1a830SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 4614b5b1a830SBarry Smith mxDestroyArray(prhs[0]); 4615b5b1a830SBarry Smith mxDestroyArray(prhs[1]); 4616b5b1a830SBarry Smith mxDestroyArray(prhs[2]); 4617b5b1a830SBarry Smith mxDestroyArray(prhs[3]); 4618b5b1a830SBarry Smith mxDestroyArray(prhs[4]); 4619b5b1a830SBarry Smith mxDestroyArray(plhs[0]); 4620b5b1a830SBarry Smith PetscFunctionReturn(0); 4621b5b1a830SBarry Smith } 4622b5b1a830SBarry Smith 4623b5b1a830SBarry Smith 4624b5b1a830SBarry Smith #undef __FUNCT__ 4625b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab" 4626b5b1a830SBarry Smith /* 4627b5b1a830SBarry Smith TSMonitorSetMatlab - Sets the monitor function from Matlab 4628b5b1a830SBarry Smith 4629b5b1a830SBarry Smith Level: developer 4630b5b1a830SBarry Smith 4631b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function 4632b5b1a830SBarry Smith 4633b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 4634b5b1a830SBarry Smith */ 4635cdcf91faSSean Farley PetscErrorCode TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx) 4636b5b1a830SBarry Smith { 4637b5b1a830SBarry Smith PetscErrorCode ierr; 4638b5b1a830SBarry Smith TSMatlabContext *sctx; 4639b5b1a830SBarry Smith 4640b5b1a830SBarry Smith PetscFunctionBegin; 4641b5b1a830SBarry Smith /* currently sctx is memory bleed */ 4642b5b1a830SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 4643b5b1a830SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 4644b5b1a830SBarry Smith /* 4645b5b1a830SBarry Smith This should work, but it doesn't 4646b5b1a830SBarry Smith sctx->ctx = ctx; 4647b5b1a830SBarry Smith mexMakeArrayPersistent(sctx->ctx); 4648b5b1a830SBarry Smith */ 4649b5b1a830SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 4650bbd56ea5SKarl Rupp 46510298fd71SBarry Smith ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr); 4652b5b1a830SBarry Smith PetscFunctionReturn(0); 4653b5b1a830SBarry Smith } 4654325fc9f4SBarry Smith #endif 4655b3603a34SBarry Smith 46560b039ecaSBarry Smith 46570b039ecaSBarry Smith 4658b3603a34SBarry Smith #undef __FUNCT__ 46594f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution" 4660b3603a34SBarry Smith /*@C 46614f09c107SBarry Smith TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector 4662b3603a34SBarry Smith in a time based line graph 4663b3603a34SBarry Smith 4664b3603a34SBarry Smith Collective on TS 4665b3603a34SBarry Smith 4666b3603a34SBarry Smith Input Parameters: 4667b3603a34SBarry Smith + ts - the TS context 4668b3603a34SBarry Smith . step - current time-step 4669b3603a34SBarry Smith . ptime - current time 4670b3603a34SBarry Smith - lg - a line graph object 4671b3603a34SBarry Smith 4672b3603a34SBarry Smith Level: intermediate 4673b3603a34SBarry Smith 46740b039ecaSBarry Smith Notes: each process in a parallel run displays its component solutions in a separate window 4675b3603a34SBarry Smith 4676b3603a34SBarry Smith .keywords: TS, vector, monitor, view 4677b3603a34SBarry Smith 4678b3603a34SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 4679b3603a34SBarry Smith @*/ 46800910c330SBarry Smith PetscErrorCode TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 4681b3603a34SBarry Smith { 4682b3603a34SBarry Smith PetscErrorCode ierr; 46830b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 4684b3603a34SBarry Smith const PetscScalar *yy; 468558ff32f7SBarry Smith PetscInt dim; 4686b3603a34SBarry Smith 4687b3603a34SBarry Smith PetscFunctionBegin; 468858ff32f7SBarry Smith if (!step) { 4689a9f9c1f6SBarry Smith PetscDrawAxis axis; 4690a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 4691a9f9c1f6SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr); 46920910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 46930b039ecaSBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 46940b039ecaSBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 469558ff32f7SBarry Smith } 46960910c330SBarry Smith ierr = VecGetArrayRead(u,&yy);CHKERRQ(ierr); 4697e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 4698e3efe391SJed Brown { 4699e3efe391SJed Brown PetscReal *yreal; 4700e3efe391SJed Brown PetscInt i,n; 47010910c330SBarry Smith ierr = VecGetLocalSize(u,&n);CHKERRQ(ierr); 4702e3efe391SJed Brown ierr = PetscMalloc(n*sizeof(PetscReal),&yreal);CHKERRQ(ierr); 4703e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 47040b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 4705e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 4706e3efe391SJed Brown } 4707e3efe391SJed Brown #else 47080b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 4709e3efe391SJed Brown #endif 47100910c330SBarry Smith ierr = VecRestoreArrayRead(u,&yy);CHKERRQ(ierr); 4711b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 47120b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 47133923b477SBarry Smith } 4714b3603a34SBarry Smith PetscFunctionReturn(0); 4715b3603a34SBarry Smith } 4716b3603a34SBarry Smith 4717b3603a34SBarry Smith #undef __FUNCT__ 47184f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError" 4719ef20d060SBarry Smith /*@C 47204f09c107SBarry Smith TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector 4721ef20d060SBarry Smith in a time based line graph 4722ef20d060SBarry Smith 4723ef20d060SBarry Smith Collective on TS 4724ef20d060SBarry Smith 4725ef20d060SBarry Smith Input Parameters: 4726ef20d060SBarry Smith + ts - the TS context 4727ef20d060SBarry Smith . step - current time-step 4728ef20d060SBarry Smith . ptime - current time 4729ef20d060SBarry Smith - lg - a line graph object 4730ef20d060SBarry Smith 4731ef20d060SBarry Smith Level: intermediate 4732ef20d060SBarry Smith 4733abd5a294SJed Brown Notes: 4734abd5a294SJed Brown Only for sequential solves. 4735abd5a294SJed Brown 4736abd5a294SJed Brown The user must provide the solution using TSSetSolutionFunction() to use this monitor. 4737abd5a294SJed Brown 4738abd5a294SJed Brown Options Database Keys: 47394f09c107SBarry Smith . -ts_monitor_lg_error - create a graphical monitor of error history 4740ef20d060SBarry Smith 4741ef20d060SBarry Smith .keywords: TS, vector, monitor, view 4742ef20d060SBarry Smith 4743abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 4744ef20d060SBarry Smith @*/ 47450910c330SBarry Smith PetscErrorCode TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 4746ef20d060SBarry Smith { 4747ef20d060SBarry Smith PetscErrorCode ierr; 47480b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 4749ef20d060SBarry Smith const PetscScalar *yy; 4750ef20d060SBarry Smith Vec y; 4751a9f9c1f6SBarry Smith PetscInt dim; 4752ef20d060SBarry Smith 4753ef20d060SBarry Smith PetscFunctionBegin; 4754a9f9c1f6SBarry Smith if (!step) { 4755a9f9c1f6SBarry Smith PetscDrawAxis axis; 4756a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 47571ae185eaSBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr); 47580910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 4759a9f9c1f6SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 4760a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4761a9f9c1f6SBarry Smith } 47620910c330SBarry Smith ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 4763ef20d060SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr); 47640910c330SBarry Smith ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr); 4765ef20d060SBarry Smith ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr); 4766e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 4767e3efe391SJed Brown { 4768e3efe391SJed Brown PetscReal *yreal; 4769e3efe391SJed Brown PetscInt i,n; 4770e3efe391SJed Brown ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr); 4771e3efe391SJed Brown ierr = PetscMalloc(n*sizeof(PetscReal),&yreal);CHKERRQ(ierr); 4772e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 47730b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 4774e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 4775e3efe391SJed Brown } 4776e3efe391SJed Brown #else 47770b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 4778e3efe391SJed Brown #endif 4779ef20d060SBarry Smith ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr); 4780ef20d060SBarry Smith ierr = VecDestroy(&y);CHKERRQ(ierr); 4781b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 47820b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 47833923b477SBarry Smith } 4784ef20d060SBarry Smith PetscFunctionReturn(0); 4785ef20d060SBarry Smith } 4786ef20d060SBarry Smith 4787201da799SBarry Smith #undef __FUNCT__ 4788201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations" 4789201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 4790201da799SBarry Smith { 4791201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 4792201da799SBarry Smith PetscReal x = ptime,y; 4793201da799SBarry Smith PetscErrorCode ierr; 4794201da799SBarry Smith PetscInt its; 4795201da799SBarry Smith 4796201da799SBarry Smith PetscFunctionBegin; 4797201da799SBarry Smith if (!n) { 4798201da799SBarry Smith PetscDrawAxis axis; 4799bbd56ea5SKarl Rupp 4800201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 4801201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr); 4802201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4803bbd56ea5SKarl Rupp 4804201da799SBarry Smith ctx->snes_its = 0; 4805201da799SBarry Smith } 4806201da799SBarry Smith ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr); 4807201da799SBarry Smith y = its - ctx->snes_its; 4808201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 48093fbbecb0SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 4810201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 4811201da799SBarry Smith } 4812201da799SBarry Smith ctx->snes_its = its; 4813201da799SBarry Smith PetscFunctionReturn(0); 4814201da799SBarry Smith } 4815201da799SBarry Smith 4816201da799SBarry Smith #undef __FUNCT__ 4817201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations" 4818201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 4819201da799SBarry Smith { 4820201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 4821201da799SBarry Smith PetscReal x = ptime,y; 4822201da799SBarry Smith PetscErrorCode ierr; 4823201da799SBarry Smith PetscInt its; 4824201da799SBarry Smith 4825201da799SBarry Smith PetscFunctionBegin; 4826201da799SBarry Smith if (!n) { 4827201da799SBarry Smith PetscDrawAxis axis; 4828bbd56ea5SKarl Rupp 4829201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 4830201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr); 4831201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4832bbd56ea5SKarl Rupp 4833201da799SBarry Smith ctx->ksp_its = 0; 4834201da799SBarry Smith } 4835201da799SBarry Smith ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr); 4836201da799SBarry Smith y = its - ctx->ksp_its; 4837201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 483899fdda47SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 4839201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 4840201da799SBarry Smith } 4841201da799SBarry Smith ctx->ksp_its = its; 4842201da799SBarry Smith PetscFunctionReturn(0); 4843201da799SBarry Smith } 4844f9c1d6abSBarry Smith 4845f9c1d6abSBarry Smith #undef __FUNCT__ 4846f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability" 4847f9c1d6abSBarry Smith /*@ 4848f9c1d6abSBarry Smith TSComputeLinearStability - computes the linear stability function at a point 4849f9c1d6abSBarry Smith 4850f9c1d6abSBarry Smith Collective on TS and Vec 4851f9c1d6abSBarry Smith 4852f9c1d6abSBarry Smith Input Parameters: 4853f9c1d6abSBarry Smith + ts - the TS context 4854f9c1d6abSBarry Smith - xr,xi - real and imaginary part of input arguments 4855f9c1d6abSBarry Smith 4856f9c1d6abSBarry Smith Output Parameters: 4857f9c1d6abSBarry Smith . yr,yi - real and imaginary part of function value 4858f9c1d6abSBarry Smith 4859f9c1d6abSBarry Smith Level: developer 4860f9c1d6abSBarry Smith 4861f9c1d6abSBarry Smith .keywords: TS, compute 4862f9c1d6abSBarry Smith 4863f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction() 4864f9c1d6abSBarry Smith @*/ 4865f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi) 4866f9c1d6abSBarry Smith { 4867f9c1d6abSBarry Smith PetscErrorCode ierr; 4868f9c1d6abSBarry Smith 4869f9c1d6abSBarry Smith PetscFunctionBegin; 4870f9c1d6abSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4871ce94432eSBarry Smith if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method"); 4872f9c1d6abSBarry Smith ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr); 4873f9c1d6abSBarry Smith PetscFunctionReturn(0); 4874f9c1d6abSBarry Smith } 4875