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 400298fd71SBarry Smith if (!TSRegisterAllCalled) {ierr = TSRegisterAll(NULL);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 130bdad233fSMatthew Knepley /* Monitor options */ 131a6570f20SBarry Smith ierr = PetscOptionsString("-ts_monitor","Monitor timestep size","TSMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 132eabae89aSBarry Smith if (flg) { 133ce94432eSBarry Smith ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)ts),monfilename,&monviewer);CHKERRQ(ierr); 134649052a6SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 135bdad233fSMatthew Knepley } 1365180491cSLisandro Dalcin ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 1375180491cSLisandro Dalcin if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);} 1385180491cSLisandro Dalcin 1394f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr); 140a7cc72afSBarry Smith if (opt) { 1410b039ecaSBarry Smith TSMonitorLGCtx ctx; 1423923b477SBarry Smith PetscInt howoften = 1; 143a80ad3e0SBarry Smith 1440298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr); 145ce94432eSBarry Smith ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 1464f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 147b3603a34SBarry Smith } 1484f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr); 149b3603a34SBarry Smith if (opt) { 1500b039ecaSBarry Smith TSMonitorLGCtx ctx; 1513923b477SBarry Smith PetscInt howoften = 1; 152b3603a34SBarry Smith 1530298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 15422d28d08SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 1554f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 156bdad233fSMatthew Knepley } 1574f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr); 158ef20d060SBarry Smith if (opt) { 1590b039ecaSBarry Smith TSMonitorLGCtx ctx; 1603923b477SBarry Smith PetscInt howoften = 1; 161ef20d060SBarry Smith 1620298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr); 16322d28d08SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 1644f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 165ef20d060SBarry Smith } 166201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr); 167201da799SBarry Smith if (opt) { 168201da799SBarry Smith TSMonitorLGCtx ctx; 169201da799SBarry Smith PetscInt howoften = 1; 170201da799SBarry Smith 1710298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 17222d28d08SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 173201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 174201da799SBarry Smith } 175201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr); 176201da799SBarry Smith if (opt) { 177201da799SBarry Smith TSMonitorLGCtx ctx; 178201da799SBarry Smith PetscInt howoften = 1; 179201da799SBarry Smith 1800298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 18122d28d08SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 182201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 183201da799SBarry Smith } 1848189c53fSBarry Smith ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr); 1858189c53fSBarry Smith if (opt) { 1868189c53fSBarry Smith TSMonitorSPEigCtx ctx; 1878189c53fSBarry Smith PetscInt howoften = 1; 1888189c53fSBarry Smith 1890298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr); 19022d28d08SBarry Smith ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 1918189c53fSBarry Smith ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr); 1928189c53fSBarry Smith } 193ef20d060SBarry Smith opt = PETSC_FALSE; 1940dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr); 195a7cc72afSBarry Smith if (opt) { 19683a4ac43SBarry Smith TSMonitorDrawCtx ctx; 19783a4ac43SBarry Smith PetscInt howoften = 1; 198a80ad3e0SBarry Smith 1990298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 200ce94432eSBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 20183a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 202bdad233fSMatthew Knepley } 203fb1732b5SBarry Smith opt = PETSC_FALSE; 2042d5ee99bSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr); 2052d5ee99bSBarry Smith if (opt) { 2062d5ee99bSBarry Smith TSMonitorDrawCtx ctx; 2072d5ee99bSBarry Smith PetscReal bounds[4]; 2082d5ee99bSBarry Smith PetscInt n = 4; 2092d5ee99bSBarry Smith PetscDraw draw; 2102d5ee99bSBarry Smith 2112d5ee99bSBarry Smith ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr); 2122d5ee99bSBarry Smith if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field"); 2132d5ee99bSBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,1,&ctx);CHKERRQ(ierr); 2142d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr); 2152d5ee99bSBarry Smith ierr = PetscDrawClear(draw);CHKERRQ(ierr); 2164b363babSBarry Smith ierr = PetscDrawAxisCreate(draw,&ctx->axis);CHKERRQ(ierr); 2174b363babSBarry Smith ierr = PetscDrawAxisSetLimits(ctx->axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr); 218f54adfc0SBarry Smith ierr = PetscDrawAxisSetLabels(ctx->axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr); 2194b363babSBarry Smith ierr = PetscDrawAxisDraw(ctx->axis);CHKERRQ(ierr); 22007995780SPeter Brune /* ierr = PetscDrawSetCoordinates(draw,bounds[0],bounds[1],bounds[2],bounds[3]);CHKERRQ(ierr); */ 2212d5ee99bSBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 2222d5ee99bSBarry Smith } 2232d5ee99bSBarry Smith opt = PETSC_FALSE; 2240dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr); 2253a471f94SBarry Smith if (opt) { 22683a4ac43SBarry Smith TSMonitorDrawCtx ctx; 22783a4ac43SBarry Smith PetscInt howoften = 1; 2283a471f94SBarry Smith 2290298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr); 230ce94432eSBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 23183a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 2323a471f94SBarry Smith } 2333a471f94SBarry Smith opt = PETSC_FALSE; 23491b97e58SBarry Smith ierr = PetscOptionsString("-ts_monitor_solution_binary","Save each solution to a binary file","TSMonitorSolutionBinary",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 235fb1732b5SBarry Smith if (flg) { 236fb1732b5SBarry Smith PetscViewer ctx; 237fb1732b5SBarry Smith if (monfilename[0]) { 238ce94432eSBarry Smith ierr = PetscViewerBinaryOpen(PetscObjectComm((PetscObject)ts),monfilename,FILE_MODE_WRITE,&ctx);CHKERRQ(ierr); 239c2fbc07fSBarry Smith ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 240fb1732b5SBarry Smith } else { 241ce94432eSBarry Smith ctx = PETSC_VIEWER_BINARY_(PetscObjectComm((PetscObject)ts)); 2420298fd71SBarry Smith ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))NULL);CHKERRQ(ierr); 243fb1732b5SBarry Smith } 244fb1732b5SBarry Smith } 245ed81e22dSJed Brown opt = PETSC_FALSE; 24691b97e58SBarry 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); 247ed81e22dSJed Brown if (flg) { 248ed81e22dSJed Brown const char *ptr,*ptr2; 249ed81e22dSJed Brown char *filetemplate; 250ce94432eSBarry Smith if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 251ed81e22dSJed Brown /* Do some cursory validation of the input. */ 252ed81e22dSJed Brown ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr); 253ce94432eSBarry Smith if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 254ed81e22dSJed Brown for (ptr++; ptr && *ptr; ptr++) { 255ed81e22dSJed Brown ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr); 256ce94432eSBarry 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"); 257ed81e22dSJed Brown if (ptr2) break; 258ed81e22dSJed Brown } 259ed81e22dSJed Brown ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr); 260ed81e22dSJed Brown ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr); 261ed81e22dSJed Brown } 262bdad233fSMatthew Knepley 263d1212d36SBarry Smith ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr); 264d1212d36SBarry Smith if (flg) { 265d1212d36SBarry Smith TSMonitorDMDARayCtx *rayctx; 266d1212d36SBarry Smith int ray = 0; 267d1212d36SBarry Smith DMDADirection ddir; 268d1212d36SBarry Smith DM da; 269d1212d36SBarry Smith PetscMPIInt rank; 270d1212d36SBarry Smith 271ce94432eSBarry Smith if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 272d1212d36SBarry Smith if (dir[0] == 'x') ddir = DMDA_X; 273d1212d36SBarry Smith else if (dir[0] == 'y') ddir = DMDA_Y; 274ce94432eSBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 275d1212d36SBarry Smith sscanf(dir+2,"%d",&ray); 276d1212d36SBarry Smith 277d1212d36SBarry Smith ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr); 278d1212d36SBarry Smith ierr = PetscNew(TSMonitorDMDARayCtx,&rayctx);CHKERRQ(ierr); 279d1212d36SBarry Smith ierr = TSGetDM(ts,&da);CHKERRQ(ierr); 280d1212d36SBarry Smith ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr); 281ce94432eSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr); 282d1212d36SBarry Smith if (!rank) { 283d1212d36SBarry Smith ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr); 284d1212d36SBarry Smith } 285d1212d36SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr); 286d1212d36SBarry Smith } 287d1212d36SBarry Smith 288ad6bc421SBarry Smith ierr = TSGetTSAdapt(ts,&adapt);CHKERRQ(ierr); 2891c3436cfSJed Brown ierr = TSAdaptSetFromOptions(adapt);CHKERRQ(ierr); 2901c3436cfSJed Brown 291d52bd9f3SBarry Smith ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 292d52bd9f3SBarry Smith if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);} 293d52bd9f3SBarry Smith 294bdad233fSMatthew Knepley /* Handle specific TS options */ 295abc0a331SBarry Smith if (ts->ops->setfromoptions) { 296bdad233fSMatthew Knepley ierr = (*ts->ops->setfromoptions)(ts);CHKERRQ(ierr); 297bdad233fSMatthew Knepley } 2985d973c19SBarry Smith 2995d973c19SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 3005d973c19SBarry Smith ierr = PetscObjectProcessOptionsHandlers((PetscObject)ts);CHKERRQ(ierr); 301bdad233fSMatthew Knepley ierr = PetscOptionsEnd();CHKERRQ(ierr); 302bdad233fSMatthew Knepley PetscFunctionReturn(0); 303bdad233fSMatthew Knepley } 304bdad233fSMatthew Knepley 305bdad233fSMatthew Knepley #undef __FUNCT__ 306cdcf91faSSean Farley #undef __FUNCT__ 3074a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSJacobian" 308a7a1495cSBarry Smith /*@ 3098c385f81SBarry Smith TSComputeRHSJacobian - Computes the Jacobian matrix that has been 310a7a1495cSBarry Smith set with TSSetRHSJacobian(). 311a7a1495cSBarry Smith 312a7a1495cSBarry Smith Collective on TS and Vec 313a7a1495cSBarry Smith 314a7a1495cSBarry Smith Input Parameters: 315316643e7SJed Brown + ts - the TS context 316a7a1495cSBarry Smith . t - current timestep 3170910c330SBarry Smith - U - input vector 318a7a1495cSBarry Smith 319a7a1495cSBarry Smith Output Parameters: 320a7a1495cSBarry Smith + A - Jacobian matrix 321a7a1495cSBarry Smith . B - optional preconditioning matrix 322a7a1495cSBarry Smith - flag - flag indicating matrix structure 323a7a1495cSBarry Smith 324a7a1495cSBarry Smith Notes: 325a7a1495cSBarry Smith Most users should not need to explicitly call this routine, as it 326a7a1495cSBarry Smith is used internally within the nonlinear solvers. 327a7a1495cSBarry Smith 32894b7f48cSBarry Smith See KSPSetOperators() for important information about setting the 329a7a1495cSBarry Smith flag parameter. 330a7a1495cSBarry Smith 331a7a1495cSBarry Smith Level: developer 332a7a1495cSBarry Smith 333a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix 334a7a1495cSBarry Smith 33594b7f48cSBarry Smith .seealso: TSSetRHSJacobian(), KSPSetOperators() 336a7a1495cSBarry Smith @*/ 3370910c330SBarry Smith PetscErrorCode TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat *A,Mat *B,MatStructure *flg) 338a7a1495cSBarry Smith { 339dfbe8321SBarry Smith PetscErrorCode ierr; 3400910c330SBarry Smith PetscInt Ustate; 34124989b8cSPeter Brune DM dm; 342942e3340SBarry Smith DMTS tsdm; 34324989b8cSPeter Brune TSRHSJacobian rhsjacobianfunc; 34424989b8cSPeter Brune void *ctx; 34524989b8cSPeter Brune TSIJacobian ijacobianfunc; 346a7a1495cSBarry Smith 347a7a1495cSBarry Smith PetscFunctionBegin; 3480700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3490910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3500910c330SBarry Smith PetscCheckSameComm(ts,1,U,3); 35124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 352942e3340SBarry Smith ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr); 35324989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr); 3540298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr); 3550910c330SBarry Smith ierr = PetscObjectStateQuery((PetscObject)U,&Ustate);CHKERRQ(ierr); 3560910c330SBarry Smith if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate))) { 3570e4ef248SJed Brown *flg = ts->rhsjacobian.mstructure; 3580e4ef248SJed Brown PetscFunctionReturn(0); 359f8ede8e7SJed Brown } 360d90be118SSean Farley 361ce94432eSBarry Smith if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 362d90be118SSean Farley 36324989b8cSPeter Brune if (rhsjacobianfunc) { 3640910c330SBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,*A,*B);CHKERRQ(ierr); 365a7a1495cSBarry Smith *flg = DIFFERENT_NONZERO_PATTERN; 366a7a1495cSBarry Smith PetscStackPush("TS user Jacobian function"); 3670910c330SBarry Smith ierr = (*rhsjacobianfunc)(ts,t,U,A,B,flg,ctx);CHKERRQ(ierr); 368a7a1495cSBarry Smith PetscStackPop; 3690910c330SBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,*A,*B);CHKERRQ(ierr); 370a7a1495cSBarry Smith /* make sure user returned a correct Jacobian and preconditioner */ 3710700a824SBarry Smith PetscValidHeaderSpecific(*A,MAT_CLASSID,4); 3720700a824SBarry Smith PetscValidHeaderSpecific(*B,MAT_CLASSID,5); 373ef66eb69SBarry Smith } else { 374214bc6a2SJed Brown ierr = MatZeroEntries(*A);CHKERRQ(ierr); 375214bc6a2SJed Brown if (*A != *B) {ierr = MatZeroEntries(*B);CHKERRQ(ierr);} 376214bc6a2SJed Brown *flg = SAME_NONZERO_PATTERN; 377ef66eb69SBarry Smith } 3780e4ef248SJed Brown ts->rhsjacobian.time = t; 3790910c330SBarry Smith ts->rhsjacobian.X = U; 3800910c330SBarry Smith ierr = PetscObjectStateQuery((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr); 3810e4ef248SJed Brown ts->rhsjacobian.mstructure = *flg; 382a7a1495cSBarry Smith PetscFunctionReturn(0); 383a7a1495cSBarry Smith } 384a7a1495cSBarry Smith 3854a2ae208SSatish Balay #undef __FUNCT__ 3864a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction" 387316643e7SJed Brown /*@ 388d763cef2SBarry Smith TSComputeRHSFunction - Evaluates the right-hand-side function. 389d763cef2SBarry Smith 390316643e7SJed Brown Collective on TS and Vec 391316643e7SJed Brown 392316643e7SJed Brown Input Parameters: 393316643e7SJed Brown + ts - the TS context 394316643e7SJed Brown . t - current time 3950910c330SBarry Smith - U - state vector 396316643e7SJed Brown 397316643e7SJed Brown Output Parameter: 398316643e7SJed Brown . y - right hand side 399316643e7SJed Brown 400316643e7SJed Brown Note: 401316643e7SJed Brown Most users should not need to explicitly call this routine, as it 402316643e7SJed Brown is used internally within the nonlinear solvers. 403316643e7SJed Brown 404316643e7SJed Brown Level: developer 405316643e7SJed Brown 406316643e7SJed Brown .keywords: TS, compute 407316643e7SJed Brown 408316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction() 409316643e7SJed Brown @*/ 4100910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y) 411d763cef2SBarry Smith { 412dfbe8321SBarry Smith PetscErrorCode ierr; 41324989b8cSPeter Brune TSRHSFunction rhsfunction; 41424989b8cSPeter Brune TSIFunction ifunction; 41524989b8cSPeter Brune void *ctx; 41624989b8cSPeter Brune DM dm; 41724989b8cSPeter Brune 418d763cef2SBarry Smith PetscFunctionBegin; 4190700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4200910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 4210700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,4); 42224989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 42324989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 4240298fd71SBarry Smith ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr); 425d763cef2SBarry Smith 426ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 427d763cef2SBarry Smith 4280910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 42924989b8cSPeter Brune if (rhsfunction) { 430d763cef2SBarry Smith PetscStackPush("TS user right-hand-side function"); 4310910c330SBarry Smith ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr); 432d763cef2SBarry Smith PetscStackPop; 433214bc6a2SJed Brown } else { 434214bc6a2SJed Brown ierr = VecZeroEntries(y);CHKERRQ(ierr); 435b2cd27e8SJed Brown } 43644a41b28SSean Farley 4370910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 438d763cef2SBarry Smith PetscFunctionReturn(0); 439d763cef2SBarry Smith } 440d763cef2SBarry Smith 4414a2ae208SSatish Balay #undef __FUNCT__ 442ef20d060SBarry Smith #define __FUNCT__ "TSComputeSolutionFunction" 443ef20d060SBarry Smith /*@ 444ef20d060SBarry Smith TSComputeSolutionFunction - Evaluates the solution function. 445ef20d060SBarry Smith 446ef20d060SBarry Smith Collective on TS and Vec 447ef20d060SBarry Smith 448ef20d060SBarry Smith Input Parameters: 449ef20d060SBarry Smith + ts - the TS context 450ef20d060SBarry Smith - t - current time 451ef20d060SBarry Smith 452ef20d060SBarry Smith Output Parameter: 4530910c330SBarry Smith . U - the solution 454ef20d060SBarry Smith 455ef20d060SBarry Smith Note: 456ef20d060SBarry Smith Most users should not need to explicitly call this routine, as it 457ef20d060SBarry Smith is used internally within the nonlinear solvers. 458ef20d060SBarry Smith 459ef20d060SBarry Smith Level: developer 460ef20d060SBarry Smith 461ef20d060SBarry Smith .keywords: TS, compute 462ef20d060SBarry Smith 463abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 464ef20d060SBarry Smith @*/ 4650910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U) 466ef20d060SBarry Smith { 467ef20d060SBarry Smith PetscErrorCode ierr; 468ef20d060SBarry Smith TSSolutionFunction solutionfunction; 469ef20d060SBarry Smith void *ctx; 470ef20d060SBarry Smith DM dm; 471ef20d060SBarry Smith 472ef20d060SBarry Smith PetscFunctionBegin; 473ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4740910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 475ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 476ef20d060SBarry Smith ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr); 477ef20d060SBarry Smith 478ef20d060SBarry Smith if (solutionfunction) { 4799b7cd975SBarry Smith PetscStackPush("TS user solution function"); 4800910c330SBarry Smith ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr); 481ef20d060SBarry Smith PetscStackPop; 482ef20d060SBarry Smith } 483ef20d060SBarry Smith PetscFunctionReturn(0); 484ef20d060SBarry Smith } 4859b7cd975SBarry Smith #undef __FUNCT__ 4869b7cd975SBarry Smith #define __FUNCT__ "TSComputeForcingFunction" 4879b7cd975SBarry Smith /*@ 4889b7cd975SBarry Smith TSComputeForcingFunction - Evaluates the forcing function. 4899b7cd975SBarry Smith 4909b7cd975SBarry Smith Collective on TS and Vec 4919b7cd975SBarry Smith 4929b7cd975SBarry Smith Input Parameters: 4939b7cd975SBarry Smith + ts - the TS context 4949b7cd975SBarry Smith - t - current time 4959b7cd975SBarry Smith 4969b7cd975SBarry Smith Output Parameter: 4979b7cd975SBarry Smith . U - the function value 4989b7cd975SBarry Smith 4999b7cd975SBarry Smith Note: 5009b7cd975SBarry Smith Most users should not need to explicitly call this routine, as it 5019b7cd975SBarry Smith is used internally within the nonlinear solvers. 5029b7cd975SBarry Smith 5039b7cd975SBarry Smith Level: developer 5049b7cd975SBarry Smith 5059b7cd975SBarry Smith .keywords: TS, compute 5069b7cd975SBarry Smith 5079b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 5089b7cd975SBarry Smith @*/ 5099b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U) 5109b7cd975SBarry Smith { 5119b7cd975SBarry Smith PetscErrorCode ierr, (*forcing)(TS,PetscReal,Vec,void*); 5129b7cd975SBarry Smith void *ctx; 5139b7cd975SBarry Smith DM dm; 5149b7cd975SBarry Smith 5159b7cd975SBarry Smith PetscFunctionBegin; 5169b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5179b7cd975SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 5189b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 5199b7cd975SBarry Smith ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr); 5209b7cd975SBarry Smith 5219b7cd975SBarry Smith if (forcing) { 5229b7cd975SBarry Smith PetscStackPush("TS user forcing function"); 5239b7cd975SBarry Smith ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr); 5249b7cd975SBarry Smith PetscStackPop; 5259b7cd975SBarry Smith } 5269b7cd975SBarry Smith PetscFunctionReturn(0); 5279b7cd975SBarry Smith } 528ef20d060SBarry Smith 529ef20d060SBarry Smith #undef __FUNCT__ 530214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private" 531214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs) 532214bc6a2SJed Brown { 5332dd45cf8SJed Brown Vec F; 534214bc6a2SJed Brown PetscErrorCode ierr; 535214bc6a2SJed Brown 536214bc6a2SJed Brown PetscFunctionBegin; 5370298fd71SBarry Smith *Frhs = NULL; 5380298fd71SBarry Smith ierr = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr); 539214bc6a2SJed Brown if (!ts->Frhs) { 5402dd45cf8SJed Brown ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr); 541214bc6a2SJed Brown } 542214bc6a2SJed Brown *Frhs = ts->Frhs; 543214bc6a2SJed Brown PetscFunctionReturn(0); 544214bc6a2SJed Brown } 545214bc6a2SJed Brown 546214bc6a2SJed Brown #undef __FUNCT__ 547214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private" 548214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs) 549214bc6a2SJed Brown { 550214bc6a2SJed Brown Mat A,B; 5512dd45cf8SJed Brown PetscErrorCode ierr; 552214bc6a2SJed Brown 553214bc6a2SJed Brown PetscFunctionBegin; 5540298fd71SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 555214bc6a2SJed Brown if (Arhs) { 556214bc6a2SJed Brown if (!ts->Arhs) { 557214bc6a2SJed Brown ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr); 558214bc6a2SJed Brown } 559214bc6a2SJed Brown *Arhs = ts->Arhs; 560214bc6a2SJed Brown } 561214bc6a2SJed Brown if (Brhs) { 562214bc6a2SJed Brown if (!ts->Brhs) { 563214bc6a2SJed Brown ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr); 564214bc6a2SJed Brown } 565214bc6a2SJed Brown *Brhs = ts->Brhs; 566214bc6a2SJed Brown } 567214bc6a2SJed Brown PetscFunctionReturn(0); 568214bc6a2SJed Brown } 569214bc6a2SJed Brown 570214bc6a2SJed Brown #undef __FUNCT__ 571316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction" 572316643e7SJed Brown /*@ 5730910c330SBarry Smith TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0 574316643e7SJed Brown 575316643e7SJed Brown Collective on TS and Vec 576316643e7SJed Brown 577316643e7SJed Brown Input Parameters: 578316643e7SJed Brown + ts - the TS context 579316643e7SJed Brown . t - current time 5800910c330SBarry Smith . U - state vector 5810910c330SBarry Smith . Udot - time derivative of state vector 582214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate 583316643e7SJed Brown 584316643e7SJed Brown Output Parameter: 585316643e7SJed Brown . Y - right hand side 586316643e7SJed Brown 587316643e7SJed Brown Note: 588316643e7SJed Brown Most users should not need to explicitly call this routine, as it 589316643e7SJed Brown is used internally within the nonlinear solvers. 590316643e7SJed Brown 591316643e7SJed Brown If the user did did not write their equations in implicit form, this 592316643e7SJed Brown function recasts them in implicit form. 593316643e7SJed Brown 594316643e7SJed Brown Level: developer 595316643e7SJed Brown 596316643e7SJed Brown .keywords: TS, compute 597316643e7SJed Brown 598316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction() 599316643e7SJed Brown @*/ 6000910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex) 601316643e7SJed Brown { 602316643e7SJed Brown PetscErrorCode ierr; 60324989b8cSPeter Brune TSIFunction ifunction; 60424989b8cSPeter Brune TSRHSFunction rhsfunction; 60524989b8cSPeter Brune void *ctx; 60624989b8cSPeter Brune DM dm; 607316643e7SJed Brown 608316643e7SJed Brown PetscFunctionBegin; 6090700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6100910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 6110910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 6120700a824SBarry Smith PetscValidHeaderSpecific(Y,VEC_CLASSID,5); 613316643e7SJed Brown 61424989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 61524989b8cSPeter Brune ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr); 6160298fd71SBarry Smith ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 61724989b8cSPeter Brune 618ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 619d90be118SSean Farley 6200910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 62124989b8cSPeter Brune if (ifunction) { 622316643e7SJed Brown PetscStackPush("TS user implicit function"); 6230910c330SBarry Smith ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr); 624316643e7SJed Brown PetscStackPop; 625214bc6a2SJed Brown } 626214bc6a2SJed Brown if (imex) { 62724989b8cSPeter Brune if (!ifunction) { 6280910c330SBarry Smith ierr = VecCopy(Udot,Y);CHKERRQ(ierr); 6292dd45cf8SJed Brown } 63024989b8cSPeter Brune } else if (rhsfunction) { 63124989b8cSPeter Brune if (ifunction) { 632214bc6a2SJed Brown Vec Frhs; 633214bc6a2SJed Brown ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 6340910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 635214bc6a2SJed Brown ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr); 6362dd45cf8SJed Brown } else { 6370910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr); 6380910c330SBarry Smith ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr); 639316643e7SJed Brown } 6404a6899ffSJed Brown } 6410910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 642316643e7SJed Brown PetscFunctionReturn(0); 643316643e7SJed Brown } 644316643e7SJed Brown 645316643e7SJed Brown #undef __FUNCT__ 646316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian" 647316643e7SJed Brown /*@ 648316643e7SJed Brown TSComputeIJacobian - Evaluates the Jacobian of the DAE 649316643e7SJed Brown 650316643e7SJed Brown Collective on TS and Vec 651316643e7SJed Brown 652316643e7SJed Brown Input 653316643e7SJed Brown Input Parameters: 654316643e7SJed Brown + ts - the TS context 655316643e7SJed Brown . t - current timestep 6560910c330SBarry Smith . U - state vector 6570910c330SBarry Smith . Udot - time derivative of state vector 658214bc6a2SJed Brown . shift - shift to apply, see note below 659214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate 660316643e7SJed Brown 661316643e7SJed Brown Output Parameters: 662316643e7SJed Brown + A - Jacobian matrix 663316643e7SJed Brown . B - optional preconditioning matrix 664316643e7SJed Brown - flag - flag indicating matrix structure 665316643e7SJed Brown 666316643e7SJed Brown Notes: 6670910c330SBarry Smith If F(t,U,Udot)=0 is the DAE, the required Jacobian is 668316643e7SJed Brown 6690910c330SBarry Smith dF/dU + shift*dF/dUdot 670316643e7SJed Brown 671316643e7SJed Brown Most users should not need to explicitly call this routine, as it 672316643e7SJed Brown is used internally within the nonlinear solvers. 673316643e7SJed Brown 674316643e7SJed Brown Level: developer 675316643e7SJed Brown 676316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix 677316643e7SJed Brown 678316643e7SJed Brown .seealso: TSSetIJacobian() 67963495f91SJed Brown @*/ 6800910c330SBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat *A,Mat *B,MatStructure *flg,PetscBool imex) 681316643e7SJed Brown { 6820910c330SBarry Smith PetscInt Ustate, Udotstate; 683316643e7SJed Brown PetscErrorCode ierr; 68424989b8cSPeter Brune TSIJacobian ijacobian; 68524989b8cSPeter Brune TSRHSJacobian rhsjacobian; 68624989b8cSPeter Brune DM dm; 68724989b8cSPeter Brune void *ctx; 688316643e7SJed Brown 689316643e7SJed Brown PetscFunctionBegin; 6900700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6910910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 6920910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 693316643e7SJed Brown PetscValidPointer(A,6); 6940700a824SBarry Smith PetscValidHeaderSpecific(*A,MAT_CLASSID,6); 695316643e7SJed Brown PetscValidPointer(B,7); 6960700a824SBarry Smith PetscValidHeaderSpecific(*B,MAT_CLASSID,7); 697316643e7SJed Brown PetscValidPointer(flg,8); 69824989b8cSPeter Brune 69924989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 70024989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr); 7010298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 70224989b8cSPeter Brune 7030910c330SBarry Smith ierr = PetscObjectStateQuery((PetscObject)U,&Ustate);CHKERRQ(ierr); 7040910c330SBarry Smith ierr = PetscObjectStateQuery((PetscObject)Udot,&Udotstate);CHKERRQ(ierr); 7050910c330SBarry Smith if (ts->ijacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->ijacobian.X == U && ts->ijacobian.Xstate == Ustate && ts->ijacobian.Xdot == Udot && ts->ijacobian.Xdotstate == Udotstate && ts->ijacobian.imex == imex))) { 7060026cea9SSean Farley *flg = ts->ijacobian.mstructure; 7070026cea9SSean Farley ierr = MatScale(*A, shift / ts->ijacobian.shift);CHKERRQ(ierr); 7080026cea9SSean Farley PetscFunctionReturn(0); 7090026cea9SSean Farley } 710316643e7SJed Brown 711ce94432eSBarry Smith if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 712316643e7SJed Brown 7134e684422SJed Brown *flg = SAME_NONZERO_PATTERN; /* In case we're solving a linear problem in which case it wouldn't get initialized below. */ 7140910c330SBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,*A,*B);CHKERRQ(ierr); 71524989b8cSPeter Brune if (ijacobian) { 7162dd45cf8SJed Brown *flg = DIFFERENT_NONZERO_PATTERN; 717316643e7SJed Brown PetscStackPush("TS user implicit Jacobian"); 7180910c330SBarry Smith ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,flg,ctx);CHKERRQ(ierr); 719316643e7SJed Brown PetscStackPop; 720214bc6a2SJed Brown /* make sure user returned a correct Jacobian and preconditioner */ 721214bc6a2SJed Brown PetscValidHeaderSpecific(*A,MAT_CLASSID,4); 722214bc6a2SJed Brown PetscValidHeaderSpecific(*B,MAT_CLASSID,5); 7234a6899ffSJed Brown } 724214bc6a2SJed Brown if (imex) { 725b5abc632SBarry Smith if (!ijacobian) { /* system was written as Udot = G(t,U) */ 726214bc6a2SJed Brown ierr = MatZeroEntries(*A);CHKERRQ(ierr); 7272dd45cf8SJed Brown ierr = MatShift(*A,shift);CHKERRQ(ierr); 728214bc6a2SJed Brown if (*A != *B) { 729214bc6a2SJed Brown ierr = MatZeroEntries(*B);CHKERRQ(ierr); 730214bc6a2SJed Brown ierr = MatShift(*B,shift);CHKERRQ(ierr); 731214bc6a2SJed Brown } 732214bc6a2SJed Brown *flg = SAME_PRECONDITIONER; 733214bc6a2SJed Brown } 734214bc6a2SJed Brown } else { 73524989b8cSPeter Brune if (!ijacobian) { 7360910c330SBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,A,B,flg);CHKERRQ(ierr); 737214bc6a2SJed Brown ierr = MatScale(*A,-1);CHKERRQ(ierr); 738214bc6a2SJed Brown ierr = MatShift(*A,shift);CHKERRQ(ierr); 739316643e7SJed Brown if (*A != *B) { 740316643e7SJed Brown ierr = MatScale(*B,-1);CHKERRQ(ierr); 741316643e7SJed Brown ierr = MatShift(*B,shift);CHKERRQ(ierr); 742316643e7SJed Brown } 74324989b8cSPeter Brune } else if (rhsjacobian) { 744214bc6a2SJed Brown Mat Arhs,Brhs; 745214bc6a2SJed Brown MatStructure axpy,flg2 = DIFFERENT_NONZERO_PATTERN; 746214bc6a2SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 7470910c330SBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,&Arhs,&Brhs,&flg2);CHKERRQ(ierr); 748214bc6a2SJed Brown axpy = (*flg == flg2) ? SAME_NONZERO_PATTERN : DIFFERENT_NONZERO_PATTERN; 749214bc6a2SJed Brown ierr = MatAXPY(*A,-1,Arhs,axpy);CHKERRQ(ierr); 750214bc6a2SJed Brown if (*A != *B) { 751214bc6a2SJed Brown ierr = MatAXPY(*B,-1,Brhs,axpy);CHKERRQ(ierr); 752214bc6a2SJed Brown } 753214bc6a2SJed Brown *flg = PetscMin(*flg,flg2); 754214bc6a2SJed Brown } 755316643e7SJed Brown } 7560026cea9SSean Farley 7570026cea9SSean Farley ts->ijacobian.time = t; 7580910c330SBarry Smith ts->ijacobian.X = U; 7590910c330SBarry Smith ts->ijacobian.Xdot = Udot; 760bbd56ea5SKarl Rupp 7610910c330SBarry Smith ierr = PetscObjectStateQuery((PetscObject)U,&ts->ijacobian.Xstate);CHKERRQ(ierr); 7620910c330SBarry Smith ierr = PetscObjectStateQuery((PetscObject)Udot,&ts->ijacobian.Xdotstate);CHKERRQ(ierr); 763bbd56ea5SKarl Rupp 7640026cea9SSean Farley ts->ijacobian.shift = shift; 7650026cea9SSean Farley ts->ijacobian.imex = imex; 7660026cea9SSean Farley ts->ijacobian.mstructure = *flg; 767bbd56ea5SKarl Rupp 7680910c330SBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,*A,*B);CHKERRQ(ierr); 769316643e7SJed Brown PetscFunctionReturn(0); 770316643e7SJed Brown } 771316643e7SJed Brown 772316643e7SJed Brown #undef __FUNCT__ 7734a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction" 774d763cef2SBarry Smith /*@C 775d763cef2SBarry Smith TSSetRHSFunction - Sets the routine for evaluating the function, 776b5abc632SBarry Smith where U_t = G(t,u). 777d763cef2SBarry Smith 7783f9fe445SBarry Smith Logically Collective on TS 779d763cef2SBarry Smith 780d763cef2SBarry Smith Input Parameters: 781d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 7820298fd71SBarry Smith . r - vector to put the computed right hand side (or NULL to have it created) 783d763cef2SBarry Smith . f - routine for evaluating the right-hand-side function 784d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 7850298fd71SBarry Smith function evaluation routine (may be NULL) 786d763cef2SBarry Smith 787d763cef2SBarry Smith Calling sequence of func: 78887828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Vec F,void *ctx); 789d763cef2SBarry Smith 790d763cef2SBarry Smith + t - current timestep 791d763cef2SBarry Smith . u - input vector 792d763cef2SBarry Smith . F - function vector 793d763cef2SBarry Smith - ctx - [optional] user-defined function context 794d763cef2SBarry Smith 795d763cef2SBarry Smith Level: beginner 796d763cef2SBarry Smith 797d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 798d763cef2SBarry Smith 799d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian() 800d763cef2SBarry Smith @*/ 801089b2837SJed Brown PetscErrorCode TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx) 802d763cef2SBarry Smith { 803089b2837SJed Brown PetscErrorCode ierr; 804089b2837SJed Brown SNES snes; 8050298fd71SBarry Smith Vec ralloc = NULL; 80624989b8cSPeter Brune DM dm; 807d763cef2SBarry Smith 808089b2837SJed Brown PetscFunctionBegin; 8090700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 810ca94891dSJed Brown if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 81124989b8cSPeter Brune 81224989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 81324989b8cSPeter Brune ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr); 814089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 815e856ceecSJed Brown if (!r && !ts->dm && ts->vec_sol) { 816e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 817e856ceecSJed Brown r = ralloc; 818e856ceecSJed Brown } 819089b2837SJed Brown ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 820e856ceecSJed Brown ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 821d763cef2SBarry Smith PetscFunctionReturn(0); 822d763cef2SBarry Smith } 823d763cef2SBarry Smith 8244a2ae208SSatish Balay #undef __FUNCT__ 825ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction" 826ef20d060SBarry Smith /*@C 827abd5a294SJed Brown TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE 828ef20d060SBarry Smith 829ef20d060SBarry Smith Logically Collective on TS 830ef20d060SBarry Smith 831ef20d060SBarry Smith Input Parameters: 832ef20d060SBarry Smith + ts - the TS context obtained from TSCreate() 833ef20d060SBarry Smith . f - routine for evaluating the solution 834ef20d060SBarry Smith - ctx - [optional] user-defined context for private data for the 8350298fd71SBarry Smith function evaluation routine (may be NULL) 836ef20d060SBarry Smith 837ef20d060SBarry Smith Calling sequence of func: 838ef20d060SBarry Smith $ func (TS ts,PetscReal t,Vec u,void *ctx); 839ef20d060SBarry Smith 840ef20d060SBarry Smith + t - current timestep 841ef20d060SBarry Smith . u - output vector 842ef20d060SBarry Smith - ctx - [optional] user-defined function context 843ef20d060SBarry Smith 844abd5a294SJed Brown Notes: 845abd5a294SJed Brown This routine is used for testing accuracy of time integration schemes when you already know the solution. 846abd5a294SJed Brown If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to 847abd5a294SJed Brown create closed-form solutions with non-physical forcing terms. 848abd5a294SJed Brown 8494f09c107SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 850abd5a294SJed Brown 851ef20d060SBarry Smith Level: beginner 852ef20d060SBarry Smith 853ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 854ef20d060SBarry Smith 8559b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction() 856ef20d060SBarry Smith @*/ 857ef20d060SBarry Smith PetscErrorCode TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 858ef20d060SBarry Smith { 859ef20d060SBarry Smith PetscErrorCode ierr; 860ef20d060SBarry Smith DM dm; 861ef20d060SBarry Smith 862ef20d060SBarry Smith PetscFunctionBegin; 863ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 864ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 865ef20d060SBarry Smith ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr); 866ef20d060SBarry Smith PetscFunctionReturn(0); 867ef20d060SBarry Smith } 868ef20d060SBarry Smith 869ef20d060SBarry Smith #undef __FUNCT__ 8709b7cd975SBarry Smith #define __FUNCT__ "TSSetForcingFunction" 8719b7cd975SBarry Smith /*@C 8729b7cd975SBarry Smith TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE 8739b7cd975SBarry Smith 8749b7cd975SBarry Smith Logically Collective on TS 8759b7cd975SBarry Smith 8769b7cd975SBarry Smith Input Parameters: 8779b7cd975SBarry Smith + ts - the TS context obtained from TSCreate() 8789b7cd975SBarry Smith . f - routine for evaluating the forcing function 8799b7cd975SBarry Smith - ctx - [optional] user-defined context for private data for the 8800298fd71SBarry Smith function evaluation routine (may be NULL) 8819b7cd975SBarry Smith 8829b7cd975SBarry Smith Calling sequence of func: 8839b7cd975SBarry Smith $ func (TS ts,PetscReal t,Vec u,void *ctx); 8849b7cd975SBarry Smith 8859b7cd975SBarry Smith + t - current timestep 8869b7cd975SBarry Smith . u - output vector 8879b7cd975SBarry Smith - ctx - [optional] user-defined function context 8889b7cd975SBarry Smith 8899b7cd975SBarry Smith Notes: 8909b7cd975SBarry Smith This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to 8919b7cd975SBarry Smith create closed-form solutions with a non-physical forcing term. 8929b7cd975SBarry Smith 8939b7cd975SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 8949b7cd975SBarry Smith 8959b7cd975SBarry Smith Level: beginner 8969b7cd975SBarry Smith 8979b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 8989b7cd975SBarry Smith 8999b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction() 9009b7cd975SBarry Smith @*/ 9019b7cd975SBarry Smith PetscErrorCode TSSetForcingFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 9029b7cd975SBarry Smith { 9039b7cd975SBarry Smith PetscErrorCode ierr; 9049b7cd975SBarry Smith DM dm; 9059b7cd975SBarry Smith 9069b7cd975SBarry Smith PetscFunctionBegin; 9079b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 9089b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 9099b7cd975SBarry Smith ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr); 9109b7cd975SBarry Smith PetscFunctionReturn(0); 9119b7cd975SBarry Smith } 9129b7cd975SBarry Smith 9139b7cd975SBarry Smith #undef __FUNCT__ 9144a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian" 915d763cef2SBarry Smith /*@C 916d763cef2SBarry Smith TSSetRHSJacobian - Sets the function to compute the Jacobian of F, 917b5abc632SBarry Smith where U_t = G(U,t), as well as the location to store the matrix. 918d763cef2SBarry Smith 9193f9fe445SBarry Smith Logically Collective on TS 920d763cef2SBarry Smith 921d763cef2SBarry Smith Input Parameters: 922d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 923*e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 924*e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 925d763cef2SBarry Smith . f - the Jacobian evaluation routine 926d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 9270298fd71SBarry Smith Jacobian evaluation routine (may be NULL) 928d763cef2SBarry Smith 929d763cef2SBarry Smith Calling sequence of func: 93087828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Mat *A,Mat *B,MatStructure *flag,void *ctx); 931d763cef2SBarry Smith 932d763cef2SBarry Smith + t - current timestep 933d763cef2SBarry Smith . u - input vector 934*e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 935*e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 936d763cef2SBarry Smith . flag - flag indicating information about the preconditioner matrix 93794b7f48cSBarry Smith structure (same as flag in KSPSetOperators()) 938d763cef2SBarry Smith - ctx - [optional] user-defined context for matrix evaluation routine 939d763cef2SBarry Smith 940d763cef2SBarry Smith Notes: 94194b7f48cSBarry Smith See KSPSetOperators() for important information about setting the flag 942d763cef2SBarry Smith output parameter in the routine func(). Be sure to read this information! 943d763cef2SBarry Smith 944d763cef2SBarry Smith The routine func() takes Mat * as the matrix arguments rather than Mat. 945d763cef2SBarry Smith This allows the matrix evaluation routine to replace A and/or B with a 94656335db2SHong Zhang completely new matrix structure (not just different matrix elements) 947d763cef2SBarry Smith when appropriate, for instance, if the nonzero structure is changing 948d763cef2SBarry Smith throughout the global iterations. 949d763cef2SBarry Smith 950d763cef2SBarry Smith Level: beginner 951d763cef2SBarry Smith 952d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian 953d763cef2SBarry Smith 9548d359177SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction() 955d763cef2SBarry Smith 956d763cef2SBarry Smith @*/ 957*e5d3d808SBarry Smith PetscErrorCode TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx) 958d763cef2SBarry Smith { 959277b19d0SLisandro Dalcin PetscErrorCode ierr; 960089b2837SJed Brown SNES snes; 96124989b8cSPeter Brune DM dm; 96224989b8cSPeter Brune TSIJacobian ijacobian; 963277b19d0SLisandro Dalcin 964d763cef2SBarry Smith PetscFunctionBegin; 9650700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 966*e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 967*e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 968*e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 969*e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 970d763cef2SBarry Smith 97124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 97224989b8cSPeter Brune ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr); 9730298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr); 97424989b8cSPeter Brune 975089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 9765f659677SPeter Brune if (!ijacobian) { 977*e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 9780e4ef248SJed Brown } 979*e5d3d808SBarry Smith if (Amat) { 980*e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 9810e4ef248SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 982bbd56ea5SKarl Rupp 983*e5d3d808SBarry Smith ts->Arhs = Amat; 9840e4ef248SJed Brown } 985*e5d3d808SBarry Smith if (Pmat) { 986*e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr); 9870e4ef248SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 988bbd56ea5SKarl Rupp 989*e5d3d808SBarry Smith ts->Brhs = Pmat; 9900e4ef248SJed Brown } 991d763cef2SBarry Smith PetscFunctionReturn(0); 992d763cef2SBarry Smith } 993d763cef2SBarry Smith 994316643e7SJed Brown 995316643e7SJed Brown #undef __FUNCT__ 996316643e7SJed Brown #define __FUNCT__ "TSSetIFunction" 997316643e7SJed Brown /*@C 998b5abc632SBarry Smith TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved. 999316643e7SJed Brown 10003f9fe445SBarry Smith Logically Collective on TS 1001316643e7SJed Brown 1002316643e7SJed Brown Input Parameters: 1003316643e7SJed Brown + ts - the TS context obtained from TSCreate() 10040298fd71SBarry Smith . r - vector to hold the residual (or NULL to have it created internally) 1005316643e7SJed Brown . f - the function evaluation routine 10060298fd71SBarry Smith - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1007316643e7SJed Brown 1008316643e7SJed Brown Calling sequence of f: 1009316643e7SJed Brown $ f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx); 1010316643e7SJed Brown 1011316643e7SJed Brown + t - time at step/stage being solved 1012316643e7SJed Brown . u - state vector 1013316643e7SJed Brown . u_t - time derivative of state vector 1014316643e7SJed Brown . F - function vector 1015316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1016316643e7SJed Brown 1017316643e7SJed Brown Important: 1018d6cbdb99SBarry Smith The user MUST call either this routine, TSSetRHSFunction(). This routine must be used when not solving an ODE, for example a DAE. 1019316643e7SJed Brown 1020316643e7SJed Brown Level: beginner 1021316643e7SJed Brown 1022316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian 1023316643e7SJed Brown 1024d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian() 1025316643e7SJed Brown @*/ 1026089b2837SJed Brown PetscErrorCode TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx) 1027316643e7SJed Brown { 1028089b2837SJed Brown PetscErrorCode ierr; 1029089b2837SJed Brown SNES snes; 10300298fd71SBarry Smith Vec resalloc = NULL; 103124989b8cSPeter Brune DM dm; 1032316643e7SJed Brown 1033316643e7SJed Brown PetscFunctionBegin; 10340700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1035ca94891dSJed Brown if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2); 103624989b8cSPeter Brune 103724989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 103824989b8cSPeter Brune ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr); 103924989b8cSPeter Brune 1040089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1041e856ceecSJed Brown if (!res && !ts->dm && ts->vec_sol) { 1042e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr); 1043e856ceecSJed Brown res = resalloc; 1044e856ceecSJed Brown } 1045089b2837SJed Brown ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr); 1046e856ceecSJed Brown ierr = VecDestroy(&resalloc);CHKERRQ(ierr); 1047089b2837SJed Brown PetscFunctionReturn(0); 1048089b2837SJed Brown } 1049089b2837SJed Brown 1050089b2837SJed Brown #undef __FUNCT__ 1051089b2837SJed Brown #define __FUNCT__ "TSGetIFunction" 1052089b2837SJed Brown /*@C 1053089b2837SJed Brown TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1054089b2837SJed Brown 1055089b2837SJed Brown Not Collective 1056089b2837SJed Brown 1057089b2837SJed Brown Input Parameter: 1058089b2837SJed Brown . ts - the TS context 1059089b2837SJed Brown 1060089b2837SJed Brown Output Parameter: 10610298fd71SBarry Smith + r - vector to hold residual (or NULL) 10620298fd71SBarry Smith . func - the function to compute residual (or NULL) 10630298fd71SBarry Smith - ctx - the function context (or NULL) 1064089b2837SJed Brown 1065089b2837SJed Brown Level: advanced 1066089b2837SJed Brown 1067089b2837SJed Brown .keywords: TS, nonlinear, get, function 1068089b2837SJed Brown 1069089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction() 1070089b2837SJed Brown @*/ 1071089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx) 1072089b2837SJed Brown { 1073089b2837SJed Brown PetscErrorCode ierr; 1074089b2837SJed Brown SNES snes; 107524989b8cSPeter Brune DM dm; 1076089b2837SJed Brown 1077089b2837SJed Brown PetscFunctionBegin; 1078089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1079089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 10800298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 108124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 108224989b8cSPeter Brune ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr); 1083089b2837SJed Brown PetscFunctionReturn(0); 1084089b2837SJed Brown } 1085089b2837SJed Brown 1086089b2837SJed Brown #undef __FUNCT__ 1087089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction" 1088089b2837SJed Brown /*@C 1089089b2837SJed Brown TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it. 1090089b2837SJed Brown 1091089b2837SJed Brown Not Collective 1092089b2837SJed Brown 1093089b2837SJed Brown Input Parameter: 1094089b2837SJed Brown . ts - the TS context 1095089b2837SJed Brown 1096089b2837SJed Brown Output Parameter: 10970298fd71SBarry Smith + r - vector to hold computed right hand side (or NULL) 10980298fd71SBarry Smith . func - the function to compute right hand side (or NULL) 10990298fd71SBarry Smith - ctx - the function context (or NULL) 1100089b2837SJed Brown 1101089b2837SJed Brown Level: advanced 1102089b2837SJed Brown 1103089b2837SJed Brown .keywords: TS, nonlinear, get, function 1104089b2837SJed Brown 1105089b2837SJed Brown .seealso: TSSetRhsfunction(), SNESGetFunction() 1106089b2837SJed Brown @*/ 1107089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx) 1108089b2837SJed Brown { 1109089b2837SJed Brown PetscErrorCode ierr; 1110089b2837SJed Brown SNES snes; 111124989b8cSPeter Brune DM dm; 1112089b2837SJed Brown 1113089b2837SJed Brown PetscFunctionBegin; 1114089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1115089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 11160298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 111724989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 111824989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr); 1119316643e7SJed Brown PetscFunctionReturn(0); 1120316643e7SJed Brown } 1121316643e7SJed Brown 1122316643e7SJed Brown #undef __FUNCT__ 1123316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian" 1124316643e7SJed Brown /*@C 1125a4f0a591SBarry Smith TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function 1126a4f0a591SBarry Smith you provided with TSSetIFunction(). 1127316643e7SJed Brown 11283f9fe445SBarry Smith Logically Collective on TS 1129316643e7SJed Brown 1130316643e7SJed Brown Input Parameters: 1131316643e7SJed Brown + ts - the TS context obtained from TSCreate() 1132*e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1133*e5d3d808SBarry Smith . Pmat - matrix used to compute preconditioner (usually the same as Amat) 1134316643e7SJed Brown . f - the Jacobian evaluation routine 11350298fd71SBarry Smith - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1136316643e7SJed Brown 1137316643e7SJed Brown Calling sequence of f: 1138*e5d3d808SBarry Smith $ f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat *Amat,Mat *Pmat,MatStructure *flag,void *ctx); 1139316643e7SJed Brown 1140316643e7SJed Brown + t - time at step/stage being solved 11411b4a444bSJed Brown . U - state vector 11421b4a444bSJed Brown . U_t - time derivative of state vector 1143316643e7SJed Brown . a - shift 1144*e5d3d808SBarry Smith . Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t 1145*e5d3d808SBarry Smith . Pmat - matrix used for constructing preconditioner, usually the same as Amat 1146316643e7SJed Brown . flag - flag indicating information about the preconditioner matrix 1147316643e7SJed Brown structure (same as flag in KSPSetOperators()) 1148316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1149316643e7SJed Brown 1150316643e7SJed Brown Notes: 1151*e5d3d808SBarry Smith The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve. 1152316643e7SJed Brown 1153a4f0a591SBarry Smith The matrix dF/dU + a*dF/dU_t you provide turns out to be 1154b5abc632SBarry Smith the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved. 1155a4f0a591SBarry Smith The time integrator internally approximates U_t by W+a*U where the positive "shift" 1156a4f0a591SBarry Smith a and vector W depend on the integration method, step size, and past states. For example with 1157a4f0a591SBarry Smith the backward Euler method a = 1/dt and W = -a*U(previous timestep) so 1158a4f0a591SBarry Smith W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt 1159a4f0a591SBarry Smith 1160316643e7SJed Brown Level: beginner 1161316643e7SJed Brown 1162316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian 1163316643e7SJed Brown 11648d359177SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault() 1165316643e7SJed Brown 1166316643e7SJed Brown @*/ 1167*e5d3d808SBarry Smith PetscErrorCode TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx) 1168316643e7SJed Brown { 1169316643e7SJed Brown PetscErrorCode ierr; 1170089b2837SJed Brown SNES snes; 117124989b8cSPeter Brune DM dm; 1172316643e7SJed Brown 1173316643e7SJed Brown PetscFunctionBegin; 11740700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1175*e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1176*e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1177*e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1178*e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 117924989b8cSPeter Brune 118024989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 118124989b8cSPeter Brune ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr); 118224989b8cSPeter Brune 1183089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1184*e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1185316643e7SJed Brown PetscFunctionReturn(0); 1186316643e7SJed Brown } 1187316643e7SJed Brown 11884a2ae208SSatish Balay #undef __FUNCT__ 118955849f57SBarry Smith #define __FUNCT__ "TSLoad" 119055849f57SBarry Smith /*@C 119155849f57SBarry Smith TSLoad - Loads a KSP that has been stored in binary with KSPView(). 119255849f57SBarry Smith 119355849f57SBarry Smith Collective on PetscViewer 119455849f57SBarry Smith 119555849f57SBarry Smith Input Parameters: 119655849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or 119755849f57SBarry Smith some related function before a call to TSLoad(). 119855849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() 119955849f57SBarry Smith 120055849f57SBarry Smith Level: intermediate 120155849f57SBarry Smith 120255849f57SBarry Smith Notes: 120355849f57SBarry Smith The type is determined by the data in the file, any type set into the TS before this call is ignored. 120455849f57SBarry Smith 120555849f57SBarry Smith Notes for advanced users: 120655849f57SBarry Smith Most users should not need to know the details of the binary storage 120755849f57SBarry Smith format, since TSLoad() and TSView() completely hide these details. 120855849f57SBarry Smith But for anyone who's interested, the standard binary matrix storage 120955849f57SBarry Smith format is 121055849f57SBarry Smith .vb 121155849f57SBarry Smith has not yet been determined 121255849f57SBarry Smith .ve 121355849f57SBarry Smith 121455849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad() 121555849f57SBarry Smith @*/ 1216f2c2a1b9SBarry Smith PetscErrorCode TSLoad(TS ts, PetscViewer viewer) 121755849f57SBarry Smith { 121855849f57SBarry Smith PetscErrorCode ierr; 121955849f57SBarry Smith PetscBool isbinary; 122055849f57SBarry Smith PetscInt classid; 122155849f57SBarry Smith char type[256]; 12222d53ad75SBarry Smith DMTS sdm; 1223ad6bc421SBarry Smith DM dm; 122455849f57SBarry Smith 122555849f57SBarry Smith PetscFunctionBegin; 1226f2c2a1b9SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 122755849f57SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 122855849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 122955849f57SBarry Smith if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()"); 123055849f57SBarry Smith 123155849f57SBarry Smith ierr = PetscViewerBinaryRead(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr); 1232ce94432eSBarry Smith if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file"); 123355849f57SBarry Smith ierr = PetscViewerBinaryRead(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr); 1234f2c2a1b9SBarry Smith ierr = TSSetType(ts, type);CHKERRQ(ierr); 1235f2c2a1b9SBarry Smith if (ts->ops->load) { 1236f2c2a1b9SBarry Smith ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr); 1237f2c2a1b9SBarry Smith } 1238ce94432eSBarry Smith ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr); 1239ad6bc421SBarry Smith ierr = DMLoad(dm,viewer);CHKERRQ(ierr); 1240ad6bc421SBarry Smith ierr = TSSetDM(ts,dm);CHKERRQ(ierr); 1241f2c2a1b9SBarry Smith ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr); 1242f2c2a1b9SBarry Smith ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr); 12432d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 12442d53ad75SBarry Smith ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr); 124555849f57SBarry Smith PetscFunctionReturn(0); 124655849f57SBarry Smith } 124755849f57SBarry Smith 12489804daf3SBarry Smith #include <petscdraw.h> 124955849f57SBarry Smith #undef __FUNCT__ 12504a2ae208SSatish Balay #define __FUNCT__ "TSView" 12517e2c5f70SBarry Smith /*@C 1252d763cef2SBarry Smith TSView - Prints the TS data structure. 1253d763cef2SBarry Smith 12544c49b128SBarry Smith Collective on TS 1255d763cef2SBarry Smith 1256d763cef2SBarry Smith Input Parameters: 1257d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1258d763cef2SBarry Smith - viewer - visualization context 1259d763cef2SBarry Smith 1260d763cef2SBarry Smith Options Database Key: 1261d763cef2SBarry Smith . -ts_view - calls TSView() at end of TSStep() 1262d763cef2SBarry Smith 1263d763cef2SBarry Smith Notes: 1264d763cef2SBarry Smith The available visualization contexts include 1265b0a32e0cSBarry Smith + PETSC_VIEWER_STDOUT_SELF - standard output (default) 1266b0a32e0cSBarry Smith - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 1267d763cef2SBarry Smith output where only the first processor opens 1268d763cef2SBarry Smith the file. All other processors send their 1269d763cef2SBarry Smith data to the first processor to print. 1270d763cef2SBarry Smith 1271d763cef2SBarry Smith The user can open an alternative visualization context with 1272b0a32e0cSBarry Smith PetscViewerASCIIOpen() - output to a specified file. 1273d763cef2SBarry Smith 1274d763cef2SBarry Smith Level: beginner 1275d763cef2SBarry Smith 1276d763cef2SBarry Smith .keywords: TS, timestep, view 1277d763cef2SBarry Smith 1278b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen() 1279d763cef2SBarry Smith @*/ 12807087cfbeSBarry Smith PetscErrorCode TSView(TS ts,PetscViewer viewer) 1281d763cef2SBarry Smith { 1282dfbe8321SBarry Smith PetscErrorCode ierr; 128319fd82e9SBarry Smith TSType type; 12842b0a91c0SBarry Smith PetscBool iascii,isstring,isundials,isbinary,isdraw; 12852d53ad75SBarry Smith DMTS sdm; 1286d763cef2SBarry Smith 1287d763cef2SBarry Smith PetscFunctionBegin; 12880700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 12893050cee2SBarry Smith if (!viewer) { 1290ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr); 12913050cee2SBarry Smith } 12920700a824SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1293c9780b6fSBarry Smith PetscCheckSameComm(ts,1,viewer,2); 1294fd16b177SBarry Smith 1295251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1296251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 129755849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 12982b0a91c0SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 129932077d6dSBarry Smith if (iascii) { 1300317d6ea6SBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer,"TS Object");CHKERRQ(ierr); 130177431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr); 1302a83599f4SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum time=%G\n",ts->max_time);CHKERRQ(ierr); 1303d763cef2SBarry Smith if (ts->problem_type == TS_NONLINEAR) { 13045ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr); 1305c610991cSLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr); 1306d763cef2SBarry Smith } 13075ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr); 1308193ac0bcSJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr); 13092d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 13102d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 1311d52bd9f3SBarry Smith if (ts->ops->view) { 1312d52bd9f3SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1313d52bd9f3SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1314d52bd9f3SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1315d52bd9f3SBarry Smith } 13160f5bd95cSBarry Smith } else if (isstring) { 1317a313700dSBarry Smith ierr = TSGetType(ts,&type);CHKERRQ(ierr); 1318b0a32e0cSBarry Smith ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr); 131955849f57SBarry Smith } else if (isbinary) { 132055849f57SBarry Smith PetscInt classid = TS_FILE_CLASSID; 132155849f57SBarry Smith MPI_Comm comm; 132255849f57SBarry Smith PetscMPIInt rank; 132355849f57SBarry Smith char type[256]; 132455849f57SBarry Smith 132555849f57SBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 132655849f57SBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 132755849f57SBarry Smith if (!rank) { 132855849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 132955849f57SBarry Smith ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr); 133055849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 133155849f57SBarry Smith } 133255849f57SBarry Smith if (ts->ops->view) { 133355849f57SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 133455849f57SBarry Smith } 1335f2c2a1b9SBarry Smith ierr = DMView(ts->dm,viewer);CHKERRQ(ierr); 1336f2c2a1b9SBarry Smith ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr); 13372d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 13382d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 13392b0a91c0SBarry Smith } else if (isdraw) { 13402b0a91c0SBarry Smith PetscDraw draw; 13412b0a91c0SBarry Smith char str[36]; 134289fd9fafSBarry Smith PetscReal x,y,bottom,h; 13432b0a91c0SBarry Smith 13442b0a91c0SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 13452b0a91c0SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 13462b0a91c0SBarry Smith ierr = PetscStrcpy(str,"TS: ");CHKERRQ(ierr); 13472b0a91c0SBarry Smith ierr = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr); 13480298fd71SBarry Smith ierr = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 134989fd9fafSBarry Smith bottom = y - h; 13502b0a91c0SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 13512b0a91c0SBarry Smith if (ts->ops->view) { 13522b0a91c0SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 13532b0a91c0SBarry Smith } 13542b0a91c0SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 1355d763cef2SBarry Smith } 1356b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1357251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr); 1358b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1359d763cef2SBarry Smith PetscFunctionReturn(0); 1360d763cef2SBarry Smith } 1361d763cef2SBarry Smith 1362d763cef2SBarry Smith 13634a2ae208SSatish Balay #undef __FUNCT__ 13644a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext" 1365b07ff414SBarry Smith /*@ 1366d763cef2SBarry Smith TSSetApplicationContext - Sets an optional user-defined context for 1367d763cef2SBarry Smith the timesteppers. 1368d763cef2SBarry Smith 13693f9fe445SBarry Smith Logically Collective on TS 1370d763cef2SBarry Smith 1371d763cef2SBarry Smith Input Parameters: 1372d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1373d763cef2SBarry Smith - usrP - optional user context 1374d763cef2SBarry Smith 1375d763cef2SBarry Smith Level: intermediate 1376d763cef2SBarry Smith 1377d763cef2SBarry Smith .keywords: TS, timestep, set, application, context 1378d763cef2SBarry Smith 1379d763cef2SBarry Smith .seealso: TSGetApplicationContext() 1380d763cef2SBarry Smith @*/ 13817087cfbeSBarry Smith PetscErrorCode TSSetApplicationContext(TS ts,void *usrP) 1382d763cef2SBarry Smith { 1383d763cef2SBarry Smith PetscFunctionBegin; 13840700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1385d763cef2SBarry Smith ts->user = usrP; 1386d763cef2SBarry Smith PetscFunctionReturn(0); 1387d763cef2SBarry Smith } 1388d763cef2SBarry Smith 13894a2ae208SSatish Balay #undef __FUNCT__ 13904a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext" 1391b07ff414SBarry Smith /*@ 1392d763cef2SBarry Smith TSGetApplicationContext - Gets the user-defined context for the 1393d763cef2SBarry Smith timestepper. 1394d763cef2SBarry Smith 1395d763cef2SBarry Smith Not Collective 1396d763cef2SBarry Smith 1397d763cef2SBarry Smith Input Parameter: 1398d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1399d763cef2SBarry Smith 1400d763cef2SBarry Smith Output Parameter: 1401d763cef2SBarry Smith . usrP - user context 1402d763cef2SBarry Smith 1403d763cef2SBarry Smith Level: intermediate 1404d763cef2SBarry Smith 1405d763cef2SBarry Smith .keywords: TS, timestep, get, application, context 1406d763cef2SBarry Smith 1407d763cef2SBarry Smith .seealso: TSSetApplicationContext() 1408d763cef2SBarry Smith @*/ 1409e71120c6SJed Brown PetscErrorCode TSGetApplicationContext(TS ts,void *usrP) 1410d763cef2SBarry Smith { 1411d763cef2SBarry Smith PetscFunctionBegin; 14120700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1413e71120c6SJed Brown *(void**)usrP = ts->user; 1414d763cef2SBarry Smith PetscFunctionReturn(0); 1415d763cef2SBarry Smith } 1416d763cef2SBarry Smith 14174a2ae208SSatish Balay #undef __FUNCT__ 14184a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber" 1419d763cef2SBarry Smith /*@ 1420b8123daeSJed Brown TSGetTimeStepNumber - Gets the number of time steps completed. 1421d763cef2SBarry Smith 1422d763cef2SBarry Smith Not Collective 1423d763cef2SBarry Smith 1424d763cef2SBarry Smith Input Parameter: 1425d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1426d763cef2SBarry Smith 1427d763cef2SBarry Smith Output Parameter: 1428b8123daeSJed Brown . iter - number of steps completed so far 1429d763cef2SBarry Smith 1430d763cef2SBarry Smith Level: intermediate 1431d763cef2SBarry Smith 1432d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number 1433b8123daeSJed Brown .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStep() 1434d763cef2SBarry Smith @*/ 14357087cfbeSBarry Smith PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *iter) 1436d763cef2SBarry Smith { 1437d763cef2SBarry Smith PetscFunctionBegin; 14380700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 14394482741eSBarry Smith PetscValidIntPointer(iter,2); 1440d763cef2SBarry Smith *iter = ts->steps; 1441d763cef2SBarry Smith PetscFunctionReturn(0); 1442d763cef2SBarry Smith } 1443d763cef2SBarry Smith 14444a2ae208SSatish Balay #undef __FUNCT__ 14454a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep" 1446d763cef2SBarry Smith /*@ 1447d763cef2SBarry Smith TSSetInitialTimeStep - Sets the initial timestep to be used, 1448d763cef2SBarry Smith as well as the initial time. 1449d763cef2SBarry Smith 14503f9fe445SBarry Smith Logically Collective on TS 1451d763cef2SBarry Smith 1452d763cef2SBarry Smith Input Parameters: 1453d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1454d763cef2SBarry Smith . initial_time - the initial time 1455d763cef2SBarry Smith - time_step - the size of the timestep 1456d763cef2SBarry Smith 1457d763cef2SBarry Smith Level: intermediate 1458d763cef2SBarry Smith 1459d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep() 1460d763cef2SBarry Smith 1461d763cef2SBarry Smith .keywords: TS, set, initial, timestep 1462d763cef2SBarry Smith @*/ 14637087cfbeSBarry Smith PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step) 1464d763cef2SBarry Smith { 1465e144a568SJed Brown PetscErrorCode ierr; 1466e144a568SJed Brown 1467d763cef2SBarry Smith PetscFunctionBegin; 14680700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1469e144a568SJed Brown ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 1470d8cd7023SBarry Smith ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr); 1471d763cef2SBarry Smith PetscFunctionReturn(0); 1472d763cef2SBarry Smith } 1473d763cef2SBarry Smith 14744a2ae208SSatish Balay #undef __FUNCT__ 14754a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep" 1476d763cef2SBarry Smith /*@ 1477d763cef2SBarry Smith TSSetTimeStep - Allows one to reset the timestep at any time, 1478d763cef2SBarry Smith useful for simple pseudo-timestepping codes. 1479d763cef2SBarry Smith 14803f9fe445SBarry Smith Logically Collective on TS 1481d763cef2SBarry Smith 1482d763cef2SBarry Smith Input Parameters: 1483d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1484d763cef2SBarry Smith - time_step - the size of the timestep 1485d763cef2SBarry Smith 1486d763cef2SBarry Smith Level: intermediate 1487d763cef2SBarry Smith 1488d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1489d763cef2SBarry Smith 1490d763cef2SBarry Smith .keywords: TS, set, timestep 1491d763cef2SBarry Smith @*/ 14927087cfbeSBarry Smith PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step) 1493d763cef2SBarry Smith { 1494d763cef2SBarry Smith PetscFunctionBegin; 14950700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1496c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,time_step,2); 1497d763cef2SBarry Smith ts->time_step = time_step; 149831748224SBarry Smith ts->time_step_orig = time_step; 1499d763cef2SBarry Smith PetscFunctionReturn(0); 1500d763cef2SBarry Smith } 1501d763cef2SBarry Smith 15024a2ae208SSatish Balay #undef __FUNCT__ 1503a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime" 1504a43b19c4SJed Brown /*@ 150549354f04SShri Abhyankar TSSetExactFinalTime - Determines whether to adapt the final time step to 150649354f04SShri Abhyankar match the exact final time, interpolate solution to the exact final time, 150749354f04SShri Abhyankar or just return at the final time TS computed. 1508a43b19c4SJed Brown 1509a43b19c4SJed Brown Logically Collective on TS 1510a43b19c4SJed Brown 1511a43b19c4SJed Brown Input Parameter: 1512a43b19c4SJed Brown + ts - the time-step context 151349354f04SShri Abhyankar - eftopt - exact final time option 1514a43b19c4SJed Brown 1515a43b19c4SJed Brown Level: beginner 1516a43b19c4SJed Brown 1517a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption 1518a43b19c4SJed Brown @*/ 151949354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt) 1520a43b19c4SJed Brown { 1521a43b19c4SJed Brown PetscFunctionBegin; 1522a43b19c4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 152349354f04SShri Abhyankar PetscValidLogicalCollectiveEnum(ts,eftopt,2); 152449354f04SShri Abhyankar ts->exact_final_time = eftopt; 1525a43b19c4SJed Brown PetscFunctionReturn(0); 1526a43b19c4SJed Brown } 1527a43b19c4SJed Brown 1528a43b19c4SJed Brown #undef __FUNCT__ 15294a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep" 1530d763cef2SBarry Smith /*@ 1531d763cef2SBarry Smith TSGetTimeStep - Gets the current timestep size. 1532d763cef2SBarry Smith 1533d763cef2SBarry Smith Not Collective 1534d763cef2SBarry Smith 1535d763cef2SBarry Smith Input Parameter: 1536d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1537d763cef2SBarry Smith 1538d763cef2SBarry Smith Output Parameter: 1539d763cef2SBarry Smith . dt - the current timestep size 1540d763cef2SBarry Smith 1541d763cef2SBarry Smith Level: intermediate 1542d763cef2SBarry Smith 1543d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1544d763cef2SBarry Smith 1545d763cef2SBarry Smith .keywords: TS, get, timestep 1546d763cef2SBarry Smith @*/ 15477087cfbeSBarry Smith PetscErrorCode TSGetTimeStep(TS ts,PetscReal *dt) 1548d763cef2SBarry Smith { 1549d763cef2SBarry Smith PetscFunctionBegin; 15500700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1551f7cf8827SBarry Smith PetscValidRealPointer(dt,2); 1552d763cef2SBarry Smith *dt = ts->time_step; 1553d763cef2SBarry Smith PetscFunctionReturn(0); 1554d763cef2SBarry Smith } 1555d763cef2SBarry Smith 15564a2ae208SSatish Balay #undef __FUNCT__ 15574a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution" 1558d8e5e3e6SSatish Balay /*@ 1559d763cef2SBarry Smith TSGetSolution - Returns the solution at the present timestep. It 1560d763cef2SBarry Smith is valid to call this routine inside the function that you are evaluating 1561d763cef2SBarry Smith in order to move to the new timestep. This vector not changed until 1562d763cef2SBarry Smith the solution at the next timestep has been calculated. 1563d763cef2SBarry Smith 1564d763cef2SBarry Smith Not Collective, but Vec returned is parallel if TS is parallel 1565d763cef2SBarry Smith 1566d763cef2SBarry Smith Input Parameter: 1567d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1568d763cef2SBarry Smith 1569d763cef2SBarry Smith Output Parameter: 1570d763cef2SBarry Smith . v - the vector containing the solution 1571d763cef2SBarry Smith 1572d763cef2SBarry Smith Level: intermediate 1573d763cef2SBarry Smith 1574d763cef2SBarry Smith .seealso: TSGetTimeStep() 1575d763cef2SBarry Smith 1576d763cef2SBarry Smith .keywords: TS, timestep, get, solution 1577d763cef2SBarry Smith @*/ 15787087cfbeSBarry Smith PetscErrorCode TSGetSolution(TS ts,Vec *v) 1579d763cef2SBarry Smith { 1580d763cef2SBarry Smith PetscFunctionBegin; 15810700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 15824482741eSBarry Smith PetscValidPointer(v,2); 15838737fe31SLisandro Dalcin *v = ts->vec_sol; 1584d763cef2SBarry Smith PetscFunctionReturn(0); 1585d763cef2SBarry Smith } 1586d763cef2SBarry Smith 1587bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */ 15884a2ae208SSatish Balay #undef __FUNCT__ 1589bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType" 1590d8e5e3e6SSatish Balay /*@ 1591bdad233fSMatthew Knepley TSSetProblemType - Sets the type of problem to be solved. 1592d763cef2SBarry Smith 1593bdad233fSMatthew Knepley Not collective 1594d763cef2SBarry Smith 1595bdad233fSMatthew Knepley Input Parameters: 1596bdad233fSMatthew Knepley + ts - The TS 1597bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 1598d763cef2SBarry Smith .vb 15990910c330SBarry Smith U_t - A U = 0 (linear) 16000910c330SBarry Smith U_t - A(t) U = 0 (linear) 16010910c330SBarry Smith F(t,U,U_t) = 0 (nonlinear) 1602d763cef2SBarry Smith .ve 1603d763cef2SBarry Smith 1604d763cef2SBarry Smith Level: beginner 1605d763cef2SBarry Smith 1606bdad233fSMatthew Knepley .keywords: TS, problem type 1607bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 1608d763cef2SBarry Smith @*/ 16097087cfbeSBarry Smith PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 1610a7cc72afSBarry Smith { 16119e2a6581SJed Brown PetscErrorCode ierr; 16129e2a6581SJed Brown 1613d763cef2SBarry Smith PetscFunctionBegin; 16140700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1615bdad233fSMatthew Knepley ts->problem_type = type; 16169e2a6581SJed Brown if (type == TS_LINEAR) { 16179e2a6581SJed Brown SNES snes; 16189e2a6581SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 16199e2a6581SJed Brown ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr); 16209e2a6581SJed Brown } 1621d763cef2SBarry Smith PetscFunctionReturn(0); 1622d763cef2SBarry Smith } 1623d763cef2SBarry Smith 1624bdad233fSMatthew Knepley #undef __FUNCT__ 1625bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType" 1626bdad233fSMatthew Knepley /*@C 1627bdad233fSMatthew Knepley TSGetProblemType - Gets the type of problem to be solved. 1628bdad233fSMatthew Knepley 1629bdad233fSMatthew Knepley Not collective 1630bdad233fSMatthew Knepley 1631bdad233fSMatthew Knepley Input Parameter: 1632bdad233fSMatthew Knepley . ts - The TS 1633bdad233fSMatthew Knepley 1634bdad233fSMatthew Knepley Output Parameter: 1635bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 1636bdad233fSMatthew Knepley .vb 1637089b2837SJed Brown M U_t = A U 1638089b2837SJed Brown M(t) U_t = A(t) U 1639b5abc632SBarry Smith F(t,U,U_t) 1640bdad233fSMatthew Knepley .ve 1641bdad233fSMatthew Knepley 1642bdad233fSMatthew Knepley Level: beginner 1643bdad233fSMatthew Knepley 1644bdad233fSMatthew Knepley .keywords: TS, problem type 1645bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 1646bdad233fSMatthew Knepley @*/ 16477087cfbeSBarry Smith PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 1648a7cc72afSBarry Smith { 1649bdad233fSMatthew Knepley PetscFunctionBegin; 16500700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 16514482741eSBarry Smith PetscValidIntPointer(type,2); 1652bdad233fSMatthew Knepley *type = ts->problem_type; 1653bdad233fSMatthew Knepley PetscFunctionReturn(0); 1654bdad233fSMatthew Knepley } 1655d763cef2SBarry Smith 16564a2ae208SSatish Balay #undef __FUNCT__ 16574a2ae208SSatish Balay #define __FUNCT__ "TSSetUp" 1658d763cef2SBarry Smith /*@ 1659d763cef2SBarry Smith TSSetUp - Sets up the internal data structures for the later use 1660d763cef2SBarry Smith of a timestepper. 1661d763cef2SBarry Smith 1662d763cef2SBarry Smith Collective on TS 1663d763cef2SBarry Smith 1664d763cef2SBarry Smith Input Parameter: 1665d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1666d763cef2SBarry Smith 1667d763cef2SBarry Smith Notes: 1668d763cef2SBarry Smith For basic use of the TS solvers the user need not explicitly call 1669d763cef2SBarry Smith TSSetUp(), since these actions will automatically occur during 1670d763cef2SBarry Smith the call to TSStep(). However, if one wishes to control this 1671d763cef2SBarry Smith phase separately, TSSetUp() should be called after TSCreate() 1672d763cef2SBarry Smith and optional routines of the form TSSetXXX(), but before TSStep(). 1673d763cef2SBarry Smith 1674d763cef2SBarry Smith Level: advanced 1675d763cef2SBarry Smith 1676d763cef2SBarry Smith .keywords: TS, timestep, setup 1677d763cef2SBarry Smith 1678d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy() 1679d763cef2SBarry Smith @*/ 16807087cfbeSBarry Smith PetscErrorCode TSSetUp(TS ts) 1681d763cef2SBarry Smith { 1682dfbe8321SBarry Smith PetscErrorCode ierr; 16836c6b9e74SPeter Brune DM dm; 16846c6b9e74SPeter Brune PetscErrorCode (*func)(SNES,Vec,Vec,void*); 16856c6b9e74SPeter Brune PetscErrorCode (*jac)(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 16866c6b9e74SPeter Brune TSIJacobian ijac; 16876c6b9e74SPeter Brune TSRHSJacobian rhsjac; 1688d763cef2SBarry Smith 1689d763cef2SBarry Smith PetscFunctionBegin; 16900700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1691277b19d0SLisandro Dalcin if (ts->setupcalled) PetscFunctionReturn(0); 1692277b19d0SLisandro Dalcin 16937adad957SLisandro Dalcin if (!((PetscObject)ts)->type_name) { 16949596e0b4SJed Brown ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr); 1695d763cef2SBarry Smith } 1696277b19d0SLisandro Dalcin 1697277b19d0SLisandro Dalcin if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first"); 1698277b19d0SLisandro Dalcin 1699ad6bc421SBarry Smith ierr = TSGetTSAdapt(ts,&ts->adapt);CHKERRQ(ierr); 17001c3436cfSJed Brown 1701277b19d0SLisandro Dalcin if (ts->ops->setup) { 1702000e7ae3SMatthew Knepley ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr); 1703277b19d0SLisandro Dalcin } 1704277b19d0SLisandro Dalcin 17056c6b9e74SPeter Brune /* in the case where we've set a DMTSFunction or what have you, we need the default SNESFunction 17066c6b9e74SPeter Brune to be set right but can't do it elsewhere due to the overreliance on ctx=ts. 17076c6b9e74SPeter Brune */ 17086c6b9e74SPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 17090298fd71SBarry Smith ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr); 17106c6b9e74SPeter Brune if (!func) { 17116c6b9e74SPeter Brune ierr =DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr); 17126c6b9e74SPeter Brune } 17136c6b9e74SPeter 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. 17146c6b9e74SPeter Brune Otherwise, the SNES will use coloring internally to form the Jacobian. 17156c6b9e74SPeter Brune */ 17160298fd71SBarry Smith ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr); 17170298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr); 17180298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr); 17196c6b9e74SPeter Brune if (!jac && (ijac || rhsjac)) { 17206c6b9e74SPeter Brune ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr); 17216c6b9e74SPeter Brune } 1722277b19d0SLisandro Dalcin ts->setupcalled = PETSC_TRUE; 1723277b19d0SLisandro Dalcin PetscFunctionReturn(0); 1724277b19d0SLisandro Dalcin } 1725277b19d0SLisandro Dalcin 1726277b19d0SLisandro Dalcin #undef __FUNCT__ 1727277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset" 1728277b19d0SLisandro Dalcin /*@ 1729277b19d0SLisandro Dalcin TSReset - Resets a TS context and removes any allocated Vecs and Mats. 1730277b19d0SLisandro Dalcin 1731277b19d0SLisandro Dalcin Collective on TS 1732277b19d0SLisandro Dalcin 1733277b19d0SLisandro Dalcin Input Parameter: 1734277b19d0SLisandro Dalcin . ts - the TS context obtained from TSCreate() 1735277b19d0SLisandro Dalcin 1736277b19d0SLisandro Dalcin Level: beginner 1737277b19d0SLisandro Dalcin 1738277b19d0SLisandro Dalcin .keywords: TS, timestep, reset 1739277b19d0SLisandro Dalcin 1740277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy() 1741277b19d0SLisandro Dalcin @*/ 1742277b19d0SLisandro Dalcin PetscErrorCode TSReset(TS ts) 1743277b19d0SLisandro Dalcin { 1744277b19d0SLisandro Dalcin PetscErrorCode ierr; 1745277b19d0SLisandro Dalcin 1746277b19d0SLisandro Dalcin PetscFunctionBegin; 1747277b19d0SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1748277b19d0SLisandro Dalcin if (ts->ops->reset) { 1749277b19d0SLisandro Dalcin ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr); 1750277b19d0SLisandro Dalcin } 1751277b19d0SLisandro Dalcin if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);} 1752bbd56ea5SKarl Rupp 17534e684422SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 17544e684422SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1755214bc6a2SJed Brown ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr); 17566bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 1757e3d84a46SJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 1758e3d84a46SJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 175938637c2eSJed Brown ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr); 1760bbd56ea5SKarl Rupp 1761277b19d0SLisandro Dalcin ts->setupcalled = PETSC_FALSE; 1762d763cef2SBarry Smith PetscFunctionReturn(0); 1763d763cef2SBarry Smith } 1764d763cef2SBarry Smith 17654a2ae208SSatish Balay #undef __FUNCT__ 17664a2ae208SSatish Balay #define __FUNCT__ "TSDestroy" 1767d8e5e3e6SSatish Balay /*@ 1768d763cef2SBarry Smith TSDestroy - Destroys the timestepper context that was created 1769d763cef2SBarry Smith with TSCreate(). 1770d763cef2SBarry Smith 1771d763cef2SBarry Smith Collective on TS 1772d763cef2SBarry Smith 1773d763cef2SBarry Smith Input Parameter: 1774d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1775d763cef2SBarry Smith 1776d763cef2SBarry Smith Level: beginner 1777d763cef2SBarry Smith 1778d763cef2SBarry Smith .keywords: TS, timestepper, destroy 1779d763cef2SBarry Smith 1780d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve() 1781d763cef2SBarry Smith @*/ 17826bf464f9SBarry Smith PetscErrorCode TSDestroy(TS *ts) 1783d763cef2SBarry Smith { 17846849ba73SBarry Smith PetscErrorCode ierr; 1785d763cef2SBarry Smith 1786d763cef2SBarry Smith PetscFunctionBegin; 17876bf464f9SBarry Smith if (!*ts) PetscFunctionReturn(0); 17886bf464f9SBarry Smith PetscValidHeaderSpecific((*ts),TS_CLASSID,1); 17896bf464f9SBarry Smith if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);} 1790d763cef2SBarry Smith 17916bf464f9SBarry Smith ierr = TSReset((*ts));CHKERRQ(ierr); 1792277b19d0SLisandro Dalcin 1793be0abb6dSBarry Smith /* if memory was published with AMS then destroy it */ 17946bf464f9SBarry Smith ierr = PetscObjectDepublish((*ts));CHKERRQ(ierr); 17956bf464f9SBarry Smith if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);} 17966d4c513bSLisandro Dalcin 179784df9cb4SJed Brown ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr); 17986bf464f9SBarry Smith ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr); 17996bf464f9SBarry Smith ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr); 18006bf464f9SBarry Smith ierr = TSMonitorCancel((*ts));CHKERRQ(ierr); 18016d4c513bSLisandro Dalcin 1802a79aaaedSSatish Balay ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr); 1803d763cef2SBarry Smith PetscFunctionReturn(0); 1804d763cef2SBarry Smith } 1805d763cef2SBarry Smith 18064a2ae208SSatish Balay #undef __FUNCT__ 18074a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES" 1808d8e5e3e6SSatish Balay /*@ 1809d763cef2SBarry Smith TSGetSNES - Returns the SNES (nonlinear solver) associated with 1810d763cef2SBarry Smith a TS (timestepper) context. Valid only for nonlinear problems. 1811d763cef2SBarry Smith 1812d763cef2SBarry Smith Not Collective, but SNES is parallel if TS is parallel 1813d763cef2SBarry Smith 1814d763cef2SBarry Smith Input Parameter: 1815d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1816d763cef2SBarry Smith 1817d763cef2SBarry Smith Output Parameter: 1818d763cef2SBarry Smith . snes - the nonlinear solver context 1819d763cef2SBarry Smith 1820d763cef2SBarry Smith Notes: 1821d763cef2SBarry Smith The user can then directly manipulate the SNES context to set various 1822d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 182394b7f48cSBarry Smith KSP, KSP, and PC contexts as well. 1824d763cef2SBarry Smith 1825d763cef2SBarry Smith TSGetSNES() does not work for integrators that do not use SNES; in 18260298fd71SBarry Smith this case TSGetSNES() returns NULL in snes. 1827d763cef2SBarry Smith 1828d763cef2SBarry Smith Level: beginner 1829d763cef2SBarry Smith 1830d763cef2SBarry Smith .keywords: timestep, get, SNES 1831d763cef2SBarry Smith @*/ 18327087cfbeSBarry Smith PetscErrorCode TSGetSNES(TS ts,SNES *snes) 1833d763cef2SBarry Smith { 1834d372ba47SLisandro Dalcin PetscErrorCode ierr; 1835d372ba47SLisandro Dalcin 1836d763cef2SBarry Smith PetscFunctionBegin; 18370700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 18384482741eSBarry Smith PetscValidPointer(snes,2); 1839d372ba47SLisandro Dalcin if (!ts->snes) { 1840ce94432eSBarry Smith ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr); 18410298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 1842d372ba47SLisandro Dalcin ierr = PetscLogObjectParent(ts,ts->snes);CHKERRQ(ierr); 1843d372ba47SLisandro Dalcin ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr); 1844496e6a7aSJed Brown if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 18459e2a6581SJed Brown if (ts->problem_type == TS_LINEAR) { 18469e2a6581SJed Brown ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); 18479e2a6581SJed Brown } 1848d372ba47SLisandro Dalcin } 1849d763cef2SBarry Smith *snes = ts->snes; 1850d763cef2SBarry Smith PetscFunctionReturn(0); 1851d763cef2SBarry Smith } 1852d763cef2SBarry Smith 18534a2ae208SSatish Balay #undef __FUNCT__ 1854deb2cd25SJed Brown #define __FUNCT__ "TSSetSNES" 1855deb2cd25SJed Brown /*@ 1856deb2cd25SJed Brown TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context 1857deb2cd25SJed Brown 1858deb2cd25SJed Brown Collective 1859deb2cd25SJed Brown 1860deb2cd25SJed Brown Input Parameter: 1861deb2cd25SJed Brown + ts - the TS context obtained from TSCreate() 1862deb2cd25SJed Brown - snes - the nonlinear solver context 1863deb2cd25SJed Brown 1864deb2cd25SJed Brown Notes: 1865deb2cd25SJed Brown Most users should have the TS created by calling TSGetSNES() 1866deb2cd25SJed Brown 1867deb2cd25SJed Brown Level: developer 1868deb2cd25SJed Brown 1869deb2cd25SJed Brown .keywords: timestep, set, SNES 1870deb2cd25SJed Brown @*/ 1871deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes) 1872deb2cd25SJed Brown { 1873deb2cd25SJed Brown PetscErrorCode ierr; 1874740132f1SEmil Constantinescu PetscErrorCode (*func)(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 1875deb2cd25SJed Brown 1876deb2cd25SJed Brown PetscFunctionBegin; 1877deb2cd25SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1878deb2cd25SJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,2); 1879deb2cd25SJed Brown ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr); 1880deb2cd25SJed Brown ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr); 1881bbd56ea5SKarl Rupp 1882deb2cd25SJed Brown ts->snes = snes; 1883bbd56ea5SKarl Rupp 18840298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 18850298fd71SBarry Smith ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr); 1886740132f1SEmil Constantinescu if (func == SNESTSFormJacobian) { 18870298fd71SBarry Smith ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1888740132f1SEmil Constantinescu } 1889deb2cd25SJed Brown PetscFunctionReturn(0); 1890deb2cd25SJed Brown } 1891deb2cd25SJed Brown 1892deb2cd25SJed Brown #undef __FUNCT__ 189394b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP" 1894d8e5e3e6SSatish Balay /*@ 189594b7f48cSBarry Smith TSGetKSP - Returns the KSP (linear solver) associated with 1896d763cef2SBarry Smith a TS (timestepper) context. 1897d763cef2SBarry Smith 189894b7f48cSBarry Smith Not Collective, but KSP is parallel if TS is parallel 1899d763cef2SBarry Smith 1900d763cef2SBarry Smith Input Parameter: 1901d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1902d763cef2SBarry Smith 1903d763cef2SBarry Smith Output Parameter: 190494b7f48cSBarry Smith . ksp - the nonlinear solver context 1905d763cef2SBarry Smith 1906d763cef2SBarry Smith Notes: 190794b7f48cSBarry Smith The user can then directly manipulate the KSP context to set various 1908d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 1909d763cef2SBarry Smith KSP and PC contexts as well. 1910d763cef2SBarry Smith 191194b7f48cSBarry Smith TSGetKSP() does not work for integrators that do not use KSP; 19120298fd71SBarry Smith in this case TSGetKSP() returns NULL in ksp. 1913d763cef2SBarry Smith 1914d763cef2SBarry Smith Level: beginner 1915d763cef2SBarry Smith 191694b7f48cSBarry Smith .keywords: timestep, get, KSP 1917d763cef2SBarry Smith @*/ 19187087cfbeSBarry Smith PetscErrorCode TSGetKSP(TS ts,KSP *ksp) 1919d763cef2SBarry Smith { 1920d372ba47SLisandro Dalcin PetscErrorCode ierr; 1921089b2837SJed Brown SNES snes; 1922d372ba47SLisandro Dalcin 1923d763cef2SBarry Smith PetscFunctionBegin; 19240700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 19254482741eSBarry Smith PetscValidPointer(ksp,2); 192617186662SBarry Smith if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first"); 1927e32f2f54SBarry Smith if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()"); 1928089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1929089b2837SJed Brown ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr); 1930d763cef2SBarry Smith PetscFunctionReturn(0); 1931d763cef2SBarry Smith } 1932d763cef2SBarry Smith 1933d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */ 1934d763cef2SBarry Smith 19354a2ae208SSatish Balay #undef __FUNCT__ 1936adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration" 1937adb62b0dSMatthew Knepley /*@ 1938adb62b0dSMatthew Knepley TSGetDuration - Gets the maximum number of timesteps to use and 1939adb62b0dSMatthew Knepley maximum time for iteration. 1940adb62b0dSMatthew Knepley 19413f9fe445SBarry Smith Not Collective 1942adb62b0dSMatthew Knepley 1943adb62b0dSMatthew Knepley Input Parameters: 1944adb62b0dSMatthew Knepley + ts - the TS context obtained from TSCreate() 19450298fd71SBarry Smith . maxsteps - maximum number of iterations to use, or NULL 19460298fd71SBarry Smith - maxtime - final time to iterate to, or NULL 1947adb62b0dSMatthew Knepley 1948adb62b0dSMatthew Knepley Level: intermediate 1949adb62b0dSMatthew Knepley 1950adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time 1951adb62b0dSMatthew Knepley @*/ 19527087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 1953adb62b0dSMatthew Knepley { 1954adb62b0dSMatthew Knepley PetscFunctionBegin; 19550700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1956abc0a331SBarry Smith if (maxsteps) { 19574482741eSBarry Smith PetscValidIntPointer(maxsteps,2); 1958adb62b0dSMatthew Knepley *maxsteps = ts->max_steps; 1959adb62b0dSMatthew Knepley } 1960abc0a331SBarry Smith if (maxtime) { 19614482741eSBarry Smith PetscValidScalarPointer(maxtime,3); 1962adb62b0dSMatthew Knepley *maxtime = ts->max_time; 1963adb62b0dSMatthew Knepley } 1964adb62b0dSMatthew Knepley PetscFunctionReturn(0); 1965adb62b0dSMatthew Knepley } 1966adb62b0dSMatthew Knepley 1967adb62b0dSMatthew Knepley #undef __FUNCT__ 19684a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration" 1969d763cef2SBarry Smith /*@ 1970d763cef2SBarry Smith TSSetDuration - Sets the maximum number of timesteps to use and 1971d763cef2SBarry Smith maximum time for iteration. 1972d763cef2SBarry Smith 19733f9fe445SBarry Smith Logically Collective on TS 1974d763cef2SBarry Smith 1975d763cef2SBarry Smith Input Parameters: 1976d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1977d763cef2SBarry Smith . maxsteps - maximum number of iterations to use 1978d763cef2SBarry Smith - maxtime - final time to iterate to 1979d763cef2SBarry Smith 1980d763cef2SBarry Smith Options Database Keys: 1981d763cef2SBarry Smith . -ts_max_steps <maxsteps> - Sets maxsteps 19823bca7d26SBarry Smith . -ts_final_time <maxtime> - Sets maxtime 1983d763cef2SBarry Smith 1984d763cef2SBarry Smith Notes: 1985d763cef2SBarry Smith The default maximum number of iterations is 5000. Default time is 5.0 1986d763cef2SBarry Smith 1987d763cef2SBarry Smith Level: intermediate 1988d763cef2SBarry Smith 1989d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations 1990a43b19c4SJed Brown 1991a43b19c4SJed Brown .seealso: TSSetExactFinalTime() 1992d763cef2SBarry Smith @*/ 19937087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime) 1994d763cef2SBarry Smith { 1995d763cef2SBarry Smith PetscFunctionBegin; 19960700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1997c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(ts,maxsteps,2); 1998c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,maxtime,2); 199939b7ec4bSSean Farley if (maxsteps >= 0) ts->max_steps = maxsteps; 200039b7ec4bSSean Farley if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime; 2001d763cef2SBarry Smith PetscFunctionReturn(0); 2002d763cef2SBarry Smith } 2003d763cef2SBarry Smith 20044a2ae208SSatish Balay #undef __FUNCT__ 20054a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution" 2006d763cef2SBarry Smith /*@ 2007d763cef2SBarry Smith TSSetSolution - Sets the initial solution vector 2008d763cef2SBarry Smith for use by the TS routines. 2009d763cef2SBarry Smith 20103f9fe445SBarry Smith Logically Collective on TS and Vec 2011d763cef2SBarry Smith 2012d763cef2SBarry Smith Input Parameters: 2013d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 20140910c330SBarry Smith - u - the solution vector 2015d763cef2SBarry Smith 2016d763cef2SBarry Smith Level: beginner 2017d763cef2SBarry Smith 2018d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions 2019d763cef2SBarry Smith @*/ 20200910c330SBarry Smith PetscErrorCode TSSetSolution(TS ts,Vec u) 2021d763cef2SBarry Smith { 20228737fe31SLisandro Dalcin PetscErrorCode ierr; 2023496e6a7aSJed Brown DM dm; 20248737fe31SLisandro Dalcin 2025d763cef2SBarry Smith PetscFunctionBegin; 20260700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 20270910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,2); 20280910c330SBarry Smith ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr); 20296bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 2030bbd56ea5SKarl Rupp 20310910c330SBarry Smith ts->vec_sol = u; 2032bbd56ea5SKarl Rupp 2033496e6a7aSJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 20340910c330SBarry Smith ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr); 2035d763cef2SBarry Smith PetscFunctionReturn(0); 2036d763cef2SBarry Smith } 2037d763cef2SBarry Smith 2038e74ef692SMatthew Knepley #undef __FUNCT__ 2039e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep" 2040ac226902SBarry Smith /*@C 2041000e7ae3SMatthew Knepley TSSetPreStep - Sets the general-purpose function 20423f2090d5SJed Brown called once at the beginning of each time step. 2043000e7ae3SMatthew Knepley 20443f9fe445SBarry Smith Logically Collective on TS 2045000e7ae3SMatthew Knepley 2046000e7ae3SMatthew Knepley Input Parameters: 2047000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 2048000e7ae3SMatthew Knepley - func - The function 2049000e7ae3SMatthew Knepley 2050000e7ae3SMatthew Knepley Calling sequence of func: 2051000e7ae3SMatthew Knepley . func (TS ts); 2052000e7ae3SMatthew Knepley 2053000e7ae3SMatthew Knepley Level: intermediate 2054000e7ae3SMatthew Knepley 2055b8123daeSJed Brown Note: 2056b8123daeSJed Brown If a step is rejected, TSStep() will call this routine again before each attempt. 2057b8123daeSJed Brown The last completed time step number can be queried using TSGetTimeStepNumber(), the 2058b8123daeSJed Brown size of the step being attempted can be obtained using TSGetTimeStep(). 2059b8123daeSJed Brown 2060000e7ae3SMatthew Knepley .keywords: TS, timestep 2061b8123daeSJed Brown .seealso: TSSetPreStage(), TSSetPostStep(), TSStep() 2062000e7ae3SMatthew Knepley @*/ 20637087cfbeSBarry Smith PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS)) 2064000e7ae3SMatthew Knepley { 2065000e7ae3SMatthew Knepley PetscFunctionBegin; 20660700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2067ae60f76fSBarry Smith ts->prestep = func; 2068000e7ae3SMatthew Knepley PetscFunctionReturn(0); 2069000e7ae3SMatthew Knepley } 2070000e7ae3SMatthew Knepley 2071e74ef692SMatthew Knepley #undef __FUNCT__ 20723f2090d5SJed Brown #define __FUNCT__ "TSPreStep" 207309ee8438SJed Brown /*@ 20743f2090d5SJed Brown TSPreStep - Runs the user-defined pre-step function. 20753f2090d5SJed Brown 20763f2090d5SJed Brown Collective on TS 20773f2090d5SJed Brown 20783f2090d5SJed Brown Input Parameters: 20793f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 20803f2090d5SJed Brown 20813f2090d5SJed Brown Notes: 20823f2090d5SJed Brown TSPreStep() is typically used within time stepping implementations, 20833f2090d5SJed Brown so most users would not generally call this routine themselves. 20843f2090d5SJed Brown 20853f2090d5SJed Brown Level: developer 20863f2090d5SJed Brown 20873f2090d5SJed Brown .keywords: TS, timestep 2088b8123daeSJed Brown .seealso: TSSetPreStep(), TSPreStage(), TSPostStep() 20893f2090d5SJed Brown @*/ 20907087cfbeSBarry Smith PetscErrorCode TSPreStep(TS ts) 20913f2090d5SJed Brown { 20923f2090d5SJed Brown PetscErrorCode ierr; 20933f2090d5SJed Brown 20943f2090d5SJed Brown PetscFunctionBegin; 20950700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2096ae60f76fSBarry Smith if (ts->prestep) { 2097ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestep),(ts)); 2098312ce896SJed Brown } 20993f2090d5SJed Brown PetscFunctionReturn(0); 21003f2090d5SJed Brown } 21013f2090d5SJed Brown 21023f2090d5SJed Brown #undef __FUNCT__ 2103b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage" 2104b8123daeSJed Brown /*@C 2105b8123daeSJed Brown TSSetPreStage - Sets the general-purpose function 2106b8123daeSJed Brown called once at the beginning of each stage. 2107b8123daeSJed Brown 2108b8123daeSJed Brown Logically Collective on TS 2109b8123daeSJed Brown 2110b8123daeSJed Brown Input Parameters: 2111b8123daeSJed Brown + ts - The TS context obtained from TSCreate() 2112b8123daeSJed Brown - func - The function 2113b8123daeSJed Brown 2114b8123daeSJed Brown Calling sequence of func: 2115b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime); 2116b8123daeSJed Brown 2117b8123daeSJed Brown Level: intermediate 2118b8123daeSJed Brown 2119b8123daeSJed Brown Note: 2120b8123daeSJed Brown There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 2121b8123daeSJed Brown The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 2122b8123daeSJed Brown attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 2123b8123daeSJed Brown 2124b8123daeSJed Brown .keywords: TS, timestep 2125b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 2126b8123daeSJed Brown @*/ 2127b8123daeSJed Brown PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal)) 2128b8123daeSJed Brown { 2129b8123daeSJed Brown PetscFunctionBegin; 2130b8123daeSJed Brown PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2131ae60f76fSBarry Smith ts->prestage = func; 2132b8123daeSJed Brown PetscFunctionReturn(0); 2133b8123daeSJed Brown } 2134b8123daeSJed Brown 2135b8123daeSJed Brown #undef __FUNCT__ 2136b8123daeSJed Brown #define __FUNCT__ "TSPreStage" 2137b8123daeSJed Brown /*@ 2138b8123daeSJed Brown TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage() 2139b8123daeSJed Brown 2140b8123daeSJed Brown Collective on TS 2141b8123daeSJed Brown 2142b8123daeSJed Brown Input Parameters: 2143b8123daeSJed Brown . ts - The TS context obtained from TSCreate() 2144b8123daeSJed Brown 2145b8123daeSJed Brown Notes: 2146b8123daeSJed Brown TSPreStage() is typically used within time stepping implementations, 2147b8123daeSJed Brown most users would not generally call this routine themselves. 2148b8123daeSJed Brown 2149b8123daeSJed Brown Level: developer 2150b8123daeSJed Brown 2151b8123daeSJed Brown .keywords: TS, timestep 2152b8123daeSJed Brown .seealso: TSSetPreStep(), TSPreStep(), TSPostStep() 2153b8123daeSJed Brown @*/ 2154b8123daeSJed Brown PetscErrorCode TSPreStage(TS ts, PetscReal stagetime) 2155b8123daeSJed Brown { 2156b8123daeSJed Brown PetscErrorCode ierr; 2157b8123daeSJed Brown 2158b8123daeSJed Brown PetscFunctionBegin; 2159b8123daeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2160ae60f76fSBarry Smith if (ts->prestage) { 2161ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestage),(ts,stagetime)); 2162b8123daeSJed Brown } 2163b8123daeSJed Brown PetscFunctionReturn(0); 2164b8123daeSJed Brown } 2165b8123daeSJed Brown 2166b8123daeSJed Brown #undef __FUNCT__ 2167e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep" 2168ac226902SBarry Smith /*@C 2169000e7ae3SMatthew Knepley TSSetPostStep - Sets the general-purpose function 21703f2090d5SJed Brown called once at the end of each time step. 2171000e7ae3SMatthew Knepley 21723f9fe445SBarry Smith Logically Collective on TS 2173000e7ae3SMatthew Knepley 2174000e7ae3SMatthew Knepley Input Parameters: 2175000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 2176000e7ae3SMatthew Knepley - func - The function 2177000e7ae3SMatthew Knepley 2178000e7ae3SMatthew Knepley Calling sequence of func: 2179b8123daeSJed Brown $ func (TS ts); 2180000e7ae3SMatthew Knepley 2181000e7ae3SMatthew Knepley Level: intermediate 2182000e7ae3SMatthew Knepley 2183000e7ae3SMatthew Knepley .keywords: TS, timestep 2184b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime() 2185000e7ae3SMatthew Knepley @*/ 21867087cfbeSBarry Smith PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS)) 2187000e7ae3SMatthew Knepley { 2188000e7ae3SMatthew Knepley PetscFunctionBegin; 21890700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2190ae60f76fSBarry Smith ts->poststep = func; 2191000e7ae3SMatthew Knepley PetscFunctionReturn(0); 2192000e7ae3SMatthew Knepley } 2193000e7ae3SMatthew Knepley 2194e74ef692SMatthew Knepley #undef __FUNCT__ 21953f2090d5SJed Brown #define __FUNCT__ "TSPostStep" 219609ee8438SJed Brown /*@ 21973f2090d5SJed Brown TSPostStep - Runs the user-defined post-step function. 21983f2090d5SJed Brown 21993f2090d5SJed Brown Collective on TS 22003f2090d5SJed Brown 22013f2090d5SJed Brown Input Parameters: 22023f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 22033f2090d5SJed Brown 22043f2090d5SJed Brown Notes: 22053f2090d5SJed Brown TSPostStep() is typically used within time stepping implementations, 22063f2090d5SJed Brown so most users would not generally call this routine themselves. 22073f2090d5SJed Brown 22083f2090d5SJed Brown Level: developer 22093f2090d5SJed Brown 22103f2090d5SJed Brown .keywords: TS, timestep 22113f2090d5SJed Brown @*/ 22127087cfbeSBarry Smith PetscErrorCode TSPostStep(TS ts) 22133f2090d5SJed Brown { 22143f2090d5SJed Brown PetscErrorCode ierr; 22153f2090d5SJed Brown 22163f2090d5SJed Brown PetscFunctionBegin; 22170700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2218ae60f76fSBarry Smith if (ts->poststep) { 2219ae60f76fSBarry Smith PetscStackCallStandard((*ts->poststep),(ts)); 222072ac3e02SJed Brown } 22213f2090d5SJed Brown PetscFunctionReturn(0); 22223f2090d5SJed Brown } 22233f2090d5SJed Brown 2224d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */ 2225d763cef2SBarry Smith 22264a2ae208SSatish Balay #undef __FUNCT__ 2227a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet" 2228d763cef2SBarry Smith /*@C 2229a6570f20SBarry Smith TSMonitorSet - Sets an ADDITIONAL function that is to be used at every 2230d763cef2SBarry Smith timestep to display the iteration's progress. 2231d763cef2SBarry Smith 22323f9fe445SBarry Smith Logically Collective on TS 2233d763cef2SBarry Smith 2234d763cef2SBarry Smith Input Parameters: 2235d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2236e213d8f1SJed Brown . monitor - monitoring routine 2237329f5518SBarry Smith . mctx - [optional] user-defined context for private data for the 22380298fd71SBarry Smith monitor routine (use NULL if no context is desired) 2239b3006f0bSLois Curfman McInnes - monitordestroy - [optional] routine that frees monitor context 22400298fd71SBarry Smith (may be NULL) 2241d763cef2SBarry Smith 2242e213d8f1SJed Brown Calling sequence of monitor: 22430910c330SBarry Smith $ int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx) 2244d763cef2SBarry Smith 2245d763cef2SBarry Smith + ts - the TS context 224688c05cc5SBarry 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 224788c05cc5SBarry Smith been interpolated to) 22481f06c33eSBarry Smith . time - current time 22490910c330SBarry Smith . u - current iterate 2250d763cef2SBarry Smith - mctx - [optional] monitoring context 2251d763cef2SBarry Smith 2252d763cef2SBarry Smith Notes: 2253d763cef2SBarry Smith This routine adds an additional monitor to the list of monitors that 2254d763cef2SBarry Smith already has been loaded. 2255d763cef2SBarry Smith 2256025f1a04SBarry Smith Fortran notes: Only a single monitor function can be set for each TS object 2257025f1a04SBarry Smith 2258d763cef2SBarry Smith Level: intermediate 2259d763cef2SBarry Smith 2260d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 2261d763cef2SBarry Smith 2262a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel() 2263d763cef2SBarry Smith @*/ 2264c2efdce3SBarry Smith PetscErrorCode TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**)) 2265d763cef2SBarry Smith { 2266d763cef2SBarry Smith PetscFunctionBegin; 22670700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 226817186662SBarry Smith if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 2269d763cef2SBarry Smith ts->monitor[ts->numbermonitors] = monitor; 22708704b422SBarry Smith ts->monitordestroy[ts->numbermonitors] = mdestroy; 2271d763cef2SBarry Smith ts->monitorcontext[ts->numbermonitors++] = (void*)mctx; 2272d763cef2SBarry Smith PetscFunctionReturn(0); 2273d763cef2SBarry Smith } 2274d763cef2SBarry Smith 22754a2ae208SSatish Balay #undef __FUNCT__ 2276a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel" 2277d763cef2SBarry Smith /*@C 2278a6570f20SBarry Smith TSMonitorCancel - Clears all the monitors that have been set on a time-step object. 2279d763cef2SBarry Smith 22803f9fe445SBarry Smith Logically Collective on TS 2281d763cef2SBarry Smith 2282d763cef2SBarry Smith Input Parameters: 2283d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2284d763cef2SBarry Smith 2285d763cef2SBarry Smith Notes: 2286d763cef2SBarry Smith There is no way to remove a single, specific monitor. 2287d763cef2SBarry Smith 2288d763cef2SBarry Smith Level: intermediate 2289d763cef2SBarry Smith 2290d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 2291d763cef2SBarry Smith 2292a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet() 2293d763cef2SBarry Smith @*/ 22947087cfbeSBarry Smith PetscErrorCode TSMonitorCancel(TS ts) 2295d763cef2SBarry Smith { 2296d952e501SBarry Smith PetscErrorCode ierr; 2297d952e501SBarry Smith PetscInt i; 2298d952e501SBarry Smith 2299d763cef2SBarry Smith PetscFunctionBegin; 23000700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2301d952e501SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 23028704b422SBarry Smith if (ts->monitordestroy[i]) { 23038704b422SBarry Smith ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr); 2304d952e501SBarry Smith } 2305d952e501SBarry Smith } 2306d763cef2SBarry Smith ts->numbermonitors = 0; 2307d763cef2SBarry Smith PetscFunctionReturn(0); 2308d763cef2SBarry Smith } 2309d763cef2SBarry Smith 23104a2ae208SSatish Balay #undef __FUNCT__ 2311a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault" 2312d8e5e3e6SSatish Balay /*@ 2313a6570f20SBarry Smith TSMonitorDefault - Sets the Default monitor 23145516499fSSatish Balay 23155516499fSSatish Balay Level: intermediate 231641251cbbSSatish Balay 23175516499fSSatish Balay .keywords: TS, set, monitor 23185516499fSSatish Balay 231941251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet() 232041251cbbSSatish Balay @*/ 2321649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy) 2322d763cef2SBarry Smith { 2323dfbe8321SBarry Smith PetscErrorCode ierr; 2324ce94432eSBarry Smith PetscViewer viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)ts)); 2325d132466eSBarry Smith 2326d763cef2SBarry Smith PetscFunctionBegin; 2327649052a6SBarry Smith ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 2328971832b6SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g\n",step,(double)ts->time_step,(double)ptime);CHKERRQ(ierr); 2329649052a6SBarry Smith ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 2330d763cef2SBarry Smith PetscFunctionReturn(0); 2331d763cef2SBarry Smith } 2332d763cef2SBarry Smith 23334a2ae208SSatish Balay #undef __FUNCT__ 2334cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages" 2335cd652676SJed Brown /*@ 2336cd652676SJed Brown TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available. 2337cd652676SJed Brown 2338cd652676SJed Brown Logically Collective on TS 2339cd652676SJed Brown 2340cd652676SJed Brown Input Argument: 2341cd652676SJed Brown . ts - time stepping context 2342cd652676SJed Brown 2343cd652676SJed Brown Output Argument: 2344cd652676SJed Brown . flg - PETSC_TRUE or PETSC_FALSE 2345cd652676SJed Brown 2346cd652676SJed Brown Level: intermediate 2347cd652676SJed Brown 2348cd652676SJed Brown .keywords: TS, set 2349cd652676SJed Brown 2350cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep() 2351cd652676SJed Brown @*/ 2352cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg) 2353cd652676SJed Brown { 2354cd652676SJed Brown PetscFunctionBegin; 2355cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2356cd652676SJed Brown ts->retain_stages = flg; 2357cd652676SJed Brown PetscFunctionReturn(0); 2358cd652676SJed Brown } 2359cd652676SJed Brown 2360cd652676SJed Brown #undef __FUNCT__ 2361cd652676SJed Brown #define __FUNCT__ "TSInterpolate" 2362cd652676SJed Brown /*@ 2363cd652676SJed Brown TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval 2364cd652676SJed Brown 2365cd652676SJed Brown Collective on TS 2366cd652676SJed Brown 2367cd652676SJed Brown Input Argument: 2368cd652676SJed Brown + ts - time stepping context 2369cd652676SJed Brown - t - time to interpolate to 2370cd652676SJed Brown 2371cd652676SJed Brown Output Argument: 23720910c330SBarry Smith . U - state at given time 2373cd652676SJed Brown 2374cd652676SJed Brown Notes: 2375cd652676SJed Brown The user should call TSSetRetainStages() before taking a step in which interpolation will be requested. 2376cd652676SJed Brown 2377cd652676SJed Brown Level: intermediate 2378cd652676SJed Brown 2379cd652676SJed Brown Developer Notes: 2380cd652676SJed Brown TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints. 2381cd652676SJed Brown 2382cd652676SJed Brown .keywords: TS, set 2383cd652676SJed Brown 2384cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep() 2385cd652676SJed Brown @*/ 23860910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U) 2387cd652676SJed Brown { 2388cd652676SJed Brown PetscErrorCode ierr; 2389cd652676SJed Brown 2390cd652676SJed Brown PetscFunctionBegin; 2391cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2392ce94432eSBarry 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); 2393ce94432eSBarry Smith if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name); 23940910c330SBarry Smith ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr); 2395cd652676SJed Brown PetscFunctionReturn(0); 2396cd652676SJed Brown } 2397cd652676SJed Brown 2398cd652676SJed Brown #undef __FUNCT__ 23994a2ae208SSatish Balay #define __FUNCT__ "TSStep" 2400d763cef2SBarry Smith /*@ 24016d9e5789SSean Farley TSStep - Steps one time step 2402d763cef2SBarry Smith 2403d763cef2SBarry Smith Collective on TS 2404d763cef2SBarry Smith 2405d763cef2SBarry Smith Input Parameter: 2406d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2407d763cef2SBarry Smith 24086d9e5789SSean Farley Level: intermediate 2409d763cef2SBarry Smith 2410b8123daeSJed Brown Notes: 2411b8123daeSJed Brown The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may 2412b8123daeSJed Brown be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages. 2413b8123daeSJed Brown 241425cb2221SBarry Smith This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the 241525cb2221SBarry Smith time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep. 241625cb2221SBarry Smith 2417d763cef2SBarry Smith .keywords: TS, timestep, solve 2418d763cef2SBarry Smith 241925cb2221SBarry Smith .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate() 2420d763cef2SBarry Smith @*/ 2421193ac0bcSJed Brown PetscErrorCode TSStep(TS ts) 2422d763cef2SBarry Smith { 2423362cd11cSLisandro Dalcin PetscReal ptime_prev; 2424dfbe8321SBarry Smith PetscErrorCode ierr; 2425d763cef2SBarry Smith 2426d763cef2SBarry Smith PetscFunctionBegin; 24270700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2428d405a339SMatthew Knepley ierr = TSSetUp(ts);CHKERRQ(ierr); 2429d405a339SMatthew Knepley 2430362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_ITERATING; 2431362cd11cSLisandro Dalcin ptime_prev = ts->ptime; 2432bbd56ea5SKarl Rupp 2433d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 2434193ac0bcSJed Brown ierr = (*ts->ops->step)(ts);CHKERRQ(ierr); 2435d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 2436bbd56ea5SKarl Rupp 2437362cd11cSLisandro Dalcin ts->time_step_prev = ts->ptime - ptime_prev; 2438362cd11cSLisandro Dalcin 2439362cd11cSLisandro Dalcin if (ts->reason < 0) { 2440cef5090cSJed Brown if (ts->errorifstepfailed) { 2441cef5090cSJed Brown if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) { 2442ce94432eSBarry 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]); 2443ce94432eSBarry Smith } else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 2444cef5090cSJed Brown } 2445362cd11cSLisandro Dalcin } else if (!ts->reason) { 2446db4deed7SKarl Rupp if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 2447db4deed7SKarl Rupp else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 2448362cd11cSLisandro Dalcin } 2449d763cef2SBarry Smith PetscFunctionReturn(0); 2450d763cef2SBarry Smith } 2451d763cef2SBarry Smith 24524a2ae208SSatish Balay #undef __FUNCT__ 245305175c85SJed Brown #define __FUNCT__ "TSEvaluateStep" 245405175c85SJed Brown /*@ 245505175c85SJed Brown TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy. 245605175c85SJed Brown 24571c3436cfSJed Brown Collective on TS 245805175c85SJed Brown 245905175c85SJed Brown Input Arguments: 24601c3436cfSJed Brown + ts - time stepping context 24611c3436cfSJed Brown . order - desired order of accuracy 24620298fd71SBarry Smith - done - whether the step was evaluated at this order (pass NULL to generate an error if not available) 246305175c85SJed Brown 246405175c85SJed Brown Output Arguments: 24650910c330SBarry Smith . U - state at the end of the current step 246605175c85SJed Brown 246705175c85SJed Brown Level: advanced 246805175c85SJed Brown 2469108c343cSJed Brown Notes: 2470108c343cSJed Brown This function cannot be called until all stages have been evaluated. 2471108c343cSJed 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. 2472108c343cSJed Brown 24731c3436cfSJed Brown .seealso: TSStep(), TSAdapt 247405175c85SJed Brown @*/ 24750910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done) 247605175c85SJed Brown { 247705175c85SJed Brown PetscErrorCode ierr; 247805175c85SJed Brown 247905175c85SJed Brown PetscFunctionBegin; 248005175c85SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 248105175c85SJed Brown PetscValidType(ts,1); 24820910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 2483ce94432eSBarry Smith if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name); 24840910c330SBarry Smith ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr); 248505175c85SJed Brown PetscFunctionReturn(0); 248605175c85SJed Brown } 248705175c85SJed Brown 248805175c85SJed Brown #undef __FUNCT__ 24896a4d4014SLisandro Dalcin #define __FUNCT__ "TSSolve" 24906a4d4014SLisandro Dalcin /*@ 24916a4d4014SLisandro Dalcin TSSolve - Steps the requested number of timesteps. 24926a4d4014SLisandro Dalcin 24936a4d4014SLisandro Dalcin Collective on TS 24946a4d4014SLisandro Dalcin 24956a4d4014SLisandro Dalcin Input Parameter: 24966a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 2497cc708dedSBarry Smith - u - the solution vector (can be null if TSSetSolution() was used, otherwise must contain the initial conditions) 24985a3a76d0SJed Brown 24996a4d4014SLisandro Dalcin Level: beginner 25006a4d4014SLisandro Dalcin 25015a3a76d0SJed Brown Notes: 25025a3a76d0SJed Brown The final time returned by this function may be different from the time of the internally 25035a3a76d0SJed Brown held state accessible by TSGetSolution() and TSGetTime() because the method may have 25045a3a76d0SJed Brown stepped over the final time. 25055a3a76d0SJed Brown 25066a4d4014SLisandro Dalcin .keywords: TS, timestep, solve 25076a4d4014SLisandro Dalcin 25086a4d4014SLisandro Dalcin .seealso: TSCreate(), TSSetSolution(), TSStep() 25096a4d4014SLisandro Dalcin @*/ 2510cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u) 25116a4d4014SLisandro Dalcin { 25124d7d938eSLisandro Dalcin PetscBool flg; 25134d7d938eSLisandro Dalcin PetscViewer viewer; 25146a4d4014SLisandro Dalcin PetscErrorCode ierr; 2515cffb1e40SBarry Smith PetscViewerFormat format; 2516f22f69f0SBarry Smith 25176a4d4014SLisandro Dalcin PetscFunctionBegin; 25180700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2519f2c2a1b9SBarry Smith if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2); 252049354f04SShri 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 */ 25210910c330SBarry Smith if (!ts->vec_sol || u == ts->vec_sol) { 25225a3a76d0SJed Brown Vec y; 25230910c330SBarry Smith ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 25245a3a76d0SJed Brown ierr = TSSetSolution(ts,y);CHKERRQ(ierr); 25255a3a76d0SJed Brown ierr = VecDestroy(&y);CHKERRQ(ierr); /* grant ownership */ 25265a3a76d0SJed Brown } 2527f2c2a1b9SBarry Smith if (u) { 25280910c330SBarry Smith ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr); 2529f2c2a1b9SBarry Smith } 2530bbd56ea5SKarl Rupp } else if (u) { 25310910c330SBarry Smith ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 25325a3a76d0SJed Brown } 2533b5d403baSSean Farley ierr = TSSetUp(ts);CHKERRQ(ierr); 25346a4d4014SLisandro Dalcin /* reset time step and iteration counters */ 2535193ac0bcSJed Brown ts->steps = 0; 25365ef26d82SJed Brown ts->ksp_its = 0; 25375ef26d82SJed Brown ts->snes_its = 0; 2538c610991cSLisandro Dalcin ts->num_snes_failures = 0; 2539c610991cSLisandro Dalcin ts->reject = 0; 2540193ac0bcSJed Brown ts->reason = TS_CONVERGED_ITERATING; 2541193ac0bcSJed Brown 2542193ac0bcSJed Brown if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 2543193ac0bcSJed Brown ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr); 25440910c330SBarry Smith ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr); 2545bbd56ea5SKarl Rupp 2546cc708dedSBarry Smith ts->solvetime = ts->ptime; 2547193ac0bcSJed Brown } else { 25486a4d4014SLisandro Dalcin /* steps the requested number of timesteps. */ 2549362cd11cSLisandro Dalcin ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 2550db4deed7SKarl Rupp if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 2551db4deed7SKarl Rupp else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 2552e1a7a14fSJed Brown while (!ts->reason) { 2553193ac0bcSJed Brown ierr = TSStep(ts);CHKERRQ(ierr); 2554193ac0bcSJed Brown ierr = TSPostStep(ts);CHKERRQ(ierr); 2555193ac0bcSJed Brown ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 2556193ac0bcSJed Brown } 255749354f04SShri Abhyankar if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) { 25580910c330SBarry Smith ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr); 2559bbd56ea5SKarl Rupp 2560cc708dedSBarry Smith ts->solvetime = ts->max_time; 25610574a7fbSJed Brown } else { 2562ad6bc421SBarry Smith if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 2563cc708dedSBarry Smith ts->solvetime = ts->ptime; 25640574a7fbSJed Brown } 2565193ac0bcSJed Brown } 25663923b477SBarry Smith ierr = TSMonitor(ts,-1,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 2567ce94432eSBarry Smith ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,"-ts_view",&viewer,&format,&flg);CHKERRQ(ierr); 25684d7d938eSLisandro Dalcin if (flg && !PetscPreLoadingOn) { 2569cffb1e40SBarry Smith ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr); 25704d7d938eSLisandro Dalcin ierr = TSView(ts,viewer);CHKERRQ(ierr); 2571cffb1e40SBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 2572cffb1e40SBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 25732b0a91c0SBarry Smith } 25746a4d4014SLisandro Dalcin PetscFunctionReturn(0); 25756a4d4014SLisandro Dalcin } 25766a4d4014SLisandro Dalcin 25776a4d4014SLisandro Dalcin #undef __FUNCT__ 25784a2ae208SSatish Balay #define __FUNCT__ "TSMonitor" 2579228d79bcSJed Brown /*@ 2580228d79bcSJed Brown TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet() 2581228d79bcSJed Brown 2582228d79bcSJed Brown Collective on TS 2583228d79bcSJed Brown 2584228d79bcSJed Brown Input Parameters: 2585228d79bcSJed Brown + ts - time stepping context obtained from TSCreate() 2586228d79bcSJed Brown . step - step number that has just completed 2587228d79bcSJed Brown . ptime - model time of the state 25880910c330SBarry Smith - u - state at the current model time 2589228d79bcSJed Brown 2590228d79bcSJed Brown Notes: 2591228d79bcSJed Brown TSMonitor() is typically used within the time stepping implementations. 2592228d79bcSJed Brown Users might call this function when using the TSStep() interface instead of TSSolve(). 2593228d79bcSJed Brown 2594228d79bcSJed Brown Level: advanced 2595228d79bcSJed Brown 2596228d79bcSJed Brown .keywords: TS, timestep 2597228d79bcSJed Brown @*/ 25980910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u) 2599d763cef2SBarry Smith { 26006849ba73SBarry Smith PetscErrorCode ierr; 2601a7cc72afSBarry Smith PetscInt i,n = ts->numbermonitors; 2602d763cef2SBarry Smith 2603d763cef2SBarry Smith PetscFunctionBegin; 2604d763cef2SBarry Smith for (i=0; i<n; i++) { 26050910c330SBarry Smith ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr); 2606d763cef2SBarry Smith } 2607d763cef2SBarry Smith PetscFunctionReturn(0); 2608d763cef2SBarry Smith } 2609d763cef2SBarry Smith 2610d763cef2SBarry Smith /* ------------------------------------------------------------------------*/ 26110b039ecaSBarry Smith struct _n_TSMonitorLGCtx { 26120b039ecaSBarry Smith PetscDrawLG lg; 26130b039ecaSBarry Smith PetscInt howoften; /* when > 0 uses step % howoften, when negative only final solution plotted */ 2614201da799SBarry Smith PetscInt ksp_its,snes_its; 26150b039ecaSBarry Smith }; 26160b039ecaSBarry Smith 2617d763cef2SBarry Smith 26184a2ae208SSatish Balay #undef __FUNCT__ 2619a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate" 2620d763cef2SBarry Smith /*@C 2621a9f9c1f6SBarry Smith TSMonitorLGCtxCreate - Creates a line graph context for use with 2622a9f9c1f6SBarry Smith TS to monitor the solution process graphically in various ways 2623d763cef2SBarry Smith 2624d763cef2SBarry Smith Collective on TS 2625d763cef2SBarry Smith 2626d763cef2SBarry Smith Input Parameters: 2627d763cef2SBarry Smith + host - the X display to open, or null for the local machine 2628d763cef2SBarry Smith . label - the title to put in the title bar 26297c922b88SBarry Smith . x, y - the screen coordinates of the upper left coordinate of the window 2630a9f9c1f6SBarry Smith . m, n - the screen width and height in pixels 2631a9f9c1f6SBarry Smith - howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time 2632d763cef2SBarry Smith 2633d763cef2SBarry Smith Output Parameter: 26340b039ecaSBarry Smith . ctx - the context 2635d763cef2SBarry Smith 2636d763cef2SBarry Smith Options Database Key: 26374f09c107SBarry Smith + -ts_monitor_lg_timestep - automatically sets line graph monitor 26384f09c107SBarry Smith . -ts_monitor_lg_solution - 263999fdda47SBarry Smith . -ts_monitor_lg_error - 264099fdda47SBarry Smith . -ts_monitor_lg_ksp_iterations - 264199fdda47SBarry Smith . -ts_monitor_lg_snes_iterations - 264299fdda47SBarry Smith - -lg_indicate_data_points <true,false> - indicate the data points (at each time step) on the plot; default is true 2643d763cef2SBarry Smith 2644d763cef2SBarry Smith Notes: 2645a9f9c1f6SBarry Smith Use TSMonitorLGCtxDestroy() to destroy. 2646d763cef2SBarry Smith 2647d763cef2SBarry Smith Level: intermediate 2648d763cef2SBarry Smith 26497c922b88SBarry Smith .keywords: TS, monitor, line graph, residual, seealso 2650d763cef2SBarry Smith 26514f09c107SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError() 26527c922b88SBarry Smith 2653d763cef2SBarry Smith @*/ 2654a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx) 2655d763cef2SBarry Smith { 2656b0a32e0cSBarry Smith PetscDraw win; 2657dfbe8321SBarry Smith PetscErrorCode ierr; 265899fdda47SBarry Smith PetscBool flg = PETSC_TRUE; 2659d763cef2SBarry Smith 2660d763cef2SBarry Smith PetscFunctionBegin; 2661201da799SBarry Smith ierr = PetscNew(struct _n_TSMonitorLGCtx,ctx);CHKERRQ(ierr); 2662a80ad3e0SBarry Smith ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&win);CHKERRQ(ierr); 26633fbbecb0SBarry Smith ierr = PetscDrawSetFromOptions(win);CHKERRQ(ierr); 26640b039ecaSBarry Smith ierr = PetscDrawLGCreate(win,1,&(*ctx)->lg);CHKERRQ(ierr); 26650298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-lg_indicate_data_points",&flg,NULL);CHKERRQ(ierr); 266699fdda47SBarry Smith if (flg) { 26670b039ecaSBarry Smith ierr = PetscDrawLGIndicateDataPoints((*ctx)->lg);CHKERRQ(ierr); 266899fdda47SBarry Smith } 26690b039ecaSBarry Smith ierr = PetscLogObjectParent((*ctx)->lg,win);CHKERRQ(ierr); 2670a9f9c1f6SBarry Smith (*ctx)->howoften = howoften; 2671d763cef2SBarry Smith PetscFunctionReturn(0); 2672d763cef2SBarry Smith } 2673d763cef2SBarry Smith 26744a2ae208SSatish Balay #undef __FUNCT__ 26754f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep" 26764f09c107SBarry Smith PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 2677d763cef2SBarry Smith { 26780b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 2679c32365f1SBarry Smith PetscReal x = ptime,y; 2680dfbe8321SBarry Smith PetscErrorCode ierr; 2681d763cef2SBarry Smith 2682d763cef2SBarry Smith PetscFunctionBegin; 2683a9f9c1f6SBarry Smith if (!n) { 2684a9f9c1f6SBarry Smith PetscDrawAxis axis; 2685a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 2686a9f9c1f6SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time step");CHKERRQ(ierr); 2687a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 2688a9f9c1f6SBarry Smith } 2689c32365f1SBarry Smith ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr); 26900b039ecaSBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 269199fdda47SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften))) || ((ctx->howoften == -1) && (n == -1))) { 26920b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 26933923b477SBarry Smith } 2694d763cef2SBarry Smith PetscFunctionReturn(0); 2695d763cef2SBarry Smith } 2696d763cef2SBarry Smith 26974a2ae208SSatish Balay #undef __FUNCT__ 2698a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy" 2699d763cef2SBarry Smith /*@C 2700a9f9c1f6SBarry Smith TSMonitorLGCtxDestroy - Destroys a line graph context that was created 2701a9f9c1f6SBarry Smith with TSMonitorLGCtxCreate(). 2702d763cef2SBarry Smith 27030b039ecaSBarry Smith Collective on TSMonitorLGCtx 2704d763cef2SBarry Smith 2705d763cef2SBarry Smith Input Parameter: 27060b039ecaSBarry Smith . ctx - the monitor context 2707d763cef2SBarry Smith 2708d763cef2SBarry Smith Level: intermediate 2709d763cef2SBarry Smith 2710d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy 2711d763cef2SBarry Smith 27124f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep(); 2713d763cef2SBarry Smith @*/ 2714a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx) 2715d763cef2SBarry Smith { 2716b0a32e0cSBarry Smith PetscDraw draw; 2717dfbe8321SBarry Smith PetscErrorCode ierr; 2718d763cef2SBarry Smith 2719d763cef2SBarry Smith PetscFunctionBegin; 27200b039ecaSBarry Smith ierr = PetscDrawLGGetDraw((*ctx)->lg,&draw);CHKERRQ(ierr); 27216bf464f9SBarry Smith ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 27220b039ecaSBarry Smith ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr); 27230b039ecaSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 2724d763cef2SBarry Smith PetscFunctionReturn(0); 2725d763cef2SBarry Smith } 2726d763cef2SBarry Smith 27274a2ae208SSatish Balay #undef __FUNCT__ 27284a2ae208SSatish Balay #define __FUNCT__ "TSGetTime" 2729d763cef2SBarry Smith /*@ 2730b8123daeSJed Brown TSGetTime - Gets the time of the most recently completed step. 2731d763cef2SBarry Smith 2732d763cef2SBarry Smith Not Collective 2733d763cef2SBarry Smith 2734d763cef2SBarry Smith Input Parameter: 2735d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2736d763cef2SBarry Smith 2737d763cef2SBarry Smith Output Parameter: 2738d763cef2SBarry Smith . t - the current time 2739d763cef2SBarry Smith 2740d763cef2SBarry Smith Level: beginner 2741d763cef2SBarry Smith 2742b8123daeSJed Brown Note: 2743b8123daeSJed Brown When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(), 2744b8123daeSJed Brown TSSetPreStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated. 2745b8123daeSJed Brown 2746d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 2747d763cef2SBarry Smith 2748d763cef2SBarry Smith .keywords: TS, get, time 2749d763cef2SBarry Smith @*/ 27507087cfbeSBarry Smith PetscErrorCode TSGetTime(TS ts,PetscReal *t) 2751d763cef2SBarry Smith { 2752d763cef2SBarry Smith PetscFunctionBegin; 27530700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2754f7cf8827SBarry Smith PetscValidRealPointer(t,2); 2755d763cef2SBarry Smith *t = ts->ptime; 2756d763cef2SBarry Smith PetscFunctionReturn(0); 2757d763cef2SBarry Smith } 2758d763cef2SBarry Smith 27594a2ae208SSatish Balay #undef __FUNCT__ 27606a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime" 27616a4d4014SLisandro Dalcin /*@ 27626a4d4014SLisandro Dalcin TSSetTime - Allows one to reset the time. 27636a4d4014SLisandro Dalcin 27643f9fe445SBarry Smith Logically Collective on TS 27656a4d4014SLisandro Dalcin 27666a4d4014SLisandro Dalcin Input Parameters: 27676a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 27686a4d4014SLisandro Dalcin - time - the time 27696a4d4014SLisandro Dalcin 27706a4d4014SLisandro Dalcin Level: intermediate 27716a4d4014SLisandro Dalcin 27726a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration() 27736a4d4014SLisandro Dalcin 27746a4d4014SLisandro Dalcin .keywords: TS, set, time 27756a4d4014SLisandro Dalcin @*/ 27767087cfbeSBarry Smith PetscErrorCode TSSetTime(TS ts, PetscReal t) 27776a4d4014SLisandro Dalcin { 27786a4d4014SLisandro Dalcin PetscFunctionBegin; 27790700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2780c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,t,2); 27816a4d4014SLisandro Dalcin ts->ptime = t; 27826a4d4014SLisandro Dalcin PetscFunctionReturn(0); 27836a4d4014SLisandro Dalcin } 27846a4d4014SLisandro Dalcin 27856a4d4014SLisandro Dalcin #undef __FUNCT__ 27864a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix" 2787d763cef2SBarry Smith /*@C 2788d763cef2SBarry Smith TSSetOptionsPrefix - Sets the prefix used for searching for all 2789d763cef2SBarry Smith TS options in the database. 2790d763cef2SBarry Smith 27913f9fe445SBarry Smith Logically Collective on TS 2792d763cef2SBarry Smith 2793d763cef2SBarry Smith Input Parameter: 2794d763cef2SBarry Smith + ts - The TS context 2795d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 2796d763cef2SBarry Smith 2797d763cef2SBarry Smith Notes: 2798d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 2799d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 2800d763cef2SBarry Smith hyphen. 2801d763cef2SBarry Smith 2802d763cef2SBarry Smith Level: advanced 2803d763cef2SBarry Smith 2804d763cef2SBarry Smith .keywords: TS, set, options, prefix, database 2805d763cef2SBarry Smith 2806d763cef2SBarry Smith .seealso: TSSetFromOptions() 2807d763cef2SBarry Smith 2808d763cef2SBarry Smith @*/ 28097087cfbeSBarry Smith PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[]) 2810d763cef2SBarry Smith { 2811dfbe8321SBarry Smith PetscErrorCode ierr; 2812089b2837SJed Brown SNES snes; 2813d763cef2SBarry Smith 2814d763cef2SBarry Smith PetscFunctionBegin; 28150700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2816d763cef2SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 2817089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2818089b2837SJed Brown ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr); 2819d763cef2SBarry Smith PetscFunctionReturn(0); 2820d763cef2SBarry Smith } 2821d763cef2SBarry Smith 2822d763cef2SBarry Smith 28234a2ae208SSatish Balay #undef __FUNCT__ 28244a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix" 2825d763cef2SBarry Smith /*@C 2826d763cef2SBarry Smith TSAppendOptionsPrefix - Appends to the prefix used for searching for all 2827d763cef2SBarry Smith TS options in the database. 2828d763cef2SBarry Smith 28293f9fe445SBarry Smith Logically Collective on TS 2830d763cef2SBarry Smith 2831d763cef2SBarry Smith Input Parameter: 2832d763cef2SBarry Smith + ts - The TS context 2833d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 2834d763cef2SBarry Smith 2835d763cef2SBarry Smith Notes: 2836d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 2837d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 2838d763cef2SBarry Smith hyphen. 2839d763cef2SBarry Smith 2840d763cef2SBarry Smith Level: advanced 2841d763cef2SBarry Smith 2842d763cef2SBarry Smith .keywords: TS, append, options, prefix, database 2843d763cef2SBarry Smith 2844d763cef2SBarry Smith .seealso: TSGetOptionsPrefix() 2845d763cef2SBarry Smith 2846d763cef2SBarry Smith @*/ 28477087cfbeSBarry Smith PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[]) 2848d763cef2SBarry Smith { 2849dfbe8321SBarry Smith PetscErrorCode ierr; 2850089b2837SJed Brown SNES snes; 2851d763cef2SBarry Smith 2852d763cef2SBarry Smith PetscFunctionBegin; 28530700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2854d763cef2SBarry Smith ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 2855089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2856089b2837SJed Brown ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr); 2857d763cef2SBarry Smith PetscFunctionReturn(0); 2858d763cef2SBarry Smith } 2859d763cef2SBarry Smith 28604a2ae208SSatish Balay #undef __FUNCT__ 28614a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix" 2862d763cef2SBarry Smith /*@C 2863d763cef2SBarry Smith TSGetOptionsPrefix - Sets the prefix used for searching for all 2864d763cef2SBarry Smith TS options in the database. 2865d763cef2SBarry Smith 2866d763cef2SBarry Smith Not Collective 2867d763cef2SBarry Smith 2868d763cef2SBarry Smith Input Parameter: 2869d763cef2SBarry Smith . ts - The TS context 2870d763cef2SBarry Smith 2871d763cef2SBarry Smith Output Parameter: 2872d763cef2SBarry Smith . prefix - A pointer to the prefix string used 2873d763cef2SBarry Smith 2874d763cef2SBarry Smith Notes: On the fortran side, the user should pass in a string 'prifix' of 2875d763cef2SBarry Smith sufficient length to hold the prefix. 2876d763cef2SBarry Smith 2877d763cef2SBarry Smith Level: intermediate 2878d763cef2SBarry Smith 2879d763cef2SBarry Smith .keywords: TS, get, options, prefix, database 2880d763cef2SBarry Smith 2881d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix() 2882d763cef2SBarry Smith @*/ 28837087cfbeSBarry Smith PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[]) 2884d763cef2SBarry Smith { 2885dfbe8321SBarry Smith PetscErrorCode ierr; 2886d763cef2SBarry Smith 2887d763cef2SBarry Smith PetscFunctionBegin; 28880700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 28894482741eSBarry Smith PetscValidPointer(prefix,2); 2890d763cef2SBarry Smith ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 2891d763cef2SBarry Smith PetscFunctionReturn(0); 2892d763cef2SBarry Smith } 2893d763cef2SBarry Smith 28944a2ae208SSatish Balay #undef __FUNCT__ 28954a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian" 2896d763cef2SBarry Smith /*@C 2897d763cef2SBarry Smith TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 2898d763cef2SBarry Smith 2899d763cef2SBarry Smith Not Collective, but parallel objects are returned if TS is parallel 2900d763cef2SBarry Smith 2901d763cef2SBarry Smith Input Parameter: 2902d763cef2SBarry Smith . ts - The TS context obtained from TSCreate() 2903d763cef2SBarry Smith 2904d763cef2SBarry Smith Output Parameters: 2905b5abc632SBarry Smith + J - The Jacobian J of F, where U_t = G(U,t) 2906d763cef2SBarry Smith . M - The preconditioner matrix, usually the same as J 2907089b2837SJed Brown . func - Function to compute the Jacobian of the RHS 2908d763cef2SBarry Smith - ctx - User-defined context for Jacobian evaluation routine 2909d763cef2SBarry Smith 29100298fd71SBarry Smith Notes: You can pass in NULL for any return argument you do not need. 2911d763cef2SBarry Smith 2912d763cef2SBarry Smith Level: intermediate 2913d763cef2SBarry Smith 291426d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 2915d763cef2SBarry Smith 2916d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian 2917d763cef2SBarry Smith @*/ 2918089b2837SJed Brown PetscErrorCode TSGetRHSJacobian(TS ts,Mat *J,Mat *M,TSRHSJacobian *func,void **ctx) 2919d763cef2SBarry Smith { 2920089b2837SJed Brown PetscErrorCode ierr; 2921089b2837SJed Brown SNES snes; 292224989b8cSPeter Brune DM dm; 2923089b2837SJed Brown 2924d763cef2SBarry Smith PetscFunctionBegin; 2925089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 29260298fd71SBarry Smith ierr = SNESGetJacobian(snes,J,M,NULL,NULL);CHKERRQ(ierr); 292724989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 292824989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr); 2929d763cef2SBarry Smith PetscFunctionReturn(0); 2930d763cef2SBarry Smith } 2931d763cef2SBarry Smith 29321713a123SBarry Smith #undef __FUNCT__ 29332eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian" 29342eca1d9cSJed Brown /*@C 29352eca1d9cSJed Brown TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 29362eca1d9cSJed Brown 29372eca1d9cSJed Brown Not Collective, but parallel objects are returned if TS is parallel 29382eca1d9cSJed Brown 29392eca1d9cSJed Brown Input Parameter: 29402eca1d9cSJed Brown . ts - The TS context obtained from TSCreate() 29412eca1d9cSJed Brown 29422eca1d9cSJed Brown Output Parameters: 29432eca1d9cSJed Brown + A - The Jacobian of F(t,U,U_t) 29442eca1d9cSJed Brown . B - The preconditioner matrix, often the same as A 29452eca1d9cSJed Brown . f - The function to compute the matrices 29462eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine 29472eca1d9cSJed Brown 29480298fd71SBarry Smith Notes: You can pass in NULL for any return argument you do not need. 29492eca1d9cSJed Brown 29502eca1d9cSJed Brown Level: advanced 29512eca1d9cSJed Brown 29522eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 29532eca1d9cSJed Brown 29542eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian 29552eca1d9cSJed Brown @*/ 29567087cfbeSBarry Smith PetscErrorCode TSGetIJacobian(TS ts,Mat *A,Mat *B,TSIJacobian *f,void **ctx) 29572eca1d9cSJed Brown { 2958089b2837SJed Brown PetscErrorCode ierr; 2959089b2837SJed Brown SNES snes; 296024989b8cSPeter Brune DM dm; 29610910c330SBarry Smith 29622eca1d9cSJed Brown PetscFunctionBegin; 2963089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2964f7d39f7aSBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 29650298fd71SBarry Smith ierr = SNESGetJacobian(snes,A,B,NULL,NULL);CHKERRQ(ierr); 296624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 296724989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr); 29682eca1d9cSJed Brown PetscFunctionReturn(0); 29692eca1d9cSJed Brown } 29702eca1d9cSJed Brown 29716083293cSBarry Smith 29722eca1d9cSJed Brown #undef __FUNCT__ 297383a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution" 29741713a123SBarry Smith /*@C 297583a4ac43SBarry Smith TSMonitorDrawSolution - Monitors progress of the TS solvers by calling 29761713a123SBarry Smith VecView() for the solution at each timestep 29771713a123SBarry Smith 29781713a123SBarry Smith Collective on TS 29791713a123SBarry Smith 29801713a123SBarry Smith Input Parameters: 29811713a123SBarry Smith + ts - the TS context 29821713a123SBarry Smith . step - current time-step 2983142b95e3SSatish Balay . ptime - current time 29840298fd71SBarry Smith - dummy - either a viewer or NULL 29851713a123SBarry Smith 298699fdda47SBarry Smith Options Database: 298799fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 298899fdda47SBarry Smith 298999fdda47SBarry 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 299099fdda47SBarry Smith will look bad 299199fdda47SBarry Smith 29921713a123SBarry Smith Level: intermediate 29931713a123SBarry Smith 29941713a123SBarry Smith .keywords: TS, vector, monitor, view 29951713a123SBarry Smith 2996a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 29971713a123SBarry Smith @*/ 29980910c330SBarry Smith PetscErrorCode TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 29991713a123SBarry Smith { 3000dfbe8321SBarry Smith PetscErrorCode ierr; 300183a4ac43SBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 3002473a3ab2SBarry Smith PetscDraw draw; 30031713a123SBarry Smith 30041713a123SBarry Smith PetscFunctionBegin; 30056083293cSBarry Smith if (!step && ictx->showinitial) { 30066083293cSBarry Smith if (!ictx->initialsolution) { 30070910c330SBarry Smith ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr); 30081713a123SBarry Smith } 30090910c330SBarry Smith ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr); 30106083293cSBarry Smith } 30113fbbecb0SBarry Smith if (!(((ictx->howoften > 0) && (!(step % ictx->howoften)) && (step > -1)) || ((ictx->howoften == -1) && (step == -1)))) PetscFunctionReturn(0); 30120dcf80beSBarry Smith 30136083293cSBarry Smith if (ictx->showinitial) { 30146083293cSBarry Smith PetscReal pause; 30156083293cSBarry Smith ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr); 30166083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr); 30176083293cSBarry Smith ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr); 30186083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr); 30196083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr); 30206083293cSBarry Smith } 30210910c330SBarry Smith ierr = VecView(u,ictx->viewer);CHKERRQ(ierr); 3022473a3ab2SBarry Smith if (ictx->showtimestepandtime) { 3023473a3ab2SBarry Smith PetscReal xl,yl,xr,yr,tw,w,h; 3024473a3ab2SBarry Smith char time[32]; 3025473a3ab2SBarry Smith size_t len; 3026473a3ab2SBarry Smith 3027473a3ab2SBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 3028473a3ab2SBarry Smith ierr = PetscSNPrintf(time,32,"Timestep %d Time %f",(int)step,(double)ptime);CHKERRQ(ierr); 3029473a3ab2SBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 3030473a3ab2SBarry Smith ierr = PetscStrlen(time,&len);CHKERRQ(ierr); 30310298fd71SBarry Smith ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr); 3032473a3ab2SBarry Smith w = xl + .5*(xr - xl) - .5*len*tw; 3033473a3ab2SBarry Smith h = yl + .95*(yr - yl); 3034473a3ab2SBarry Smith ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 3035473a3ab2SBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 3036473a3ab2SBarry Smith } 3037473a3ab2SBarry Smith 30386083293cSBarry Smith if (ictx->showinitial) { 30396083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr); 30406083293cSBarry Smith } 30411713a123SBarry Smith PetscFunctionReturn(0); 30421713a123SBarry Smith } 30431713a123SBarry Smith 30442d5ee99bSBarry Smith #undef __FUNCT__ 30452d5ee99bSBarry Smith #define __FUNCT__ "TSMonitorDrawSolutionPhase" 30462d5ee99bSBarry Smith /*@C 30472d5ee99bSBarry Smith TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram 30482d5ee99bSBarry Smith 30492d5ee99bSBarry Smith Collective on TS 30502d5ee99bSBarry Smith 30512d5ee99bSBarry Smith Input Parameters: 30522d5ee99bSBarry Smith + ts - the TS context 30532d5ee99bSBarry Smith . step - current time-step 30542d5ee99bSBarry Smith . ptime - current time 30552d5ee99bSBarry Smith - dummy - either a viewer or NULL 30562d5ee99bSBarry Smith 30572d5ee99bSBarry Smith Level: intermediate 30582d5ee99bSBarry Smith 30592d5ee99bSBarry Smith .keywords: TS, vector, monitor, view 30602d5ee99bSBarry Smith 30612d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 30622d5ee99bSBarry Smith @*/ 30632d5ee99bSBarry Smith PetscErrorCode TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 30642d5ee99bSBarry Smith { 30652d5ee99bSBarry Smith PetscErrorCode ierr; 30662d5ee99bSBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 30672d5ee99bSBarry Smith PetscDraw draw; 30682d5ee99bSBarry Smith MPI_Comm comm; 30692d5ee99bSBarry Smith PetscInt n; 30702d5ee99bSBarry Smith PetscMPIInt size; 30712d5ee99bSBarry Smith PetscReal xl,yl,xr,yr,tw,w,h; 30722d5ee99bSBarry Smith char time[32]; 30732d5ee99bSBarry Smith size_t len; 30742d5ee99bSBarry Smith const PetscScalar *U; 30752d5ee99bSBarry Smith 30762d5ee99bSBarry Smith PetscFunctionBegin; 30772d5ee99bSBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 30782d5ee99bSBarry Smith ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr); 30792d5ee99bSBarry Smith if (size != 1) SETERRQ(comm,PETSC_ERR_SUP,"Only allowed for sequential runs"); 30802d5ee99bSBarry Smith ierr = VecGetSize(u,&n);CHKERRQ(ierr); 30812d5ee99bSBarry Smith if (n != 2) SETERRQ(comm,PETSC_ERR_SUP,"Only for ODEs with two unknowns"); 30822d5ee99bSBarry Smith 30832d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 30842d5ee99bSBarry Smith 30852d5ee99bSBarry Smith ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr); 30864b363babSBarry Smith ierr = PetscDrawAxisGetLimits(ictx->axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr); 3087ba5783adSMatthew G Knepley if ((PetscRealPart(U[0]) < xl) || (PetscRealPart(U[1]) < yl) || (PetscRealPart(U[0]) > xr) || (PetscRealPart(U[1]) > yr)) { 3088a4494fc1SBarry Smith ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 3089a4494fc1SBarry Smith PetscFunctionReturn(0); 3090a4494fc1SBarry Smith } 30912d5ee99bSBarry Smith if (!step) ictx->color++; 30922d5ee99bSBarry Smith ierr = PetscDrawPoint(draw,PetscRealPart(U[0]),PetscRealPart(U[1]),ictx->color);CHKERRQ(ierr); 30932d5ee99bSBarry Smith ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 30942d5ee99bSBarry Smith 30952d5ee99bSBarry Smith if (ictx->showtimestepandtime) { 30964b363babSBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 30972d5ee99bSBarry Smith ierr = PetscSNPrintf(time,32,"Timestep %d Time %f",(int)step,(double)ptime);CHKERRQ(ierr); 30982d5ee99bSBarry Smith ierr = PetscStrlen(time,&len);CHKERRQ(ierr); 30992d5ee99bSBarry Smith ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr); 31002d5ee99bSBarry Smith w = xl + .5*(xr - xl) - .5*len*tw; 31012d5ee99bSBarry Smith h = yl + .95*(yr - yl); 31022d5ee99bSBarry Smith ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 31032d5ee99bSBarry Smith } 31042d5ee99bSBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 31052d5ee99bSBarry Smith PetscFunctionReturn(0); 31062d5ee99bSBarry Smith } 31072d5ee99bSBarry Smith 31081713a123SBarry Smith 31096c699258SBarry Smith #undef __FUNCT__ 311083a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy" 31116083293cSBarry Smith /*@C 311283a4ac43SBarry Smith TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution() 31136083293cSBarry Smith 31146083293cSBarry Smith Collective on TS 31156083293cSBarry Smith 31166083293cSBarry Smith Input Parameters: 31176083293cSBarry Smith . ctx - the monitor context 31186083293cSBarry Smith 31196083293cSBarry Smith Level: intermediate 31206083293cSBarry Smith 31216083293cSBarry Smith .keywords: TS, vector, monitor, view 31226083293cSBarry Smith 312383a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError() 31246083293cSBarry Smith @*/ 312583a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx) 31266083293cSBarry Smith { 31276083293cSBarry Smith PetscErrorCode ierr; 31286083293cSBarry Smith 31296083293cSBarry Smith PetscFunctionBegin; 31304b363babSBarry Smith ierr = PetscDrawAxisDestroy(&(*ictx)->axis);CHKERRQ(ierr); 313183a4ac43SBarry Smith ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr); 313283a4ac43SBarry Smith ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr); 313383a4ac43SBarry Smith ierr = PetscFree(*ictx);CHKERRQ(ierr); 31346083293cSBarry Smith PetscFunctionReturn(0); 31356083293cSBarry Smith } 31366083293cSBarry Smith 31376083293cSBarry Smith #undef __FUNCT__ 313883a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate" 31396083293cSBarry Smith /*@C 314083a4ac43SBarry Smith TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx 31416083293cSBarry Smith 31426083293cSBarry Smith Collective on TS 31436083293cSBarry Smith 31446083293cSBarry Smith Input Parameter: 31456083293cSBarry Smith . ts - time-step context 31466083293cSBarry Smith 31476083293cSBarry Smith Output Patameter: 31486083293cSBarry Smith . ctx - the monitor context 31496083293cSBarry Smith 315099fdda47SBarry Smith Options Database: 315199fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 315299fdda47SBarry Smith 31536083293cSBarry Smith Level: intermediate 31546083293cSBarry Smith 31556083293cSBarry Smith .keywords: TS, vector, monitor, view 31566083293cSBarry Smith 315783a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx() 31586083293cSBarry Smith @*/ 315983a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx) 31606083293cSBarry Smith { 31616083293cSBarry Smith PetscErrorCode ierr; 31626083293cSBarry Smith 31636083293cSBarry Smith PetscFunctionBegin; 316483a4ac43SBarry Smith ierr = PetscNew(struct _n_TSMonitorDrawCtx,ctx);CHKERRQ(ierr); 316583a4ac43SBarry Smith ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr); 3166e9457bf7SBarry Smith ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr); 3167bbd56ea5SKarl Rupp 316883a4ac43SBarry Smith (*ctx)->howoften = howoften; 3169473a3ab2SBarry Smith (*ctx)->showinitial = PETSC_FALSE; 31700298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr); 3171473a3ab2SBarry Smith 3172473a3ab2SBarry Smith (*ctx)->showtimestepandtime = PETSC_FALSE; 31730298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr); 31742d5ee99bSBarry Smith (*ctx)->color = PETSC_DRAW_WHITE; 31756083293cSBarry Smith PetscFunctionReturn(0); 31766083293cSBarry Smith } 31776083293cSBarry Smith 31786083293cSBarry Smith #undef __FUNCT__ 317983a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError" 31803a471f94SBarry Smith /*@C 318183a4ac43SBarry Smith TSMonitorDrawError - Monitors progress of the TS solvers by calling 31823a471f94SBarry Smith VecView() for the error at each timestep 31833a471f94SBarry Smith 31843a471f94SBarry Smith Collective on TS 31853a471f94SBarry Smith 31863a471f94SBarry Smith Input Parameters: 31873a471f94SBarry Smith + ts - the TS context 31883a471f94SBarry Smith . step - current time-step 31893a471f94SBarry Smith . ptime - current time 31900298fd71SBarry Smith - dummy - either a viewer or NULL 31913a471f94SBarry Smith 31923a471f94SBarry Smith Level: intermediate 31933a471f94SBarry Smith 31943a471f94SBarry Smith .keywords: TS, vector, monitor, view 31953a471f94SBarry Smith 31963a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 31973a471f94SBarry Smith @*/ 31980910c330SBarry Smith PetscErrorCode TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 31993a471f94SBarry Smith { 32003a471f94SBarry Smith PetscErrorCode ierr; 320183a4ac43SBarry Smith TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy; 320283a4ac43SBarry Smith PetscViewer viewer = ctx->viewer; 32033a471f94SBarry Smith Vec work; 32043a471f94SBarry Smith 32053a471f94SBarry Smith PetscFunctionBegin; 32063fbbecb0SBarry Smith if (!(((ctx->howoften > 0) && (!(step % ctx->howoften)) && (step > -1)) || ((ctx->howoften == -1) && (step == -1)))) PetscFunctionReturn(0); 32070910c330SBarry Smith ierr = VecDuplicate(u,&work);CHKERRQ(ierr); 32083a471f94SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr); 32090910c330SBarry Smith ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr); 32103a471f94SBarry Smith ierr = VecView(work,viewer);CHKERRQ(ierr); 32113a471f94SBarry Smith ierr = VecDestroy(&work);CHKERRQ(ierr); 32123a471f94SBarry Smith PetscFunctionReturn(0); 32133a471f94SBarry Smith } 32143a471f94SBarry Smith 32152a34c10cSBarry Smith #include <petsc-private/dmimpl.h> 32163a471f94SBarry Smith #undef __FUNCT__ 32176c699258SBarry Smith #define __FUNCT__ "TSSetDM" 32186c699258SBarry Smith /*@ 32196c699258SBarry Smith TSSetDM - Sets the DM that may be used by some preconditioners 32206c699258SBarry Smith 32213f9fe445SBarry Smith Logically Collective on TS and DM 32226c699258SBarry Smith 32236c699258SBarry Smith Input Parameters: 32246c699258SBarry Smith + ts - the preconditioner context 32256c699258SBarry Smith - dm - the dm 32266c699258SBarry Smith 32276c699258SBarry Smith Level: intermediate 32286c699258SBarry Smith 32296c699258SBarry Smith 32306c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM() 32316c699258SBarry Smith @*/ 32327087cfbeSBarry Smith PetscErrorCode TSSetDM(TS ts,DM dm) 32336c699258SBarry Smith { 32346c699258SBarry Smith PetscErrorCode ierr; 3235089b2837SJed Brown SNES snes; 3236942e3340SBarry Smith DMTS tsdm; 32376c699258SBarry Smith 32386c699258SBarry Smith PetscFunctionBegin; 32390700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 324070663e4aSLisandro Dalcin ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr); 3241942e3340SBarry Smith if (ts->dm) { /* Move the DMTS context over to the new DM unless the new DM already has one */ 32422a34c10cSBarry Smith if (ts->dm->dmts && !dm->dmts) { 3243942e3340SBarry Smith ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr); 3244942e3340SBarry Smith ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr); 324524989b8cSPeter Brune if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */ 324624989b8cSPeter Brune tsdm->originaldm = dm; 324724989b8cSPeter Brune } 324824989b8cSPeter Brune } 32496bf464f9SBarry Smith ierr = DMDestroy(&ts->dm);CHKERRQ(ierr); 325024989b8cSPeter Brune } 32516c699258SBarry Smith ts->dm = dm; 3252bbd56ea5SKarl Rupp 3253089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3254089b2837SJed Brown ierr = SNESSetDM(snes,dm);CHKERRQ(ierr); 32556c699258SBarry Smith PetscFunctionReturn(0); 32566c699258SBarry Smith } 32576c699258SBarry Smith 32586c699258SBarry Smith #undef __FUNCT__ 32596c699258SBarry Smith #define __FUNCT__ "TSGetDM" 32606c699258SBarry Smith /*@ 32616c699258SBarry Smith TSGetDM - Gets the DM that may be used by some preconditioners 32626c699258SBarry Smith 32633f9fe445SBarry Smith Not Collective 32646c699258SBarry Smith 32656c699258SBarry Smith Input Parameter: 32666c699258SBarry Smith . ts - the preconditioner context 32676c699258SBarry Smith 32686c699258SBarry Smith Output Parameter: 32696c699258SBarry Smith . dm - the dm 32706c699258SBarry Smith 32716c699258SBarry Smith Level: intermediate 32726c699258SBarry Smith 32736c699258SBarry Smith 32746c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM() 32756c699258SBarry Smith @*/ 32767087cfbeSBarry Smith PetscErrorCode TSGetDM(TS ts,DM *dm) 32776c699258SBarry Smith { 3278496e6a7aSJed Brown PetscErrorCode ierr; 3279496e6a7aSJed Brown 32806c699258SBarry Smith PetscFunctionBegin; 32810700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3282496e6a7aSJed Brown if (!ts->dm) { 3283ce94432eSBarry Smith ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr); 3284496e6a7aSJed Brown if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 3285496e6a7aSJed Brown } 32866c699258SBarry Smith *dm = ts->dm; 32876c699258SBarry Smith PetscFunctionReturn(0); 32886c699258SBarry Smith } 32891713a123SBarry Smith 32900f5c6efeSJed Brown #undef __FUNCT__ 32910f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction" 32920f5c6efeSJed Brown /*@ 32930f5c6efeSJed Brown SNESTSFormFunction - Function to evaluate nonlinear residual 32940f5c6efeSJed Brown 32953f9fe445SBarry Smith Logically Collective on SNES 32960f5c6efeSJed Brown 32970f5c6efeSJed Brown Input Parameter: 3298d42a1c89SJed Brown + snes - nonlinear solver 32990910c330SBarry Smith . U - the current state at which to evaluate the residual 3300d42a1c89SJed Brown - ctx - user context, must be a TS 33010f5c6efeSJed Brown 33020f5c6efeSJed Brown Output Parameter: 33030f5c6efeSJed Brown . F - the nonlinear residual 33040f5c6efeSJed Brown 33050f5c6efeSJed Brown Notes: 33060f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 33070f5c6efeSJed Brown It is most frequently passed to MatFDColoringSetFunction(). 33080f5c6efeSJed Brown 33090f5c6efeSJed Brown Level: advanced 33100f5c6efeSJed Brown 33110f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction() 33120f5c6efeSJed Brown @*/ 33130910c330SBarry Smith PetscErrorCode SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx) 33140f5c6efeSJed Brown { 33150f5c6efeSJed Brown TS ts = (TS)ctx; 33160f5c6efeSJed Brown PetscErrorCode ierr; 33170f5c6efeSJed Brown 33180f5c6efeSJed Brown PetscFunctionBegin; 33190f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 33200910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 33210f5c6efeSJed Brown PetscValidHeaderSpecific(F,VEC_CLASSID,3); 33220f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,4); 33230910c330SBarry Smith ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr); 33240f5c6efeSJed Brown PetscFunctionReturn(0); 33250f5c6efeSJed Brown } 33260f5c6efeSJed Brown 33270f5c6efeSJed Brown #undef __FUNCT__ 33280f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian" 33290f5c6efeSJed Brown /*@ 33300f5c6efeSJed Brown SNESTSFormJacobian - Function to evaluate the Jacobian 33310f5c6efeSJed Brown 33320f5c6efeSJed Brown Collective on SNES 33330f5c6efeSJed Brown 33340f5c6efeSJed Brown Input Parameter: 33350f5c6efeSJed Brown + snes - nonlinear solver 33360910c330SBarry Smith . U - the current state at which to evaluate the residual 33370f5c6efeSJed Brown - ctx - user context, must be a TS 33380f5c6efeSJed Brown 33390f5c6efeSJed Brown Output Parameter: 33400f5c6efeSJed Brown + A - the Jacobian 33410f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A) 33420f5c6efeSJed Brown - flag - indicates any structure change in the matrix 33430f5c6efeSJed Brown 33440f5c6efeSJed Brown Notes: 33450f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 33460f5c6efeSJed Brown 33470f5c6efeSJed Brown Level: developer 33480f5c6efeSJed Brown 33490f5c6efeSJed Brown .seealso: SNESSetJacobian() 33500f5c6efeSJed Brown @*/ 33510910c330SBarry Smith PetscErrorCode SNESTSFormJacobian(SNES snes,Vec U,Mat *A,Mat *B,MatStructure *flag,void *ctx) 33520f5c6efeSJed Brown { 33530f5c6efeSJed Brown TS ts = (TS)ctx; 33540f5c6efeSJed Brown PetscErrorCode ierr; 33550f5c6efeSJed Brown 33560f5c6efeSJed Brown PetscFunctionBegin; 33570f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 33580910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 33590f5c6efeSJed Brown PetscValidPointer(A,3); 33600f5c6efeSJed Brown PetscValidHeaderSpecific(*A,MAT_CLASSID,3); 33610f5c6efeSJed Brown PetscValidPointer(B,4); 33620f5c6efeSJed Brown PetscValidHeaderSpecific(*B,MAT_CLASSID,4); 33630f5c6efeSJed Brown PetscValidPointer(flag,5); 33640f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,6); 33650910c330SBarry Smith ierr = (ts->ops->snesjacobian)(snes,U,A,B,flag,ts);CHKERRQ(ierr); 33660f5c6efeSJed Brown PetscFunctionReturn(0); 33670f5c6efeSJed Brown } 3368325fc9f4SBarry Smith 33690e4ef248SJed Brown #undef __FUNCT__ 33700e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear" 33710e4ef248SJed Brown /*@C 33720e4ef248SJed Brown TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only 33730e4ef248SJed Brown 33740e4ef248SJed Brown Collective on TS 33750e4ef248SJed Brown 33760e4ef248SJed Brown Input Arguments: 33770e4ef248SJed Brown + ts - time stepping context 33780e4ef248SJed Brown . t - time at which to evaluate 33790910c330SBarry Smith . U - state at which to evaluate 33800e4ef248SJed Brown - ctx - context 33810e4ef248SJed Brown 33820e4ef248SJed Brown Output Arguments: 33830e4ef248SJed Brown . F - right hand side 33840e4ef248SJed Brown 33850e4ef248SJed Brown Level: intermediate 33860e4ef248SJed Brown 33870e4ef248SJed Brown Notes: 33880e4ef248SJed Brown This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems. 33890e4ef248SJed Brown The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian(). 33900e4ef248SJed Brown 33910e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 33920e4ef248SJed Brown @*/ 33930910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx) 33940e4ef248SJed Brown { 33950e4ef248SJed Brown PetscErrorCode ierr; 33960e4ef248SJed Brown Mat Arhs,Brhs; 33970e4ef248SJed Brown MatStructure flg2; 33980e4ef248SJed Brown 33990e4ef248SJed Brown PetscFunctionBegin; 34000e4ef248SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 34010910c330SBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,&Arhs,&Brhs,&flg2);CHKERRQ(ierr); 34020910c330SBarry Smith ierr = MatMult(Arhs,U,F);CHKERRQ(ierr); 34030e4ef248SJed Brown PetscFunctionReturn(0); 34040e4ef248SJed Brown } 34050e4ef248SJed Brown 34060e4ef248SJed Brown #undef __FUNCT__ 34070e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant" 34080e4ef248SJed Brown /*@C 34090e4ef248SJed Brown TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 34100e4ef248SJed Brown 34110e4ef248SJed Brown Collective on TS 34120e4ef248SJed Brown 34130e4ef248SJed Brown Input Arguments: 34140e4ef248SJed Brown + ts - time stepping context 34150e4ef248SJed Brown . t - time at which to evaluate 34160910c330SBarry Smith . U - state at which to evaluate 34170e4ef248SJed Brown - ctx - context 34180e4ef248SJed Brown 34190e4ef248SJed Brown Output Arguments: 34200e4ef248SJed Brown + A - pointer to operator 34210e4ef248SJed Brown . B - pointer to preconditioning matrix 34220e4ef248SJed Brown - flg - matrix structure flag 34230e4ef248SJed Brown 34240e4ef248SJed Brown Level: intermediate 34250e4ef248SJed Brown 34260e4ef248SJed Brown Notes: 34270e4ef248SJed Brown This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems. 34280e4ef248SJed Brown 34290e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear() 34300e4ef248SJed Brown @*/ 34310910c330SBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat *A,Mat *B,MatStructure *flg,void *ctx) 34320e4ef248SJed Brown { 34330e4ef248SJed Brown PetscFunctionBegin; 34340e4ef248SJed Brown *flg = SAME_PRECONDITIONER; 34350e4ef248SJed Brown PetscFunctionReturn(0); 34360e4ef248SJed Brown } 34370e4ef248SJed Brown 34380026cea9SSean Farley #undef __FUNCT__ 34390026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear" 34400026cea9SSean Farley /*@C 34410026cea9SSean Farley TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 34420026cea9SSean Farley 34430026cea9SSean Farley Collective on TS 34440026cea9SSean Farley 34450026cea9SSean Farley Input Arguments: 34460026cea9SSean Farley + ts - time stepping context 34470026cea9SSean Farley . t - time at which to evaluate 34480910c330SBarry Smith . U - state at which to evaluate 34490910c330SBarry Smith . Udot - time derivative of state vector 34500026cea9SSean Farley - ctx - context 34510026cea9SSean Farley 34520026cea9SSean Farley Output Arguments: 34530026cea9SSean Farley . F - left hand side 34540026cea9SSean Farley 34550026cea9SSean Farley Level: intermediate 34560026cea9SSean Farley 34570026cea9SSean Farley Notes: 34580910c330SBarry 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 34590026cea9SSean Farley user is required to write their own TSComputeIFunction. 34600026cea9SSean Farley This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems. 34610026cea9SSean Farley The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian(). 34620026cea9SSean Farley 34630026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant() 34640026cea9SSean Farley @*/ 34650910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx) 34660026cea9SSean Farley { 34670026cea9SSean Farley PetscErrorCode ierr; 34680026cea9SSean Farley Mat A,B; 34690026cea9SSean Farley MatStructure flg2; 34700026cea9SSean Farley 34710026cea9SSean Farley PetscFunctionBegin; 34720298fd71SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 34730910c330SBarry Smith ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,&A,&B,&flg2,PETSC_TRUE);CHKERRQ(ierr); 34740910c330SBarry Smith ierr = MatMult(A,Udot,F);CHKERRQ(ierr); 34750026cea9SSean Farley PetscFunctionReturn(0); 34760026cea9SSean Farley } 34770026cea9SSean Farley 34780026cea9SSean Farley #undef __FUNCT__ 34790026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant" 34800026cea9SSean Farley /*@C 348124e94211SJed Brown TSComputeIJacobianConstant - Reuses a Jacobian that is time-independent. 34820026cea9SSean Farley 34830026cea9SSean Farley Collective on TS 34840026cea9SSean Farley 34850026cea9SSean Farley Input Arguments: 34860026cea9SSean Farley + ts - time stepping context 34870026cea9SSean Farley . t - time at which to evaluate 34880910c330SBarry Smith . U - state at which to evaluate 34890910c330SBarry Smith . Udot - time derivative of state vector 34900026cea9SSean Farley . shift - shift to apply 34910026cea9SSean Farley - ctx - context 34920026cea9SSean Farley 34930026cea9SSean Farley Output Arguments: 34940026cea9SSean Farley + A - pointer to operator 34950026cea9SSean Farley . B - pointer to preconditioning matrix 34960026cea9SSean Farley - flg - matrix structure flag 34970026cea9SSean Farley 34980026cea9SSean Farley Level: intermediate 34990026cea9SSean Farley 35000026cea9SSean Farley Notes: 35010026cea9SSean Farley This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems. 35020026cea9SSean Farley 35030026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear() 35040026cea9SSean Farley @*/ 35050910c330SBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat *A,Mat *B,MatStructure *flg,void *ctx) 35060026cea9SSean Farley { 35070026cea9SSean Farley PetscFunctionBegin; 35080026cea9SSean Farley *flg = SAME_PRECONDITIONER; 35090026cea9SSean Farley PetscFunctionReturn(0); 35100026cea9SSean Farley } 3511e817cc15SEmil Constantinescu #undef __FUNCT__ 3512e817cc15SEmil Constantinescu #define __FUNCT__ "TSGetEquationType" 3513e817cc15SEmil Constantinescu /*@ 3514e817cc15SEmil Constantinescu TSGetEquationType - Gets the type of the equation that TS is solving. 3515e817cc15SEmil Constantinescu 3516e817cc15SEmil Constantinescu Not Collective 3517e817cc15SEmil Constantinescu 3518e817cc15SEmil Constantinescu Input Parameter: 3519e817cc15SEmil Constantinescu . ts - the TS context 3520e817cc15SEmil Constantinescu 3521e817cc15SEmil Constantinescu Output Parameter: 3522e817cc15SEmil Constantinescu . equation_type - see TSEquatioType 3523e817cc15SEmil Constantinescu 3524e817cc15SEmil Constantinescu Level: beginner 3525e817cc15SEmil Constantinescu 3526e817cc15SEmil Constantinescu .keywords: TS, equation type 3527e817cc15SEmil Constantinescu 3528e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType 3529e817cc15SEmil Constantinescu @*/ 3530e817cc15SEmil Constantinescu PetscErrorCode TSGetEquationType(TS ts,TSEquationType *equation_type) 3531e817cc15SEmil Constantinescu { 3532e817cc15SEmil Constantinescu PetscFunctionBegin; 3533e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3534e817cc15SEmil Constantinescu PetscValidPointer(equation_type,2); 3535e817cc15SEmil Constantinescu *equation_type = ts->equation_type; 3536e817cc15SEmil Constantinescu PetscFunctionReturn(0); 3537e817cc15SEmil Constantinescu } 3538e817cc15SEmil Constantinescu 3539e817cc15SEmil Constantinescu #undef __FUNCT__ 3540e817cc15SEmil Constantinescu #define __FUNCT__ "TSSetEquationType" 3541e817cc15SEmil Constantinescu /*@ 3542e817cc15SEmil Constantinescu TSSetEquationType - Sets the type of the equation that TS is solving. 3543e817cc15SEmil Constantinescu 3544e817cc15SEmil Constantinescu Not Collective 3545e817cc15SEmil Constantinescu 3546e817cc15SEmil Constantinescu Input Parameter: 3547e817cc15SEmil Constantinescu + ts - the TS context 3548e817cc15SEmil Constantinescu . equation_type - see TSEquatioType 3549e817cc15SEmil Constantinescu 3550e817cc15SEmil Constantinescu Level: advanced 3551e817cc15SEmil Constantinescu 3552e817cc15SEmil Constantinescu .keywords: TS, equation type 3553e817cc15SEmil Constantinescu 3554e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType 3555e817cc15SEmil Constantinescu @*/ 3556e817cc15SEmil Constantinescu PetscErrorCode TSSetEquationType(TS ts,TSEquationType equation_type) 3557e817cc15SEmil Constantinescu { 3558e817cc15SEmil Constantinescu PetscFunctionBegin; 3559e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3560e817cc15SEmil Constantinescu ts->equation_type = equation_type; 3561e817cc15SEmil Constantinescu PetscFunctionReturn(0); 3562e817cc15SEmil Constantinescu } 35630026cea9SSean Farley 35644af1b03aSJed Brown #undef __FUNCT__ 35654af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason" 35664af1b03aSJed Brown /*@ 35674af1b03aSJed Brown TSGetConvergedReason - Gets the reason the TS iteration was stopped. 35684af1b03aSJed Brown 35694af1b03aSJed Brown Not Collective 35704af1b03aSJed Brown 35714af1b03aSJed Brown Input Parameter: 35724af1b03aSJed Brown . ts - the TS context 35734af1b03aSJed Brown 35744af1b03aSJed Brown Output Parameter: 35754af1b03aSJed Brown . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 35764af1b03aSJed Brown manual pages for the individual convergence tests for complete lists 35774af1b03aSJed Brown 3578487e0bb9SJed Brown Level: beginner 35794af1b03aSJed Brown 3580cd652676SJed Brown Notes: 3581cd652676SJed Brown Can only be called after the call to TSSolve() is complete. 35824af1b03aSJed Brown 35834af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test 35844af1b03aSJed Brown 35854af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason 35864af1b03aSJed Brown @*/ 35874af1b03aSJed Brown PetscErrorCode TSGetConvergedReason(TS ts,TSConvergedReason *reason) 35884af1b03aSJed Brown { 35894af1b03aSJed Brown PetscFunctionBegin; 35904af1b03aSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 35914af1b03aSJed Brown PetscValidPointer(reason,2); 35924af1b03aSJed Brown *reason = ts->reason; 35934af1b03aSJed Brown PetscFunctionReturn(0); 35944af1b03aSJed Brown } 35954af1b03aSJed Brown 3596fb1732b5SBarry Smith #undef __FUNCT__ 3597d6ad946cSShri Abhyankar #define __FUNCT__ "TSSetConvergedReason" 3598d6ad946cSShri Abhyankar /*@ 3599d6ad946cSShri Abhyankar TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve. 3600d6ad946cSShri Abhyankar 3601d6ad946cSShri Abhyankar Not Collective 3602d6ad946cSShri Abhyankar 3603d6ad946cSShri Abhyankar Input Parameter: 3604d6ad946cSShri Abhyankar + ts - the TS context 3605d6ad946cSShri Abhyankar . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 3606d6ad946cSShri Abhyankar manual pages for the individual convergence tests for complete lists 3607d6ad946cSShri Abhyankar 3608f5abba47SShri Abhyankar Level: advanced 3609d6ad946cSShri Abhyankar 3610d6ad946cSShri Abhyankar Notes: 3611d6ad946cSShri Abhyankar Can only be called during TSSolve() is active. 3612d6ad946cSShri Abhyankar 3613d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test 3614d6ad946cSShri Abhyankar 3615d6ad946cSShri Abhyankar .seealso: TSConvergedReason 3616d6ad946cSShri Abhyankar @*/ 3617d6ad946cSShri Abhyankar PetscErrorCode TSSetConvergedReason(TS ts,TSConvergedReason reason) 3618d6ad946cSShri Abhyankar { 3619d6ad946cSShri Abhyankar PetscFunctionBegin; 3620d6ad946cSShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3621d6ad946cSShri Abhyankar ts->reason = reason; 3622d6ad946cSShri Abhyankar PetscFunctionReturn(0); 3623d6ad946cSShri Abhyankar } 3624d6ad946cSShri Abhyankar 3625d6ad946cSShri Abhyankar #undef __FUNCT__ 3626cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime" 3627cc708dedSBarry Smith /*@ 3628cc708dedSBarry Smith TSGetSolveTime - Gets the time after a call to TSSolve() 3629cc708dedSBarry Smith 3630cc708dedSBarry Smith Not Collective 3631cc708dedSBarry Smith 3632cc708dedSBarry Smith Input Parameter: 3633cc708dedSBarry Smith . ts - the TS context 3634cc708dedSBarry Smith 3635cc708dedSBarry Smith Output Parameter: 3636cc708dedSBarry Smith . ftime - the final time. This time should correspond to the final time set with TSSetDuration() 3637cc708dedSBarry Smith 3638487e0bb9SJed Brown Level: beginner 3639cc708dedSBarry Smith 3640cc708dedSBarry Smith Notes: 3641cc708dedSBarry Smith Can only be called after the call to TSSolve() is complete. 3642cc708dedSBarry Smith 3643cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test 3644cc708dedSBarry Smith 3645cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason 3646cc708dedSBarry Smith @*/ 3647cc708dedSBarry Smith PetscErrorCode TSGetSolveTime(TS ts,PetscReal *ftime) 3648cc708dedSBarry Smith { 3649cc708dedSBarry Smith PetscFunctionBegin; 3650cc708dedSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3651cc708dedSBarry Smith PetscValidPointer(ftime,2); 3652cc708dedSBarry Smith *ftime = ts->solvetime; 3653cc708dedSBarry Smith PetscFunctionReturn(0); 3654cc708dedSBarry Smith } 3655cc708dedSBarry Smith 3656cc708dedSBarry Smith #undef __FUNCT__ 36575ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations" 36589f67acb7SJed Brown /*@ 36595ef26d82SJed Brown TSGetSNESIterations - Gets the total number of nonlinear iterations 36609f67acb7SJed Brown used by the time integrator. 36619f67acb7SJed Brown 36629f67acb7SJed Brown Not Collective 36639f67acb7SJed Brown 36649f67acb7SJed Brown Input Parameter: 36659f67acb7SJed Brown . ts - TS context 36669f67acb7SJed Brown 36679f67acb7SJed Brown Output Parameter: 36689f67acb7SJed Brown . nits - number of nonlinear iterations 36699f67acb7SJed Brown 36709f67acb7SJed Brown Notes: 36719f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 36729f67acb7SJed Brown 36739f67acb7SJed Brown Level: intermediate 36749f67acb7SJed Brown 36759f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations 36769f67acb7SJed Brown 36775ef26d82SJed Brown .seealso: TSGetKSPIterations() 36789f67acb7SJed Brown @*/ 36795ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits) 36809f67acb7SJed Brown { 36819f67acb7SJed Brown PetscFunctionBegin; 36829f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 36839f67acb7SJed Brown PetscValidIntPointer(nits,2); 36845ef26d82SJed Brown *nits = ts->snes_its; 36859f67acb7SJed Brown PetscFunctionReturn(0); 36869f67acb7SJed Brown } 36879f67acb7SJed Brown 36889f67acb7SJed Brown #undef __FUNCT__ 36895ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations" 36909f67acb7SJed Brown /*@ 36915ef26d82SJed Brown TSGetKSPIterations - Gets the total number of linear iterations 36929f67acb7SJed Brown used by the time integrator. 36939f67acb7SJed Brown 36949f67acb7SJed Brown Not Collective 36959f67acb7SJed Brown 36969f67acb7SJed Brown Input Parameter: 36979f67acb7SJed Brown . ts - TS context 36989f67acb7SJed Brown 36999f67acb7SJed Brown Output Parameter: 37009f67acb7SJed Brown . lits - number of linear iterations 37019f67acb7SJed Brown 37029f67acb7SJed Brown Notes: 37039f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 37049f67acb7SJed Brown 37059f67acb7SJed Brown Level: intermediate 37069f67acb7SJed Brown 37079f67acb7SJed Brown .keywords: TS, get, number, linear, iterations 37089f67acb7SJed Brown 37095ef26d82SJed Brown .seealso: TSGetSNESIterations(), SNESGetKSPIterations() 37109f67acb7SJed Brown @*/ 37115ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits) 37129f67acb7SJed Brown { 37139f67acb7SJed Brown PetscFunctionBegin; 37149f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 37159f67acb7SJed Brown PetscValidIntPointer(lits,2); 37165ef26d82SJed Brown *lits = ts->ksp_its; 37179f67acb7SJed Brown PetscFunctionReturn(0); 37189f67acb7SJed Brown } 37199f67acb7SJed Brown 37209f67acb7SJed Brown #undef __FUNCT__ 3721cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections" 3722cef5090cSJed Brown /*@ 3723cef5090cSJed Brown TSGetStepRejections - Gets the total number of rejected steps. 3724cef5090cSJed Brown 3725cef5090cSJed Brown Not Collective 3726cef5090cSJed Brown 3727cef5090cSJed Brown Input Parameter: 3728cef5090cSJed Brown . ts - TS context 3729cef5090cSJed Brown 3730cef5090cSJed Brown Output Parameter: 3731cef5090cSJed Brown . rejects - number of steps rejected 3732cef5090cSJed Brown 3733cef5090cSJed Brown Notes: 3734cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 3735cef5090cSJed Brown 3736cef5090cSJed Brown Level: intermediate 3737cef5090cSJed Brown 3738cef5090cSJed Brown .keywords: TS, get, number 3739cef5090cSJed Brown 37405ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails() 3741cef5090cSJed Brown @*/ 3742cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects) 3743cef5090cSJed Brown { 3744cef5090cSJed Brown PetscFunctionBegin; 3745cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3746cef5090cSJed Brown PetscValidIntPointer(rejects,2); 3747cef5090cSJed Brown *rejects = ts->reject; 3748cef5090cSJed Brown PetscFunctionReturn(0); 3749cef5090cSJed Brown } 3750cef5090cSJed Brown 3751cef5090cSJed Brown #undef __FUNCT__ 3752cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures" 3753cef5090cSJed Brown /*@ 3754cef5090cSJed Brown TSGetSNESFailures - Gets the total number of failed SNES solves 3755cef5090cSJed Brown 3756cef5090cSJed Brown Not Collective 3757cef5090cSJed Brown 3758cef5090cSJed Brown Input Parameter: 3759cef5090cSJed Brown . ts - TS context 3760cef5090cSJed Brown 3761cef5090cSJed Brown Output Parameter: 3762cef5090cSJed Brown . fails - number of failed nonlinear solves 3763cef5090cSJed Brown 3764cef5090cSJed Brown Notes: 3765cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 3766cef5090cSJed Brown 3767cef5090cSJed Brown Level: intermediate 3768cef5090cSJed Brown 3769cef5090cSJed Brown .keywords: TS, get, number 3770cef5090cSJed Brown 37715ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures() 3772cef5090cSJed Brown @*/ 3773cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails) 3774cef5090cSJed Brown { 3775cef5090cSJed Brown PetscFunctionBegin; 3776cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3777cef5090cSJed Brown PetscValidIntPointer(fails,2); 3778cef5090cSJed Brown *fails = ts->num_snes_failures; 3779cef5090cSJed Brown PetscFunctionReturn(0); 3780cef5090cSJed Brown } 3781cef5090cSJed Brown 3782cef5090cSJed Brown #undef __FUNCT__ 3783cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections" 3784cef5090cSJed Brown /*@ 3785cef5090cSJed Brown TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails 3786cef5090cSJed Brown 3787cef5090cSJed Brown Not Collective 3788cef5090cSJed Brown 3789cef5090cSJed Brown Input Parameter: 3790cef5090cSJed Brown + ts - TS context 3791cef5090cSJed Brown - rejects - maximum number of rejected steps, pass -1 for unlimited 3792cef5090cSJed Brown 3793cef5090cSJed Brown Notes: 3794cef5090cSJed Brown The counter is reset to zero for each step 3795cef5090cSJed Brown 3796cef5090cSJed Brown Options Database Key: 3797cef5090cSJed Brown . -ts_max_reject - Maximum number of step rejections before a step fails 3798cef5090cSJed Brown 3799cef5090cSJed Brown Level: intermediate 3800cef5090cSJed Brown 3801cef5090cSJed Brown .keywords: TS, set, maximum, number 3802cef5090cSJed Brown 38035ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 3804cef5090cSJed Brown @*/ 3805cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects) 3806cef5090cSJed Brown { 3807cef5090cSJed Brown PetscFunctionBegin; 3808cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3809cef5090cSJed Brown ts->max_reject = rejects; 3810cef5090cSJed Brown PetscFunctionReturn(0); 3811cef5090cSJed Brown } 3812cef5090cSJed Brown 3813cef5090cSJed Brown #undef __FUNCT__ 3814cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures" 3815cef5090cSJed Brown /*@ 3816cef5090cSJed Brown TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves 3817cef5090cSJed Brown 3818cef5090cSJed Brown Not Collective 3819cef5090cSJed Brown 3820cef5090cSJed Brown Input Parameter: 3821cef5090cSJed Brown + ts - TS context 3822cef5090cSJed Brown - fails - maximum number of failed nonlinear solves, pass -1 for unlimited 3823cef5090cSJed Brown 3824cef5090cSJed Brown Notes: 3825cef5090cSJed Brown The counter is reset to zero for each successive call to TSSolve(). 3826cef5090cSJed Brown 3827cef5090cSJed Brown Options Database Key: 3828cef5090cSJed Brown . -ts_max_snes_failures - Maximum number of nonlinear solve failures 3829cef5090cSJed Brown 3830cef5090cSJed Brown Level: intermediate 3831cef5090cSJed Brown 3832cef5090cSJed Brown .keywords: TS, set, maximum, number 3833cef5090cSJed Brown 38345ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason() 3835cef5090cSJed Brown @*/ 3836cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails) 3837cef5090cSJed Brown { 3838cef5090cSJed Brown PetscFunctionBegin; 3839cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3840cef5090cSJed Brown ts->max_snes_failures = fails; 3841cef5090cSJed Brown PetscFunctionReturn(0); 3842cef5090cSJed Brown } 3843cef5090cSJed Brown 3844cef5090cSJed Brown #undef __FUNCT__ 3845cef5090cSJed Brown #define __FUNCT__ "TSSetErrorIfStepFails()" 3846cef5090cSJed Brown /*@ 3847cef5090cSJed Brown TSSetErrorIfStepFails - Error if no step succeeds 3848cef5090cSJed Brown 3849cef5090cSJed Brown Not Collective 3850cef5090cSJed Brown 3851cef5090cSJed Brown Input Parameter: 3852cef5090cSJed Brown + ts - TS context 3853cef5090cSJed Brown - err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure 3854cef5090cSJed Brown 3855cef5090cSJed Brown Options Database Key: 3856cef5090cSJed Brown . -ts_error_if_step_fails - Error if no step succeeds 3857cef5090cSJed Brown 3858cef5090cSJed Brown Level: intermediate 3859cef5090cSJed Brown 3860cef5090cSJed Brown .keywords: TS, set, error 3861cef5090cSJed Brown 38625ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 3863cef5090cSJed Brown @*/ 3864cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err) 3865cef5090cSJed Brown { 3866cef5090cSJed Brown PetscFunctionBegin; 3867cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3868cef5090cSJed Brown ts->errorifstepfailed = err; 3869cef5090cSJed Brown PetscFunctionReturn(0); 3870cef5090cSJed Brown } 3871cef5090cSJed Brown 3872cef5090cSJed Brown #undef __FUNCT__ 3873fb1732b5SBarry Smith #define __FUNCT__ "TSMonitorSolutionBinary" 3874fb1732b5SBarry Smith /*@C 3875fb1732b5SBarry Smith TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file 3876fb1732b5SBarry Smith 3877fb1732b5SBarry Smith Collective on TS 3878fb1732b5SBarry Smith 3879fb1732b5SBarry Smith Input Parameters: 3880fb1732b5SBarry Smith + ts - the TS context 3881fb1732b5SBarry Smith . step - current time-step 3882fb1732b5SBarry Smith . ptime - current time 38830910c330SBarry Smith . u - current state 3884fb1732b5SBarry Smith - viewer - binary viewer 3885fb1732b5SBarry Smith 3886fb1732b5SBarry Smith Level: intermediate 3887fb1732b5SBarry Smith 3888fb1732b5SBarry Smith .keywords: TS, vector, monitor, view 3889fb1732b5SBarry Smith 3890fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 3891fb1732b5SBarry Smith @*/ 38920910c330SBarry Smith PetscErrorCode TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec u,void *viewer) 3893fb1732b5SBarry Smith { 3894fb1732b5SBarry Smith PetscErrorCode ierr; 3895ed81e22dSJed Brown PetscViewer v = (PetscViewer)viewer; 3896fb1732b5SBarry Smith 3897fb1732b5SBarry Smith PetscFunctionBegin; 38980910c330SBarry Smith ierr = VecView(u,v);CHKERRQ(ierr); 3899ed81e22dSJed Brown PetscFunctionReturn(0); 3900ed81e22dSJed Brown } 3901ed81e22dSJed Brown 3902ed81e22dSJed Brown #undef __FUNCT__ 3903ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK" 3904ed81e22dSJed Brown /*@C 3905ed81e22dSJed Brown TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep. 3906ed81e22dSJed Brown 3907ed81e22dSJed Brown Collective on TS 3908ed81e22dSJed Brown 3909ed81e22dSJed Brown Input Parameters: 3910ed81e22dSJed Brown + ts - the TS context 3911ed81e22dSJed Brown . step - current time-step 3912ed81e22dSJed Brown . ptime - current time 39130910c330SBarry Smith . u - current state 3914ed81e22dSJed Brown - filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 3915ed81e22dSJed Brown 3916ed81e22dSJed Brown Level: intermediate 3917ed81e22dSJed Brown 3918ed81e22dSJed Brown Notes: 3919ed81e22dSJed 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. 3920ed81e22dSJed Brown These are named according to the file name template. 3921ed81e22dSJed Brown 3922ed81e22dSJed Brown This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy(). 3923ed81e22dSJed Brown 3924ed81e22dSJed Brown .keywords: TS, vector, monitor, view 3925ed81e22dSJed Brown 3926ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 3927ed81e22dSJed Brown @*/ 39280910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate) 3929ed81e22dSJed Brown { 3930ed81e22dSJed Brown PetscErrorCode ierr; 3931ed81e22dSJed Brown char filename[PETSC_MAX_PATH_LEN]; 3932ed81e22dSJed Brown PetscViewer viewer; 3933ed81e22dSJed Brown 3934ed81e22dSJed Brown PetscFunctionBegin; 39358caf3d72SBarry Smith ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr); 3936ce94432eSBarry Smith ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr); 39370910c330SBarry Smith ierr = VecView(u,viewer);CHKERRQ(ierr); 3938ed81e22dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 3939ed81e22dSJed Brown PetscFunctionReturn(0); 3940ed81e22dSJed Brown } 3941ed81e22dSJed Brown 3942ed81e22dSJed Brown #undef __FUNCT__ 3943ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy" 3944ed81e22dSJed Brown /*@C 3945ed81e22dSJed Brown TSMonitorSolutionVTKDestroy - Destroy context for monitoring 3946ed81e22dSJed Brown 3947ed81e22dSJed Brown Collective on TS 3948ed81e22dSJed Brown 3949ed81e22dSJed Brown Input Parameters: 3950ed81e22dSJed Brown . filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 3951ed81e22dSJed Brown 3952ed81e22dSJed Brown Level: intermediate 3953ed81e22dSJed Brown 3954ed81e22dSJed Brown Note: 3955ed81e22dSJed Brown This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK(). 3956ed81e22dSJed Brown 3957ed81e22dSJed Brown .keywords: TS, vector, monitor, view 3958ed81e22dSJed Brown 3959ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK() 3960ed81e22dSJed Brown @*/ 3961ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate) 3962ed81e22dSJed Brown { 3963ed81e22dSJed Brown PetscErrorCode ierr; 3964ed81e22dSJed Brown 3965ed81e22dSJed Brown PetscFunctionBegin; 3966ed81e22dSJed Brown ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr); 3967fb1732b5SBarry Smith PetscFunctionReturn(0); 3968fb1732b5SBarry Smith } 3969fb1732b5SBarry Smith 397084df9cb4SJed Brown #undef __FUNCT__ 3971ad6bc421SBarry Smith #define __FUNCT__ "TSGetTSAdapt" 397284df9cb4SJed Brown /*@ 3973ad6bc421SBarry Smith TSGetTSAdapt - Get the adaptive controller context for the current method 397484df9cb4SJed Brown 3975ed81e22dSJed Brown Collective on TS if controller has not been created yet 397684df9cb4SJed Brown 397784df9cb4SJed Brown Input Arguments: 3978ed81e22dSJed Brown . ts - time stepping context 397984df9cb4SJed Brown 398084df9cb4SJed Brown Output Arguments: 3981ed81e22dSJed Brown . adapt - adaptive controller 398284df9cb4SJed Brown 398384df9cb4SJed Brown Level: intermediate 398484df9cb4SJed Brown 3985ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose() 398684df9cb4SJed Brown @*/ 3987ad6bc421SBarry Smith PetscErrorCode TSGetTSAdapt(TS ts,TSAdapt *adapt) 398884df9cb4SJed Brown { 398984df9cb4SJed Brown PetscErrorCode ierr; 399084df9cb4SJed Brown 399184df9cb4SJed Brown PetscFunctionBegin; 399284df9cb4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 399384df9cb4SJed Brown PetscValidPointer(adapt,2); 399484df9cb4SJed Brown if (!ts->adapt) { 3995ce94432eSBarry Smith ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr); 39961c3436cfSJed Brown ierr = PetscLogObjectParent(ts,ts->adapt);CHKERRQ(ierr); 39971c3436cfSJed Brown ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr); 399884df9cb4SJed Brown } 399984df9cb4SJed Brown *adapt = ts->adapt; 400084df9cb4SJed Brown PetscFunctionReturn(0); 400184df9cb4SJed Brown } 4002d6ebe24aSShri Abhyankar 4003d6ebe24aSShri Abhyankar #undef __FUNCT__ 40041c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances" 40051c3436cfSJed Brown /*@ 40061c3436cfSJed Brown TSSetTolerances - Set tolerances for local truncation error when using adaptive controller 40071c3436cfSJed Brown 40081c3436cfSJed Brown Logically Collective 40091c3436cfSJed Brown 40101c3436cfSJed Brown Input Arguments: 40111c3436cfSJed Brown + ts - time integration context 40121c3436cfSJed Brown . atol - scalar absolute tolerances, PETSC_DECIDE to leave current value 40130298fd71SBarry Smith . vatol - vector of absolute tolerances or NULL, used in preference to atol if present 40141c3436cfSJed Brown . rtol - scalar relative tolerances, PETSC_DECIDE to leave current value 40150298fd71SBarry Smith - vrtol - vector of relative tolerances or NULL, used in preference to atol if present 40161c3436cfSJed Brown 40171c3436cfSJed Brown Level: beginner 40181c3436cfSJed Brown 4019c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances() 40201c3436cfSJed Brown @*/ 40211c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol) 40221c3436cfSJed Brown { 40231c3436cfSJed Brown PetscErrorCode ierr; 40241c3436cfSJed Brown 40251c3436cfSJed Brown PetscFunctionBegin; 4026c5033834SJed Brown if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol; 40271c3436cfSJed Brown if (vatol) { 40281c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr); 40291c3436cfSJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 4030bbd56ea5SKarl Rupp 40311c3436cfSJed Brown ts->vatol = vatol; 40321c3436cfSJed Brown } 4033c5033834SJed Brown if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol; 40341c3436cfSJed Brown if (vrtol) { 40351c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr); 40361c3436cfSJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 4037bbd56ea5SKarl Rupp 40381c3436cfSJed Brown ts->vrtol = vrtol; 40391c3436cfSJed Brown } 40401c3436cfSJed Brown PetscFunctionReturn(0); 40411c3436cfSJed Brown } 40421c3436cfSJed Brown 40431c3436cfSJed Brown #undef __FUNCT__ 4044c5033834SJed Brown #define __FUNCT__ "TSGetTolerances" 4045c5033834SJed Brown /*@ 4046c5033834SJed Brown TSGetTolerances - Get tolerances for local truncation error when using adaptive controller 4047c5033834SJed Brown 4048c5033834SJed Brown Logically Collective 4049c5033834SJed Brown 4050c5033834SJed Brown Input Arguments: 4051c5033834SJed Brown . ts - time integration context 4052c5033834SJed Brown 4053c5033834SJed Brown Output Arguments: 40540298fd71SBarry Smith + atol - scalar absolute tolerances, NULL to ignore 40550298fd71SBarry Smith . vatol - vector of absolute tolerances, NULL to ignore 40560298fd71SBarry Smith . rtol - scalar relative tolerances, NULL to ignore 40570298fd71SBarry Smith - vrtol - vector of relative tolerances, NULL to ignore 4058c5033834SJed Brown 4059c5033834SJed Brown Level: beginner 4060c5033834SJed Brown 4061c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances() 4062c5033834SJed Brown @*/ 4063c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol) 4064c5033834SJed Brown { 4065c5033834SJed Brown PetscFunctionBegin; 4066c5033834SJed Brown if (atol) *atol = ts->atol; 4067c5033834SJed Brown if (vatol) *vatol = ts->vatol; 4068c5033834SJed Brown if (rtol) *rtol = ts->rtol; 4069c5033834SJed Brown if (vrtol) *vrtol = ts->vrtol; 4070c5033834SJed Brown PetscFunctionReturn(0); 4071c5033834SJed Brown } 4072c5033834SJed Brown 4073c5033834SJed Brown #undef __FUNCT__ 40741c3436cfSJed Brown #define __FUNCT__ "TSErrorNormWRMS" 40751c3436cfSJed Brown /*@ 40761c3436cfSJed Brown TSErrorNormWRMS - compute a weighted norm of the difference between a vector and the current state 40771c3436cfSJed Brown 40781c3436cfSJed Brown Collective on TS 40791c3436cfSJed Brown 40801c3436cfSJed Brown Input Arguments: 40811c3436cfSJed Brown + ts - time stepping context 40821c3436cfSJed Brown - Y - state vector to be compared to ts->vec_sol 40831c3436cfSJed Brown 40841c3436cfSJed Brown Output Arguments: 40851c3436cfSJed Brown . norm - weighted norm, a value of 1.0 is considered small 40861c3436cfSJed Brown 40871c3436cfSJed Brown Level: developer 40881c3436cfSJed Brown 40891c3436cfSJed Brown .seealso: TSSetTolerances() 40901c3436cfSJed Brown @*/ 40911c3436cfSJed Brown PetscErrorCode TSErrorNormWRMS(TS ts,Vec Y,PetscReal *norm) 40921c3436cfSJed Brown { 40931c3436cfSJed Brown PetscErrorCode ierr; 40941c3436cfSJed Brown PetscInt i,n,N; 40950910c330SBarry Smith const PetscScalar *u,*y; 40960910c330SBarry Smith Vec U; 40971c3436cfSJed Brown PetscReal sum,gsum; 40981c3436cfSJed Brown 40991c3436cfSJed Brown PetscFunctionBegin; 41001c3436cfSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 41011c3436cfSJed Brown PetscValidHeaderSpecific(Y,VEC_CLASSID,2); 41021c3436cfSJed Brown PetscValidPointer(norm,3); 41030910c330SBarry Smith U = ts->vec_sol; 41040910c330SBarry Smith PetscCheckSameTypeAndComm(U,1,Y,2); 4105ce94432eSBarry Smith if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"Y cannot be the TS solution vector"); 41061c3436cfSJed Brown 41070910c330SBarry Smith ierr = VecGetSize(U,&N);CHKERRQ(ierr); 41080910c330SBarry Smith ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 41090910c330SBarry Smith ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 41101c3436cfSJed Brown ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 41111c3436cfSJed Brown sum = 0.; 4112ceefc113SJed Brown if (ts->vatol && ts->vrtol) { 4113ceefc113SJed Brown const PetscScalar *atol,*rtol; 4114ceefc113SJed Brown ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 4115ceefc113SJed Brown ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 4116ceefc113SJed Brown for (i=0; i<n; i++) { 41170910c330SBarry Smith PetscReal tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 41180910c330SBarry Smith sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 4119ceefc113SJed Brown } 4120ceefc113SJed Brown ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 4121ceefc113SJed Brown ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 4122ceefc113SJed Brown } else if (ts->vatol) { /* vector atol, scalar rtol */ 4123ceefc113SJed Brown const PetscScalar *atol; 4124ceefc113SJed Brown ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 4125ceefc113SJed Brown for (i=0; i<n; i++) { 41260910c330SBarry Smith PetscReal tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 41270910c330SBarry Smith sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 4128ceefc113SJed Brown } 4129ceefc113SJed Brown ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 4130ceefc113SJed Brown } else if (ts->vrtol) { /* scalar atol, vector rtol */ 4131ceefc113SJed Brown const PetscScalar *rtol; 4132ceefc113SJed Brown ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 4133ceefc113SJed Brown for (i=0; i<n; i++) { 41340910c330SBarry Smith PetscReal tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 41350910c330SBarry Smith sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 4136ceefc113SJed Brown } 4137ceefc113SJed Brown ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 4138ceefc113SJed Brown } else { /* scalar atol, scalar rtol */ 41391c3436cfSJed Brown for (i=0; i<n; i++) { 41400910c330SBarry Smith PetscReal tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 41410910c330SBarry Smith sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 41421c3436cfSJed Brown } 4143ceefc113SJed Brown } 41440910c330SBarry Smith ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 41451c3436cfSJed Brown ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 41461c3436cfSJed Brown 4147ce94432eSBarry Smith ierr = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 41481c3436cfSJed Brown *norm = PetscSqrtReal(gsum / N); 4149ce94432eSBarry Smith if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 41501c3436cfSJed Brown PetscFunctionReturn(0); 41511c3436cfSJed Brown } 41521c3436cfSJed Brown 41531c3436cfSJed Brown #undef __FUNCT__ 41548d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal" 41558d59e960SJed Brown /*@ 41568d59e960SJed Brown TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler 41578d59e960SJed Brown 41588d59e960SJed Brown Logically Collective on TS 41598d59e960SJed Brown 41608d59e960SJed Brown Input Arguments: 41618d59e960SJed Brown + ts - time stepping context 41628d59e960SJed Brown - cfltime - maximum stable time step if using forward Euler (value can be different on each process) 41638d59e960SJed Brown 41648d59e960SJed Brown Note: 41658d59e960SJed Brown After calling this function, the global CFL time can be obtained by calling TSGetCFLTime() 41668d59e960SJed Brown 41678d59e960SJed Brown Level: intermediate 41688d59e960SJed Brown 41698d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL 41708d59e960SJed Brown @*/ 41718d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime) 41728d59e960SJed Brown { 41738d59e960SJed Brown PetscFunctionBegin; 41748d59e960SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 41758d59e960SJed Brown ts->cfltime_local = cfltime; 41768d59e960SJed Brown ts->cfltime = -1.; 41778d59e960SJed Brown PetscFunctionReturn(0); 41788d59e960SJed Brown } 41798d59e960SJed Brown 41808d59e960SJed Brown #undef __FUNCT__ 41818d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime" 41828d59e960SJed Brown /*@ 41838d59e960SJed Brown TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler 41848d59e960SJed Brown 41858d59e960SJed Brown Collective on TS 41868d59e960SJed Brown 41878d59e960SJed Brown Input Arguments: 41888d59e960SJed Brown . ts - time stepping context 41898d59e960SJed Brown 41908d59e960SJed Brown Output Arguments: 41918d59e960SJed Brown . cfltime - maximum stable time step for forward Euler 41928d59e960SJed Brown 41938d59e960SJed Brown Level: advanced 41948d59e960SJed Brown 41958d59e960SJed Brown .seealso: TSSetCFLTimeLocal() 41968d59e960SJed Brown @*/ 41978d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime) 41988d59e960SJed Brown { 41998d59e960SJed Brown PetscErrorCode ierr; 42008d59e960SJed Brown 42018d59e960SJed Brown PetscFunctionBegin; 42028d59e960SJed Brown if (ts->cfltime < 0) { 4203ce94432eSBarry Smith ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 42048d59e960SJed Brown } 42058d59e960SJed Brown *cfltime = ts->cfltime; 42068d59e960SJed Brown PetscFunctionReturn(0); 42078d59e960SJed Brown } 42088d59e960SJed Brown 42098d59e960SJed Brown #undef __FUNCT__ 4210d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds" 4211d6ebe24aSShri Abhyankar /*@ 4212d6ebe24aSShri Abhyankar TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu 4213d6ebe24aSShri Abhyankar 4214d6ebe24aSShri Abhyankar Input Parameters: 4215d6ebe24aSShri Abhyankar . ts - the TS context. 4216d6ebe24aSShri Abhyankar . xl - lower bound. 4217d6ebe24aSShri Abhyankar . xu - upper bound. 4218d6ebe24aSShri Abhyankar 4219d6ebe24aSShri Abhyankar Notes: 4220d6ebe24aSShri Abhyankar If this routine is not called then the lower and upper bounds are set to 422133c0c2ddSJed Brown SNES_VI_NINF and SNES_VI_INF respectively during SNESSetUp(). 4222d6ebe24aSShri Abhyankar 42232bd2b0e6SSatish Balay Level: advanced 42242bd2b0e6SSatish Balay 4225d6ebe24aSShri Abhyankar @*/ 4226d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu) 4227d6ebe24aSShri Abhyankar { 4228d6ebe24aSShri Abhyankar PetscErrorCode ierr; 4229d6ebe24aSShri Abhyankar SNES snes; 4230d6ebe24aSShri Abhyankar 4231d6ebe24aSShri Abhyankar PetscFunctionBegin; 4232d6ebe24aSShri Abhyankar ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4233d6ebe24aSShri Abhyankar ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr); 4234d6ebe24aSShri Abhyankar PetscFunctionReturn(0); 4235d6ebe24aSShri Abhyankar } 4236d6ebe24aSShri Abhyankar 4237325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 4238c6db04a5SJed Brown #include <mex.h> 4239325fc9f4SBarry Smith 4240325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext; 4241325fc9f4SBarry Smith 4242325fc9f4SBarry Smith #undef __FUNCT__ 4243325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab" 4244325fc9f4SBarry Smith /* 4245325fc9f4SBarry Smith TSComputeFunction_Matlab - Calls the function that has been set with 4246325fc9f4SBarry Smith TSSetFunctionMatlab(). 4247325fc9f4SBarry Smith 4248325fc9f4SBarry Smith Collective on TS 4249325fc9f4SBarry Smith 4250325fc9f4SBarry Smith Input Parameters: 4251325fc9f4SBarry Smith + snes - the TS context 42520910c330SBarry Smith - u - input vector 4253325fc9f4SBarry Smith 4254325fc9f4SBarry Smith Output Parameter: 4255325fc9f4SBarry Smith . y - function vector, as set by TSSetFunction() 4256325fc9f4SBarry Smith 4257325fc9f4SBarry Smith Notes: 4258325fc9f4SBarry Smith TSComputeFunction() is typically used within nonlinear solvers 4259325fc9f4SBarry Smith implementations, so most users would not generally call this routine 4260325fc9f4SBarry Smith themselves. 4261325fc9f4SBarry Smith 4262325fc9f4SBarry Smith Level: developer 4263325fc9f4SBarry Smith 4264325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 4265325fc9f4SBarry Smith 4266325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 4267325fc9f4SBarry Smith */ 42680910c330SBarry Smith PetscErrorCode TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx) 4269325fc9f4SBarry Smith { 4270325fc9f4SBarry Smith PetscErrorCode ierr; 4271325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 4272325fc9f4SBarry Smith int nlhs = 1,nrhs = 7; 4273325fc9f4SBarry Smith mxArray *plhs[1],*prhs[7]; 4274325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,ly = 0,ls = 0; 4275325fc9f4SBarry Smith 4276325fc9f4SBarry Smith PetscFunctionBegin; 4277325fc9f4SBarry Smith PetscValidHeaderSpecific(snes,TS_CLASSID,1); 42780910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 42790910c330SBarry Smith PetscValidHeaderSpecific(udot,VEC_CLASSID,4); 4280325fc9f4SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,5); 42810910c330SBarry Smith PetscCheckSameComm(snes,1,u,3); 4282325fc9f4SBarry Smith PetscCheckSameComm(snes,1,y,5); 4283325fc9f4SBarry Smith 4284325fc9f4SBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 42850910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 42860910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr); 42870910c330SBarry Smith ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr); 4288bbd56ea5SKarl Rupp 4289325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 4290325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar(time); 4291325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 4292325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 4293325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)ly); 4294325fc9f4SBarry Smith prhs[5] = mxCreateString(sctx->funcname); 4295325fc9f4SBarry Smith prhs[6] = sctx->ctx; 4296325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr); 4297325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 4298325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 4299325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 4300325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 4301325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 4302325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 4303325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 4304325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 4305325fc9f4SBarry Smith PetscFunctionReturn(0); 4306325fc9f4SBarry Smith } 4307325fc9f4SBarry Smith 4308325fc9f4SBarry Smith 4309325fc9f4SBarry Smith #undef __FUNCT__ 4310325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab" 4311325fc9f4SBarry Smith /* 4312325fc9f4SBarry Smith TSSetFunctionMatlab - Sets the function evaluation routine and function 4313325fc9f4SBarry Smith vector for use by the TS routines in solving ODEs 4314e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 4315325fc9f4SBarry Smith 4316325fc9f4SBarry Smith Logically Collective on TS 4317325fc9f4SBarry Smith 4318325fc9f4SBarry Smith Input Parameters: 4319325fc9f4SBarry Smith + ts - the TS context 4320325fc9f4SBarry Smith - func - function evaluation routine 4321325fc9f4SBarry Smith 4322325fc9f4SBarry Smith Calling sequence of func: 43230910c330SBarry Smith $ func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx); 4324325fc9f4SBarry Smith 4325325fc9f4SBarry Smith Level: beginner 4326325fc9f4SBarry Smith 4327325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 4328325fc9f4SBarry Smith 4329325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 4330325fc9f4SBarry Smith */ 4331cdcf91faSSean Farley PetscErrorCode TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx) 4332325fc9f4SBarry Smith { 4333325fc9f4SBarry Smith PetscErrorCode ierr; 4334325fc9f4SBarry Smith TSMatlabContext *sctx; 4335325fc9f4SBarry Smith 4336325fc9f4SBarry Smith PetscFunctionBegin; 4337325fc9f4SBarry Smith /* currently sctx is memory bleed */ 4338325fc9f4SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 4339325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 4340325fc9f4SBarry Smith /* 4341325fc9f4SBarry Smith This should work, but it doesn't 4342325fc9f4SBarry Smith sctx->ctx = ctx; 4343325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 4344325fc9f4SBarry Smith */ 4345325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 4346bbd56ea5SKarl Rupp 43470298fd71SBarry Smith ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr); 4348325fc9f4SBarry Smith PetscFunctionReturn(0); 4349325fc9f4SBarry Smith } 4350325fc9f4SBarry Smith 4351325fc9f4SBarry Smith #undef __FUNCT__ 4352325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab" 4353325fc9f4SBarry Smith /* 4354325fc9f4SBarry Smith TSComputeJacobian_Matlab - Calls the function that has been set with 4355325fc9f4SBarry Smith TSSetJacobianMatlab(). 4356325fc9f4SBarry Smith 4357325fc9f4SBarry Smith Collective on TS 4358325fc9f4SBarry Smith 4359325fc9f4SBarry Smith Input Parameters: 4360cdcf91faSSean Farley + ts - the TS context 43610910c330SBarry Smith . u - input vector 4362325fc9f4SBarry Smith . A, B - the matrices 4363325fc9f4SBarry Smith - ctx - user context 4364325fc9f4SBarry Smith 4365325fc9f4SBarry Smith Output Parameter: 4366325fc9f4SBarry Smith . flag - structure of the matrix 4367325fc9f4SBarry Smith 4368325fc9f4SBarry Smith Level: developer 4369325fc9f4SBarry Smith 4370325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 4371325fc9f4SBarry Smith 4372325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 4373325fc9f4SBarry Smith @*/ 43740910c330SBarry Smith PetscErrorCode TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat *A,Mat *B,MatStructure *flag, void *ctx) 4375325fc9f4SBarry Smith { 4376325fc9f4SBarry Smith PetscErrorCode ierr; 4377325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 4378325fc9f4SBarry Smith int nlhs = 2,nrhs = 9; 4379325fc9f4SBarry Smith mxArray *plhs[2],*prhs[9]; 4380325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0; 4381325fc9f4SBarry Smith 4382325fc9f4SBarry Smith PetscFunctionBegin; 4383cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 43840910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 4385325fc9f4SBarry Smith 43860910c330SBarry Smith /* call Matlab function in ctx with arguments u and y */ 4387325fc9f4SBarry Smith 4388cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 43890910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 43900910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr); 43910910c330SBarry Smith ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr); 43920910c330SBarry Smith ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr); 4393bbd56ea5SKarl Rupp 4394325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 4395325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar((double)time); 4396325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 4397325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 4398325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)shift); 4399325fc9f4SBarry Smith prhs[5] = mxCreateDoubleScalar((double)lA); 4400325fc9f4SBarry Smith prhs[6] = mxCreateDoubleScalar((double)lB); 4401325fc9f4SBarry Smith prhs[7] = mxCreateString(sctx->funcname); 4402325fc9f4SBarry Smith prhs[8] = sctx->ctx; 4403325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr); 4404325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 4405325fc9f4SBarry Smith *flag = (MatStructure) mxGetScalar(plhs[1]);CHKERRQ(ierr); 4406325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 4407325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 4408325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 4409325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 4410325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 4411325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 4412325fc9f4SBarry Smith mxDestroyArray(prhs[6]); 4413325fc9f4SBarry Smith mxDestroyArray(prhs[7]); 4414325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 4415325fc9f4SBarry Smith mxDestroyArray(plhs[1]); 4416325fc9f4SBarry Smith PetscFunctionReturn(0); 4417325fc9f4SBarry Smith } 4418325fc9f4SBarry Smith 4419325fc9f4SBarry Smith 4420325fc9f4SBarry Smith #undef __FUNCT__ 4421325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab" 4422325fc9f4SBarry Smith /* 4423325fc9f4SBarry Smith TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 4424e3c5b3baSBarry 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 4425325fc9f4SBarry Smith 4426325fc9f4SBarry Smith Logically Collective on TS 4427325fc9f4SBarry Smith 4428325fc9f4SBarry Smith Input Parameters: 4429cdcf91faSSean Farley + ts - the TS context 4430325fc9f4SBarry Smith . A,B - Jacobian matrices 4431325fc9f4SBarry Smith . func - function evaluation routine 4432325fc9f4SBarry Smith - ctx - user context 4433325fc9f4SBarry Smith 4434325fc9f4SBarry Smith Calling sequence of func: 44350910c330SBarry Smith $ flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx); 4436325fc9f4SBarry Smith 4437325fc9f4SBarry Smith 4438325fc9f4SBarry Smith Level: developer 4439325fc9f4SBarry Smith 4440325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 4441325fc9f4SBarry Smith 4442325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 4443325fc9f4SBarry Smith */ 4444cdcf91faSSean Farley PetscErrorCode TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx) 4445325fc9f4SBarry Smith { 4446325fc9f4SBarry Smith PetscErrorCode ierr; 4447325fc9f4SBarry Smith TSMatlabContext *sctx; 4448325fc9f4SBarry Smith 4449325fc9f4SBarry Smith PetscFunctionBegin; 4450325fc9f4SBarry Smith /* currently sctx is memory bleed */ 4451325fc9f4SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 4452325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 4453325fc9f4SBarry Smith /* 4454325fc9f4SBarry Smith This should work, but it doesn't 4455325fc9f4SBarry Smith sctx->ctx = ctx; 4456325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 4457325fc9f4SBarry Smith */ 4458325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 4459bbd56ea5SKarl Rupp 4460cdcf91faSSean Farley ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 4461325fc9f4SBarry Smith PetscFunctionReturn(0); 4462325fc9f4SBarry Smith } 4463325fc9f4SBarry Smith 4464b5b1a830SBarry Smith #undef __FUNCT__ 4465b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab" 4466b5b1a830SBarry Smith /* 4467b5b1a830SBarry Smith TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab(). 4468b5b1a830SBarry Smith 4469b5b1a830SBarry Smith Collective on TS 4470b5b1a830SBarry Smith 4471b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 4472b5b1a830SBarry Smith @*/ 44730910c330SBarry Smith PetscErrorCode TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx) 4474b5b1a830SBarry Smith { 4475b5b1a830SBarry Smith PetscErrorCode ierr; 4476b5b1a830SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 4477a530c242SBarry Smith int nlhs = 1,nrhs = 6; 4478b5b1a830SBarry Smith mxArray *plhs[1],*prhs[6]; 4479b5b1a830SBarry Smith long long int lx = 0,ls = 0; 4480b5b1a830SBarry Smith 4481b5b1a830SBarry Smith PetscFunctionBegin; 4482cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 44830910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,4); 4484b5b1a830SBarry Smith 4485cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 44860910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 4487bbd56ea5SKarl Rupp 4488b5b1a830SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 4489b5b1a830SBarry Smith prhs[1] = mxCreateDoubleScalar((double)it); 4490b5b1a830SBarry Smith prhs[2] = mxCreateDoubleScalar((double)time); 4491b5b1a830SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lx); 4492b5b1a830SBarry Smith prhs[4] = mxCreateString(sctx->funcname); 4493b5b1a830SBarry Smith prhs[5] = sctx->ctx; 4494b5b1a830SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr); 4495b5b1a830SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 4496b5b1a830SBarry Smith mxDestroyArray(prhs[0]); 4497b5b1a830SBarry Smith mxDestroyArray(prhs[1]); 4498b5b1a830SBarry Smith mxDestroyArray(prhs[2]); 4499b5b1a830SBarry Smith mxDestroyArray(prhs[3]); 4500b5b1a830SBarry Smith mxDestroyArray(prhs[4]); 4501b5b1a830SBarry Smith mxDestroyArray(plhs[0]); 4502b5b1a830SBarry Smith PetscFunctionReturn(0); 4503b5b1a830SBarry Smith } 4504b5b1a830SBarry Smith 4505b5b1a830SBarry Smith 4506b5b1a830SBarry Smith #undef __FUNCT__ 4507b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab" 4508b5b1a830SBarry Smith /* 4509b5b1a830SBarry Smith TSMonitorSetMatlab - Sets the monitor function from Matlab 4510b5b1a830SBarry Smith 4511b5b1a830SBarry Smith Level: developer 4512b5b1a830SBarry Smith 4513b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function 4514b5b1a830SBarry Smith 4515b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 4516b5b1a830SBarry Smith */ 4517cdcf91faSSean Farley PetscErrorCode TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx) 4518b5b1a830SBarry Smith { 4519b5b1a830SBarry Smith PetscErrorCode ierr; 4520b5b1a830SBarry Smith TSMatlabContext *sctx; 4521b5b1a830SBarry Smith 4522b5b1a830SBarry Smith PetscFunctionBegin; 4523b5b1a830SBarry Smith /* currently sctx is memory bleed */ 4524b5b1a830SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 4525b5b1a830SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 4526b5b1a830SBarry Smith /* 4527b5b1a830SBarry Smith This should work, but it doesn't 4528b5b1a830SBarry Smith sctx->ctx = ctx; 4529b5b1a830SBarry Smith mexMakeArrayPersistent(sctx->ctx); 4530b5b1a830SBarry Smith */ 4531b5b1a830SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 4532bbd56ea5SKarl Rupp 45330298fd71SBarry Smith ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr); 4534b5b1a830SBarry Smith PetscFunctionReturn(0); 4535b5b1a830SBarry Smith } 4536325fc9f4SBarry Smith #endif 4537b3603a34SBarry Smith 45380b039ecaSBarry Smith 45390b039ecaSBarry Smith 4540b3603a34SBarry Smith #undef __FUNCT__ 45414f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution" 4542b3603a34SBarry Smith /*@C 45434f09c107SBarry Smith TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector 4544b3603a34SBarry Smith in a time based line graph 4545b3603a34SBarry Smith 4546b3603a34SBarry Smith Collective on TS 4547b3603a34SBarry Smith 4548b3603a34SBarry Smith Input Parameters: 4549b3603a34SBarry Smith + ts - the TS context 4550b3603a34SBarry Smith . step - current time-step 4551b3603a34SBarry Smith . ptime - current time 4552b3603a34SBarry Smith - lg - a line graph object 4553b3603a34SBarry Smith 4554b3603a34SBarry Smith Level: intermediate 4555b3603a34SBarry Smith 45560b039ecaSBarry Smith Notes: each process in a parallel run displays its component solutions in a separate window 4557b3603a34SBarry Smith 4558b3603a34SBarry Smith .keywords: TS, vector, monitor, view 4559b3603a34SBarry Smith 4560b3603a34SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 4561b3603a34SBarry Smith @*/ 45620910c330SBarry Smith PetscErrorCode TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 4563b3603a34SBarry Smith { 4564b3603a34SBarry Smith PetscErrorCode ierr; 45650b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 4566b3603a34SBarry Smith const PetscScalar *yy; 456758ff32f7SBarry Smith PetscInt dim; 4568b3603a34SBarry Smith 4569b3603a34SBarry Smith PetscFunctionBegin; 457058ff32f7SBarry Smith if (!step) { 4571a9f9c1f6SBarry Smith PetscDrawAxis axis; 4572a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 4573a9f9c1f6SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr); 45740910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 45750b039ecaSBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 45760b039ecaSBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 457758ff32f7SBarry Smith } 45780910c330SBarry Smith ierr = VecGetArrayRead(u,&yy);CHKERRQ(ierr); 4579e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 4580e3efe391SJed Brown { 4581e3efe391SJed Brown PetscReal *yreal; 4582e3efe391SJed Brown PetscInt i,n; 45830910c330SBarry Smith ierr = VecGetLocalSize(u,&n);CHKERRQ(ierr); 4584e3efe391SJed Brown ierr = PetscMalloc(n*sizeof(PetscReal),&yreal);CHKERRQ(ierr); 4585e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 45860b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 4587e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 4588e3efe391SJed Brown } 4589e3efe391SJed Brown #else 45900b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 4591e3efe391SJed Brown #endif 45920910c330SBarry Smith ierr = VecRestoreArrayRead(u,&yy);CHKERRQ(ierr); 45933fbbecb0SBarry Smith if (((ctx->howoften > 0) && (!(step % ctx->howoften)) && (step > -1)) || ((ctx->howoften == -1) && (step == -1))) { 45940b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 45953923b477SBarry Smith } 4596b3603a34SBarry Smith PetscFunctionReturn(0); 4597b3603a34SBarry Smith } 4598b3603a34SBarry Smith 4599b3603a34SBarry Smith #undef __FUNCT__ 46004f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError" 4601ef20d060SBarry Smith /*@C 46024f09c107SBarry Smith TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector 4603ef20d060SBarry Smith in a time based line graph 4604ef20d060SBarry Smith 4605ef20d060SBarry Smith Collective on TS 4606ef20d060SBarry Smith 4607ef20d060SBarry Smith Input Parameters: 4608ef20d060SBarry Smith + ts - the TS context 4609ef20d060SBarry Smith . step - current time-step 4610ef20d060SBarry Smith . ptime - current time 4611ef20d060SBarry Smith - lg - a line graph object 4612ef20d060SBarry Smith 4613ef20d060SBarry Smith Level: intermediate 4614ef20d060SBarry Smith 4615abd5a294SJed Brown Notes: 4616abd5a294SJed Brown Only for sequential solves. 4617abd5a294SJed Brown 4618abd5a294SJed Brown The user must provide the solution using TSSetSolutionFunction() to use this monitor. 4619abd5a294SJed Brown 4620abd5a294SJed Brown Options Database Keys: 46214f09c107SBarry Smith . -ts_monitor_lg_error - create a graphical monitor of error history 4622ef20d060SBarry Smith 4623ef20d060SBarry Smith .keywords: TS, vector, monitor, view 4624ef20d060SBarry Smith 4625abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 4626ef20d060SBarry Smith @*/ 46270910c330SBarry Smith PetscErrorCode TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 4628ef20d060SBarry Smith { 4629ef20d060SBarry Smith PetscErrorCode ierr; 46300b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 4631ef20d060SBarry Smith const PetscScalar *yy; 4632ef20d060SBarry Smith Vec y; 4633a9f9c1f6SBarry Smith PetscInt dim; 4634ef20d060SBarry Smith 4635ef20d060SBarry Smith PetscFunctionBegin; 4636a9f9c1f6SBarry Smith if (!step) { 4637a9f9c1f6SBarry Smith PetscDrawAxis axis; 4638a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 46391ae185eaSBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr); 46400910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 4641a9f9c1f6SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 4642a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4643a9f9c1f6SBarry Smith } 46440910c330SBarry Smith ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 4645ef20d060SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr); 46460910c330SBarry Smith ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr); 4647ef20d060SBarry Smith ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr); 4648e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 4649e3efe391SJed Brown { 4650e3efe391SJed Brown PetscReal *yreal; 4651e3efe391SJed Brown PetscInt i,n; 4652e3efe391SJed Brown ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr); 4653e3efe391SJed Brown ierr = PetscMalloc(n*sizeof(PetscReal),&yreal);CHKERRQ(ierr); 4654e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 46550b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 4656e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 4657e3efe391SJed Brown } 4658e3efe391SJed Brown #else 46590b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 4660e3efe391SJed Brown #endif 4661ef20d060SBarry Smith ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr); 4662ef20d060SBarry Smith ierr = VecDestroy(&y);CHKERRQ(ierr); 46633fbbecb0SBarry Smith if (((ctx->howoften > 0) && (!(step % ctx->howoften)) && (step > -1)) || ((ctx->howoften == -1) && (step == -1))) { 46640b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 46653923b477SBarry Smith } 4666ef20d060SBarry Smith PetscFunctionReturn(0); 4667ef20d060SBarry Smith } 4668ef20d060SBarry Smith 4669201da799SBarry Smith #undef __FUNCT__ 4670201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations" 4671201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 4672201da799SBarry Smith { 4673201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 4674201da799SBarry Smith PetscReal x = ptime,y; 4675201da799SBarry Smith PetscErrorCode ierr; 4676201da799SBarry Smith PetscInt its; 4677201da799SBarry Smith 4678201da799SBarry Smith PetscFunctionBegin; 4679201da799SBarry Smith if (!n) { 4680201da799SBarry Smith PetscDrawAxis axis; 4681bbd56ea5SKarl Rupp 4682201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 4683201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr); 4684201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4685bbd56ea5SKarl Rupp 4686201da799SBarry Smith ctx->snes_its = 0; 4687201da799SBarry Smith } 4688201da799SBarry Smith ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr); 4689201da799SBarry Smith y = its - ctx->snes_its; 4690201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 46913fbbecb0SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 4692201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 4693201da799SBarry Smith } 4694201da799SBarry Smith ctx->snes_its = its; 4695201da799SBarry Smith PetscFunctionReturn(0); 4696201da799SBarry Smith } 4697201da799SBarry Smith 4698201da799SBarry Smith #undef __FUNCT__ 4699201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations" 4700201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 4701201da799SBarry Smith { 4702201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 4703201da799SBarry Smith PetscReal x = ptime,y; 4704201da799SBarry Smith PetscErrorCode ierr; 4705201da799SBarry Smith PetscInt its; 4706201da799SBarry Smith 4707201da799SBarry Smith PetscFunctionBegin; 4708201da799SBarry Smith if (!n) { 4709201da799SBarry Smith PetscDrawAxis axis; 4710bbd56ea5SKarl Rupp 4711201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 4712201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr); 4713201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4714bbd56ea5SKarl Rupp 4715201da799SBarry Smith ctx->ksp_its = 0; 4716201da799SBarry Smith } 4717201da799SBarry Smith ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr); 4718201da799SBarry Smith y = its - ctx->ksp_its; 4719201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 472099fdda47SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 4721201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 4722201da799SBarry Smith } 4723201da799SBarry Smith ctx->ksp_its = its; 4724201da799SBarry Smith PetscFunctionReturn(0); 4725201da799SBarry Smith } 4726f9c1d6abSBarry Smith 4727f9c1d6abSBarry Smith #undef __FUNCT__ 4728f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability" 4729f9c1d6abSBarry Smith /*@ 4730f9c1d6abSBarry Smith TSComputeLinearStability - computes the linear stability function at a point 4731f9c1d6abSBarry Smith 4732f9c1d6abSBarry Smith Collective on TS and Vec 4733f9c1d6abSBarry Smith 4734f9c1d6abSBarry Smith Input Parameters: 4735f9c1d6abSBarry Smith + ts - the TS context 4736f9c1d6abSBarry Smith - xr,xi - real and imaginary part of input arguments 4737f9c1d6abSBarry Smith 4738f9c1d6abSBarry Smith Output Parameters: 4739f9c1d6abSBarry Smith . yr,yi - real and imaginary part of function value 4740f9c1d6abSBarry Smith 4741f9c1d6abSBarry Smith Level: developer 4742f9c1d6abSBarry Smith 4743f9c1d6abSBarry Smith .keywords: TS, compute 4744f9c1d6abSBarry Smith 4745f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction() 4746f9c1d6abSBarry Smith @*/ 4747f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi) 4748f9c1d6abSBarry Smith { 4749f9c1d6abSBarry Smith PetscErrorCode ierr; 4750f9c1d6abSBarry Smith 4751f9c1d6abSBarry Smith PetscFunctionBegin; 4752f9c1d6abSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4753ce94432eSBarry Smith if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method"); 4754f9c1d6abSBarry Smith ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr); 4755f9c1d6abSBarry Smith PetscFunctionReturn(0); 4756f9c1d6abSBarry Smith } 4757