163dd3a1aSKris Buschelman 2b45d2f2cSJed Brown #include <petsc-private/tsimpl.h> /*I "petscts.h" I*/ 3496e6a7aSJed Brown #include <petscdmshell.h> 4d763cef2SBarry Smith 5d5ba7fb7SMatthew Knepley /* Logging support */ 6d74926cbSBarry Smith PetscClassId TS_CLASSID, DMTS_CLASSID; 7166c7f25SBarry Smith PetscLogEvent TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval; 8d405a339SMatthew Knepley 94a2ae208SSatish Balay #undef __FUNCT__ 10bdad233fSMatthew Knepley #define __FUNCT__ "TSSetTypeFromOptions" 11bdad233fSMatthew Knepley /* 12bdad233fSMatthew Knepley TSSetTypeFromOptions - Sets the type of ts from user options. 13bdad233fSMatthew Knepley 14bdad233fSMatthew Knepley Collective on TS 15bdad233fSMatthew Knepley 16bdad233fSMatthew Knepley Input Parameter: 17bdad233fSMatthew Knepley . ts - The ts 18bdad233fSMatthew Knepley 19bdad233fSMatthew Knepley Level: intermediate 20bdad233fSMatthew Knepley 21bdad233fSMatthew Knepley .keywords: TS, set, options, database, type 22bdad233fSMatthew Knepley .seealso: TSSetFromOptions(), TSSetType() 23bdad233fSMatthew Knepley */ 246849ba73SBarry Smith static PetscErrorCode TSSetTypeFromOptions(TS ts) 25bdad233fSMatthew Knepley { 26ace3abfcSBarry Smith PetscBool opt; 272fc52814SBarry Smith const char *defaultType; 28bdad233fSMatthew Knepley char typeName[256]; 29dfbe8321SBarry Smith PetscErrorCode ierr; 30bdad233fSMatthew Knepley 31bdad233fSMatthew Knepley PetscFunctionBegin; 327adad957SLisandro Dalcin if (((PetscObject)ts)->type_name) { 337adad957SLisandro Dalcin defaultType = ((PetscObject)ts)->type_name; 34bdad233fSMatthew Knepley } else { 359596e0b4SJed Brown defaultType = TSEULER; 36bdad233fSMatthew Knepley } 37bdad233fSMatthew Knepley 38cce0b1b2SLisandro Dalcin if (!TSRegisterAllCalled) {ierr = TSRegisterAll(PETSC_NULL);CHKERRQ(ierr);} 39bdad233fSMatthew Knepley ierr = PetscOptionsList("-ts_type", "TS method"," TSSetType", TSList, defaultType, typeName, 256, &opt);CHKERRQ(ierr); 40a7cc72afSBarry Smith if (opt) { 41bdad233fSMatthew Knepley ierr = TSSetType(ts, typeName);CHKERRQ(ierr); 42bdad233fSMatthew Knepley } else { 43bdad233fSMatthew Knepley ierr = TSSetType(ts, defaultType);CHKERRQ(ierr); 44bdad233fSMatthew Knepley } 45bdad233fSMatthew Knepley PetscFunctionReturn(0); 46bdad233fSMatthew Knepley } 47bdad233fSMatthew Knepley 48bdad233fSMatthew Knepley #undef __FUNCT__ 49bdad233fSMatthew Knepley #define __FUNCT__ "TSSetFromOptions" 50bdad233fSMatthew Knepley /*@ 51bdad233fSMatthew Knepley TSSetFromOptions - Sets various TS parameters from user options. 52bdad233fSMatthew Knepley 53bdad233fSMatthew Knepley Collective on TS 54bdad233fSMatthew Knepley 55bdad233fSMatthew Knepley Input Parameter: 56bdad233fSMatthew Knepley . ts - the TS context obtained from TSCreate() 57bdad233fSMatthew Knepley 58bdad233fSMatthew Knepley Options Database Keys: 594d91e141SJed Brown + -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSGL, TSSSP 60bdad233fSMatthew Knepley . -ts_max_steps maxsteps - maximum number of time-steps to take 613bca7d26SBarry Smith . -ts_final_time time - maximum time to compute to 62bdad233fSMatthew Knepley . -ts_dt dt - initial time step 63bdad233fSMatthew Knepley . -ts_monitor - print information at each timestep 64de06c3feSJed Brown . -ts_monitor_lg_timestep - Monitor timestep size graphically 65de06c3feSJed Brown . -ts_monitor_lg_solution - Monitor solution graphically 66de06c3feSJed Brown . -ts_monitor_lg_error - Monitor error graphically 67de06c3feSJed Brown . -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically 68de06c3feSJed Brown . -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically 69de06c3feSJed Brown . -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically 70de06c3feSJed Brown . -ts_monitor_draw_solution - Monitor solution graphically 71de06c3feSJed Brown . -ts_monitor_draw_solution - Monitor solution graphically 72de06c3feSJed Brown . -ts_monitor_draw_error - Monitor error graphically 73de06c3feSJed Brown . -ts_monitor_draw_solution_binary <filename> - Save each solution to a binary file 74de06c3feSJed Brown - -ts_monitor_draw_solution_vtk <filename.vts> - Save each time step to a binary file, use filename-%%03D.vts 75bdad233fSMatthew Knepley 76bdad233fSMatthew Knepley Level: beginner 77bdad233fSMatthew Knepley 78bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database 79bdad233fSMatthew Knepley 80a313700dSBarry Smith .seealso: TSGetType() 81bdad233fSMatthew Knepley @*/ 827087cfbeSBarry Smith PetscErrorCode TSSetFromOptions(TS ts) 83bdad233fSMatthew Knepley { 84ace3abfcSBarry Smith PetscBool opt,flg; 85dfbe8321SBarry Smith PetscErrorCode ierr; 86649052a6SBarry Smith PetscViewer monviewer; 87eabae89aSBarry Smith char monfilename[PETSC_MAX_PATH_LEN]; 88089b2837SJed Brown SNES snes; 891c3436cfSJed Brown TSAdapt adapt; 9031748224SBarry Smith PetscReal time_step; 91bdad233fSMatthew Knepley 92bdad233fSMatthew Knepley PetscFunctionBegin; 930700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 943194b578SJed Brown ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr); 95a43b19c4SJed Brown /* Handle TS type options */ 96a43b19c4SJed Brown ierr = TSSetTypeFromOptions(ts);CHKERRQ(ierr); 97bdad233fSMatthew Knepley 98bdad233fSMatthew Knepley /* Handle generic TS options */ 99bdad233fSMatthew Knepley ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,PETSC_NULL);CHKERRQ(ierr); 1003bca7d26SBarry Smith ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,PETSC_NULL);CHKERRQ(ierr); 101d8cd7023SBarry Smith ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,PETSC_NULL);CHKERRQ(ierr); 10231748224SBarry Smith ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr); 10331748224SBarry Smith if (flg) { 10431748224SBarry Smith ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 10531748224SBarry Smith } 106a43b19c4SJed Brown opt = ts->exact_final_time == PETSC_DECIDE ? PETSC_FALSE : (PetscBool)ts->exact_final_time; 107a43b19c4SJed Brown ierr = PetscOptionsBool("-ts_exact_final_time","Interpolate output to stop exactly at the final time","TSSetExactFinalTime",opt,&opt,&flg);CHKERRQ(ierr); 108461e00b3SSean Farley if (flg) {ierr = TSSetExactFinalTime(ts,opt);CHKERRQ(ierr);} 109cef5090cSJed Brown ierr = PetscOptionsInt("-ts_max_snes_failures","Maximum number of nonlinear solve failures","TSSetMaxSNESFailures",ts->max_snes_failures,&ts->max_snes_failures,PETSC_NULL);CHKERRQ(ierr); 110cef5090cSJed Brown ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,PETSC_NULL);CHKERRQ(ierr); 111cef5090cSJed Brown ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,PETSC_NULL);CHKERRQ(ierr); 1121c3436cfSJed Brown ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,PETSC_NULL);CHKERRQ(ierr); 1131c3436cfSJed Brown ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,PETSC_NULL);CHKERRQ(ierr); 114bdad233fSMatthew Knepley 115bdad233fSMatthew Knepley /* Monitor options */ 116a6570f20SBarry Smith ierr = PetscOptionsString("-ts_monitor","Monitor timestep size","TSMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 117eabae89aSBarry Smith if (flg) { 118649052a6SBarry Smith ierr = PetscViewerASCIIOpen(((PetscObject)ts)->comm,monfilename,&monviewer);CHKERRQ(ierr); 119649052a6SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 120bdad233fSMatthew Knepley } 1215180491cSLisandro Dalcin ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 1225180491cSLisandro Dalcin if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);} 1235180491cSLisandro Dalcin 1244f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr); 125a7cc72afSBarry Smith if (opt) { 1260b039ecaSBarry Smith TSMonitorLGCtx ctx; 1273923b477SBarry Smith PetscInt howoften = 1; 128a80ad3e0SBarry Smith 1294f09c107SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,PETSC_NULL);CHKERRQ(ierr); 1301d1e9da1SBarry Smith ierr = TSMonitorLGCtxCreate(((PetscObject)ts)->comm,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 1314f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 132b3603a34SBarry Smith } 1334f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr); 134b3603a34SBarry Smith if (opt) { 1350b039ecaSBarry Smith TSMonitorLGCtx ctx; 1363923b477SBarry Smith PetscInt howoften = 1; 137b3603a34SBarry Smith 1384f09c107SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,PETSC_NULL);CHKERRQ(ierr); 1393923b477SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx); 1404f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 141bdad233fSMatthew Knepley } 1424f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr); 143ef20d060SBarry Smith if (opt) { 1440b039ecaSBarry Smith TSMonitorLGCtx ctx; 1453923b477SBarry Smith PetscInt howoften = 1; 146ef20d060SBarry Smith 1474f09c107SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,PETSC_NULL);CHKERRQ(ierr); 1483923b477SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx); 1494f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 150ef20d060SBarry Smith } 151201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr); 152201da799SBarry Smith if (opt) { 153201da799SBarry Smith TSMonitorLGCtx ctx; 154201da799SBarry Smith PetscInt howoften = 1; 155201da799SBarry Smith 156201da799SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,PETSC_NULL);CHKERRQ(ierr); 157201da799SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx); 158201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 159201da799SBarry Smith } 160201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr); 161201da799SBarry Smith if (opt) { 162201da799SBarry Smith TSMonitorLGCtx ctx; 163201da799SBarry Smith PetscInt howoften = 1; 164201da799SBarry Smith 165201da799SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,PETSC_NULL);CHKERRQ(ierr); 166201da799SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx); 167201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 168201da799SBarry Smith } 1698189c53fSBarry Smith ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr); 1708189c53fSBarry Smith if (opt) { 1718189c53fSBarry Smith TSMonitorSPEigCtx ctx; 1728189c53fSBarry Smith PetscInt howoften = 1; 1738189c53fSBarry Smith 1748189c53fSBarry Smith ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,PETSC_NULL);CHKERRQ(ierr); 1758189c53fSBarry Smith ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx); 1768189c53fSBarry Smith ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr); 1778189c53fSBarry Smith } 178ef20d060SBarry Smith opt = PETSC_FALSE; 1790dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr); 180a7cc72afSBarry Smith if (opt) { 18183a4ac43SBarry Smith TSMonitorDrawCtx ctx; 18283a4ac43SBarry Smith PetscInt howoften = 1; 183a80ad3e0SBarry Smith 18483a4ac43SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,PETSC_NULL);CHKERRQ(ierr); 18583a4ac43SBarry Smith ierr = TSMonitorDrawCtxCreate(((PetscObject)ts)->comm,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx); 18683a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 187bdad233fSMatthew Knepley } 188fb1732b5SBarry Smith opt = PETSC_FALSE; 1890dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr); 1903a471f94SBarry Smith if (opt) { 19183a4ac43SBarry Smith TSMonitorDrawCtx ctx; 19283a4ac43SBarry Smith PetscInt howoften = 1; 1933a471f94SBarry Smith 19483a4ac43SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,PETSC_NULL);CHKERRQ(ierr); 19583a4ac43SBarry Smith ierr = TSMonitorDrawCtxCreate(((PetscObject)ts)->comm,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx); 19683a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 1973a471f94SBarry Smith } 1983a471f94SBarry Smith opt = PETSC_FALSE; 199de06c3feSJed Brown ierr = PetscOptionsString("-ts_monitor_draw_solution_binary","Save each solution to a binary file","TSMonitorSolutionBinary",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 200fb1732b5SBarry Smith if (flg) { 201fb1732b5SBarry Smith PetscViewer ctx; 202fb1732b5SBarry Smith if (monfilename[0]) { 203fb1732b5SBarry Smith ierr = PetscViewerBinaryOpen(((PetscObject)ts)->comm,monfilename,FILE_MODE_WRITE,&ctx);CHKERRQ(ierr); 204fb1732b5SBarry Smith } else { 205fb1732b5SBarry Smith ctx = PETSC_VIEWER_BINARY_(((PetscObject)ts)->comm); 206fb1732b5SBarry Smith } 207fb1732b5SBarry Smith ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 208fb1732b5SBarry Smith } 209ed81e22dSJed Brown opt = PETSC_FALSE; 210de06c3feSJed Brown ierr = PetscOptionsString("-ts_monitor_draw_solution_vtk","Save each time step to a binary file, use filename-%%03D.vts","TSMonitorSolutionVTK",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 211ed81e22dSJed Brown if (flg) { 212ed81e22dSJed Brown const char *ptr,*ptr2; 213ed81e22dSJed Brown char *filetemplate; 214de06c3feSJed Brown if (!monfilename[0]) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"-ts_monitor_draw_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 215ed81e22dSJed Brown /* Do some cursory validation of the input. */ 216ed81e22dSJed Brown ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr); 217de06c3feSJed Brown if (!ptr) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"-ts_monitor_draw_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 218ed81e22dSJed Brown for (ptr++ ; ptr && *ptr; ptr++) { 219ed81e22dSJed Brown ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr); 220de06c3feSJed Brown if (!ptr2 && (*ptr < '0' || '9' < *ptr)) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Invalid file template argument to -ts_monitor_draw_solution_vtk, should look like filename-%%03D.vts"); 221ed81e22dSJed Brown if (ptr2) break; 222ed81e22dSJed Brown } 223ed81e22dSJed Brown ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr); 224ed81e22dSJed Brown ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr); 225ed81e22dSJed Brown } 226bdad233fSMatthew Knepley 2271c3436cfSJed Brown ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr); 2281c3436cfSJed Brown ierr = TSAdaptSetFromOptions(adapt);CHKERRQ(ierr); 2291c3436cfSJed Brown 230d52bd9f3SBarry Smith ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 231d52bd9f3SBarry Smith if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);} 232d52bd9f3SBarry Smith 233bdad233fSMatthew Knepley /* Handle specific TS options */ 234abc0a331SBarry Smith if (ts->ops->setfromoptions) { 235bdad233fSMatthew Knepley ierr = (*ts->ops->setfromoptions)(ts);CHKERRQ(ierr); 236bdad233fSMatthew Knepley } 2375d973c19SBarry Smith 2385d973c19SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 2395d973c19SBarry Smith ierr = PetscObjectProcessOptionsHandlers((PetscObject)ts);CHKERRQ(ierr); 240bdad233fSMatthew Knepley ierr = PetscOptionsEnd();CHKERRQ(ierr); 241bdad233fSMatthew Knepley PetscFunctionReturn(0); 242bdad233fSMatthew Knepley } 243bdad233fSMatthew Knepley 244bdad233fSMatthew Knepley #undef __FUNCT__ 245cdcf91faSSean Farley #undef __FUNCT__ 2464a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSJacobian" 247a7a1495cSBarry Smith /*@ 2488c385f81SBarry Smith TSComputeRHSJacobian - Computes the Jacobian matrix that has been 249a7a1495cSBarry Smith set with TSSetRHSJacobian(). 250a7a1495cSBarry Smith 251a7a1495cSBarry Smith Collective on TS and Vec 252a7a1495cSBarry Smith 253a7a1495cSBarry Smith Input Parameters: 254316643e7SJed Brown + ts - the TS context 255a7a1495cSBarry Smith . t - current timestep 2560910c330SBarry Smith - U - input vector 257a7a1495cSBarry Smith 258a7a1495cSBarry Smith Output Parameters: 259a7a1495cSBarry Smith + A - Jacobian matrix 260a7a1495cSBarry Smith . B - optional preconditioning matrix 261a7a1495cSBarry Smith - flag - flag indicating matrix structure 262a7a1495cSBarry Smith 263a7a1495cSBarry Smith Notes: 264a7a1495cSBarry Smith Most users should not need to explicitly call this routine, as it 265a7a1495cSBarry Smith is used internally within the nonlinear solvers. 266a7a1495cSBarry Smith 26794b7f48cSBarry Smith See KSPSetOperators() for important information about setting the 268a7a1495cSBarry Smith flag parameter. 269a7a1495cSBarry Smith 270a7a1495cSBarry Smith Level: developer 271a7a1495cSBarry Smith 272a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix 273a7a1495cSBarry Smith 27494b7f48cSBarry Smith .seealso: TSSetRHSJacobian(), KSPSetOperators() 275a7a1495cSBarry Smith @*/ 2760910c330SBarry Smith PetscErrorCode TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat *A,Mat *B,MatStructure *flg) 277a7a1495cSBarry Smith { 278dfbe8321SBarry Smith PetscErrorCode ierr; 2790910c330SBarry Smith PetscInt Ustate; 28024989b8cSPeter Brune DM dm; 281942e3340SBarry Smith DMTS tsdm; 28224989b8cSPeter Brune TSRHSJacobian rhsjacobianfunc; 28324989b8cSPeter Brune void *ctx; 28424989b8cSPeter Brune TSIJacobian ijacobianfunc; 285a7a1495cSBarry Smith 286a7a1495cSBarry Smith PetscFunctionBegin; 2870700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2880910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 2890910c330SBarry Smith PetscCheckSameComm(ts,1,U,3); 29024989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 291942e3340SBarry Smith ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr); 29224989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr); 29324989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,&ijacobianfunc,PETSC_NULL);CHKERRQ(ierr); 2940910c330SBarry Smith ierr = PetscObjectStateQuery((PetscObject)U,&Ustate);CHKERRQ(ierr); 2950910c330SBarry Smith if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate))) { 2960e4ef248SJed Brown *flg = ts->rhsjacobian.mstructure; 2970e4ef248SJed Brown PetscFunctionReturn(0); 298f8ede8e7SJed Brown } 299d90be118SSean Farley 30024989b8cSPeter Brune if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 301d90be118SSean Farley 30224989b8cSPeter Brune if (rhsjacobianfunc) { 3030910c330SBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,*A,*B);CHKERRQ(ierr); 304a7a1495cSBarry Smith *flg = DIFFERENT_NONZERO_PATTERN; 305a7a1495cSBarry Smith PetscStackPush("TS user Jacobian function"); 3060910c330SBarry Smith ierr = (*rhsjacobianfunc)(ts,t,U,A,B,flg,ctx);CHKERRQ(ierr); 307a7a1495cSBarry Smith PetscStackPop; 3080910c330SBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,*A,*B);CHKERRQ(ierr); 309a7a1495cSBarry Smith /* make sure user returned a correct Jacobian and preconditioner */ 3100700a824SBarry Smith PetscValidHeaderSpecific(*A,MAT_CLASSID,4); 3110700a824SBarry Smith PetscValidHeaderSpecific(*B,MAT_CLASSID,5); 312ef66eb69SBarry Smith } else { 313214bc6a2SJed Brown ierr = MatZeroEntries(*A);CHKERRQ(ierr); 314214bc6a2SJed Brown if (*A != *B) {ierr = MatZeroEntries(*B);CHKERRQ(ierr);} 315214bc6a2SJed Brown *flg = SAME_NONZERO_PATTERN; 316ef66eb69SBarry Smith } 3170e4ef248SJed Brown ts->rhsjacobian.time = t; 3180910c330SBarry Smith ts->rhsjacobian.X = U; 3190910c330SBarry Smith ierr = PetscObjectStateQuery((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr); 3200e4ef248SJed Brown ts->rhsjacobian.mstructure = *flg; 321a7a1495cSBarry Smith PetscFunctionReturn(0); 322a7a1495cSBarry Smith } 323a7a1495cSBarry Smith 3244a2ae208SSatish Balay #undef __FUNCT__ 3254a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction" 326316643e7SJed Brown /*@ 327d763cef2SBarry Smith TSComputeRHSFunction - Evaluates the right-hand-side function. 328d763cef2SBarry Smith 329316643e7SJed Brown Collective on TS and Vec 330316643e7SJed Brown 331316643e7SJed Brown Input Parameters: 332316643e7SJed Brown + ts - the TS context 333316643e7SJed Brown . t - current time 3340910c330SBarry Smith - U - state vector 335316643e7SJed Brown 336316643e7SJed Brown Output Parameter: 337316643e7SJed Brown . y - right hand side 338316643e7SJed Brown 339316643e7SJed Brown Note: 340316643e7SJed Brown Most users should not need to explicitly call this routine, as it 341316643e7SJed Brown is used internally within the nonlinear solvers. 342316643e7SJed Brown 343316643e7SJed Brown Level: developer 344316643e7SJed Brown 345316643e7SJed Brown .keywords: TS, compute 346316643e7SJed Brown 347316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction() 348316643e7SJed Brown @*/ 3490910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y) 350d763cef2SBarry Smith { 351dfbe8321SBarry Smith PetscErrorCode ierr; 35224989b8cSPeter Brune TSRHSFunction rhsfunction; 35324989b8cSPeter Brune TSIFunction ifunction; 35424989b8cSPeter Brune void *ctx; 35524989b8cSPeter Brune DM dm; 35624989b8cSPeter Brune 357d763cef2SBarry Smith PetscFunctionBegin; 3580700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3590910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3600700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,4); 36124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 36224989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 36324989b8cSPeter Brune ierr = DMTSGetIFunction(dm,&ifunction,PETSC_NULL);CHKERRQ(ierr); 364d763cef2SBarry Smith 36524989b8cSPeter Brune if (!rhsfunction && !ifunction) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 366d763cef2SBarry Smith 3670910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 36824989b8cSPeter Brune if (rhsfunction) { 369d763cef2SBarry Smith PetscStackPush("TS user right-hand-side function"); 3700910c330SBarry Smith ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr); 371d763cef2SBarry Smith PetscStackPop; 372214bc6a2SJed Brown } else { 373214bc6a2SJed Brown ierr = VecZeroEntries(y);CHKERRQ(ierr); 374b2cd27e8SJed Brown } 37544a41b28SSean Farley 3760910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 377d763cef2SBarry Smith PetscFunctionReturn(0); 378d763cef2SBarry Smith } 379d763cef2SBarry Smith 3804a2ae208SSatish Balay #undef __FUNCT__ 381ef20d060SBarry Smith #define __FUNCT__ "TSComputeSolutionFunction" 382ef20d060SBarry Smith /*@ 383ef20d060SBarry Smith TSComputeSolutionFunction - Evaluates the solution function. 384ef20d060SBarry Smith 385ef20d060SBarry Smith Collective on TS and Vec 386ef20d060SBarry Smith 387ef20d060SBarry Smith Input Parameters: 388ef20d060SBarry Smith + ts - the TS context 389ef20d060SBarry Smith - t - current time 390ef20d060SBarry Smith 391ef20d060SBarry Smith Output Parameter: 3920910c330SBarry Smith . U - the solution 393ef20d060SBarry Smith 394ef20d060SBarry Smith Note: 395ef20d060SBarry Smith Most users should not need to explicitly call this routine, as it 396ef20d060SBarry Smith is used internally within the nonlinear solvers. 397ef20d060SBarry Smith 398ef20d060SBarry Smith Level: developer 399ef20d060SBarry Smith 400ef20d060SBarry Smith .keywords: TS, compute 401ef20d060SBarry Smith 402abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 403ef20d060SBarry Smith @*/ 4040910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U) 405ef20d060SBarry Smith { 406ef20d060SBarry Smith PetscErrorCode ierr; 407ef20d060SBarry Smith TSSolutionFunction solutionfunction; 408ef20d060SBarry Smith void *ctx; 409ef20d060SBarry Smith DM dm; 410ef20d060SBarry Smith 411ef20d060SBarry Smith PetscFunctionBegin; 412ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4130910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 414ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 415ef20d060SBarry Smith ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr); 416ef20d060SBarry Smith 417ef20d060SBarry Smith if (solutionfunction) { 418ef20d060SBarry Smith PetscStackPush("TS user right-hand-side function"); 4190910c330SBarry Smith ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr); 420ef20d060SBarry Smith PetscStackPop; 421ef20d060SBarry Smith } 422ef20d060SBarry Smith PetscFunctionReturn(0); 423ef20d060SBarry Smith } 424ef20d060SBarry Smith 425ef20d060SBarry Smith #undef __FUNCT__ 426214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private" 427214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs) 428214bc6a2SJed Brown { 4292dd45cf8SJed Brown Vec F; 430214bc6a2SJed Brown PetscErrorCode ierr; 431214bc6a2SJed Brown 432214bc6a2SJed Brown PetscFunctionBegin; 4330da9a4f0SJed Brown *Frhs = PETSC_NULL; 4342dd45cf8SJed Brown ierr = TSGetIFunction(ts,&F,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 435214bc6a2SJed Brown if (!ts->Frhs) { 4362dd45cf8SJed Brown ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr); 437214bc6a2SJed Brown } 438214bc6a2SJed Brown *Frhs = ts->Frhs; 439214bc6a2SJed Brown PetscFunctionReturn(0); 440214bc6a2SJed Brown } 441214bc6a2SJed Brown 442214bc6a2SJed Brown #undef __FUNCT__ 443214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private" 444214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs) 445214bc6a2SJed Brown { 446214bc6a2SJed Brown Mat A,B; 4472dd45cf8SJed Brown PetscErrorCode ierr; 448214bc6a2SJed Brown 449214bc6a2SJed Brown PetscFunctionBegin; 450214bc6a2SJed Brown ierr = TSGetIJacobian(ts,&A,&B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 451214bc6a2SJed Brown if (Arhs) { 452214bc6a2SJed Brown if (!ts->Arhs) { 453214bc6a2SJed Brown ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr); 454214bc6a2SJed Brown } 455214bc6a2SJed Brown *Arhs = ts->Arhs; 456214bc6a2SJed Brown } 457214bc6a2SJed Brown if (Brhs) { 458214bc6a2SJed Brown if (!ts->Brhs) { 459214bc6a2SJed Brown ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr); 460214bc6a2SJed Brown } 461214bc6a2SJed Brown *Brhs = ts->Brhs; 462214bc6a2SJed Brown } 463214bc6a2SJed Brown PetscFunctionReturn(0); 464214bc6a2SJed Brown } 465214bc6a2SJed Brown 466214bc6a2SJed Brown #undef __FUNCT__ 467316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction" 468316643e7SJed Brown /*@ 4690910c330SBarry Smith TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0 470316643e7SJed Brown 471316643e7SJed Brown Collective on TS and Vec 472316643e7SJed Brown 473316643e7SJed Brown Input Parameters: 474316643e7SJed Brown + ts - the TS context 475316643e7SJed Brown . t - current time 4760910c330SBarry Smith . U - state vector 4770910c330SBarry Smith . Udot - time derivative of state vector 478214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate 479316643e7SJed Brown 480316643e7SJed Brown Output Parameter: 481316643e7SJed Brown . Y - right hand side 482316643e7SJed Brown 483316643e7SJed Brown Note: 484316643e7SJed Brown Most users should not need to explicitly call this routine, as it 485316643e7SJed Brown is used internally within the nonlinear solvers. 486316643e7SJed Brown 487316643e7SJed Brown If the user did did not write their equations in implicit form, this 488316643e7SJed Brown function recasts them in implicit form. 489316643e7SJed Brown 490316643e7SJed Brown Level: developer 491316643e7SJed Brown 492316643e7SJed Brown .keywords: TS, compute 493316643e7SJed Brown 494316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction() 495316643e7SJed Brown @*/ 4960910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex) 497316643e7SJed Brown { 498316643e7SJed Brown PetscErrorCode ierr; 49924989b8cSPeter Brune TSIFunction ifunction; 50024989b8cSPeter Brune TSRHSFunction rhsfunction; 50124989b8cSPeter Brune void *ctx; 50224989b8cSPeter Brune DM dm; 503316643e7SJed Brown 504316643e7SJed Brown PetscFunctionBegin; 5050700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5060910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 5070910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 5080700a824SBarry Smith PetscValidHeaderSpecific(Y,VEC_CLASSID,5); 509316643e7SJed Brown 51024989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 51124989b8cSPeter Brune ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr); 51224989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,&rhsfunction,PETSC_NULL);CHKERRQ(ierr); 51324989b8cSPeter Brune 51424989b8cSPeter Brune if (!rhsfunction && !ifunction) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 515d90be118SSean Farley 5160910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 51724989b8cSPeter Brune if (ifunction) { 518316643e7SJed Brown PetscStackPush("TS user implicit function"); 5190910c330SBarry Smith ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr); 520316643e7SJed Brown PetscStackPop; 521214bc6a2SJed Brown } 522214bc6a2SJed Brown if (imex) { 52324989b8cSPeter Brune if (!ifunction) { 5240910c330SBarry Smith ierr = VecCopy(Udot,Y);CHKERRQ(ierr); 5252dd45cf8SJed Brown } 52624989b8cSPeter Brune } else if (rhsfunction) { 52724989b8cSPeter Brune if (ifunction) { 528214bc6a2SJed Brown Vec Frhs; 529214bc6a2SJed Brown ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 5300910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 531214bc6a2SJed Brown ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr); 5322dd45cf8SJed Brown } else { 5330910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr); 5340910c330SBarry Smith ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr); 535316643e7SJed Brown } 5364a6899ffSJed Brown } 5370910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 538316643e7SJed Brown PetscFunctionReturn(0); 539316643e7SJed Brown } 540316643e7SJed Brown 541316643e7SJed Brown #undef __FUNCT__ 542316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian" 543316643e7SJed Brown /*@ 544316643e7SJed Brown TSComputeIJacobian - Evaluates the Jacobian of the DAE 545316643e7SJed Brown 546316643e7SJed Brown Collective on TS and Vec 547316643e7SJed Brown 548316643e7SJed Brown Input 549316643e7SJed Brown Input Parameters: 550316643e7SJed Brown + ts - the TS context 551316643e7SJed Brown . t - current timestep 5520910c330SBarry Smith . U - state vector 5530910c330SBarry Smith . Udot - time derivative of state vector 554214bc6a2SJed Brown . shift - shift to apply, see note below 555214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate 556316643e7SJed Brown 557316643e7SJed Brown Output Parameters: 558316643e7SJed Brown + A - Jacobian matrix 559316643e7SJed Brown . B - optional preconditioning matrix 560316643e7SJed Brown - flag - flag indicating matrix structure 561316643e7SJed Brown 562316643e7SJed Brown Notes: 5630910c330SBarry Smith If F(t,U,Udot)=0 is the DAE, the required Jacobian is 564316643e7SJed Brown 5650910c330SBarry Smith dF/dU + shift*dF/dUdot 566316643e7SJed Brown 567316643e7SJed Brown Most users should not need to explicitly call this routine, as it 568316643e7SJed Brown is used internally within the nonlinear solvers. 569316643e7SJed Brown 570316643e7SJed Brown Level: developer 571316643e7SJed Brown 572316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix 573316643e7SJed Brown 574316643e7SJed Brown .seealso: TSSetIJacobian() 57563495f91SJed Brown @*/ 5760910c330SBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat *A,Mat *B,MatStructure *flg,PetscBool imex) 577316643e7SJed Brown { 5780910c330SBarry Smith PetscInt Ustate, Udotstate; 579316643e7SJed Brown PetscErrorCode ierr; 58024989b8cSPeter Brune TSIJacobian ijacobian; 58124989b8cSPeter Brune TSRHSJacobian rhsjacobian; 58224989b8cSPeter Brune DM dm; 58324989b8cSPeter Brune void *ctx; 584316643e7SJed Brown 585316643e7SJed Brown PetscFunctionBegin; 58624989b8cSPeter Brune 5870700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5880910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 5890910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 590316643e7SJed Brown PetscValidPointer(A,6); 5910700a824SBarry Smith PetscValidHeaderSpecific(*A,MAT_CLASSID,6); 592316643e7SJed Brown PetscValidPointer(B,7); 5930700a824SBarry Smith PetscValidHeaderSpecific(*B,MAT_CLASSID,7); 594316643e7SJed Brown PetscValidPointer(flg,8); 59524989b8cSPeter Brune 59624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 59724989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr); 59824989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,PETSC_NULL);CHKERRQ(ierr); 59924989b8cSPeter Brune 6000910c330SBarry Smith ierr = PetscObjectStateQuery((PetscObject)U,&Ustate);CHKERRQ(ierr); 6010910c330SBarry Smith ierr = PetscObjectStateQuery((PetscObject)Udot,&Udotstate);CHKERRQ(ierr); 6020910c330SBarry 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))) { 6030026cea9SSean Farley *flg = ts->ijacobian.mstructure; 6040026cea9SSean Farley ierr = MatScale(*A, shift / ts->ijacobian.shift);CHKERRQ(ierr); 6050026cea9SSean Farley PetscFunctionReturn(0); 6060026cea9SSean Farley } 607316643e7SJed Brown 60824989b8cSPeter Brune if (!rhsjacobian && !ijacobian) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 609316643e7SJed Brown 6104e684422SJed Brown *flg = SAME_NONZERO_PATTERN; /* In case we're solving a linear problem in which case it wouldn't get initialized below. */ 6110910c330SBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,*A,*B);CHKERRQ(ierr); 61224989b8cSPeter Brune if (ijacobian) { 6132dd45cf8SJed Brown *flg = DIFFERENT_NONZERO_PATTERN; 614316643e7SJed Brown PetscStackPush("TS user implicit Jacobian"); 6150910c330SBarry Smith ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,flg,ctx);CHKERRQ(ierr); 616316643e7SJed Brown PetscStackPop; 617214bc6a2SJed Brown /* make sure user returned a correct Jacobian and preconditioner */ 618214bc6a2SJed Brown PetscValidHeaderSpecific(*A,MAT_CLASSID,4); 619214bc6a2SJed Brown PetscValidHeaderSpecific(*B,MAT_CLASSID,5); 6204a6899ffSJed Brown } 621214bc6a2SJed Brown if (imex) { 622b5abc632SBarry Smith if (!ijacobian) { /* system was written as Udot = G(t,U) */ 623214bc6a2SJed Brown ierr = MatZeroEntries(*A);CHKERRQ(ierr); 6242dd45cf8SJed Brown ierr = MatShift(*A,shift);CHKERRQ(ierr); 625214bc6a2SJed Brown if (*A != *B) { 626214bc6a2SJed Brown ierr = MatZeroEntries(*B);CHKERRQ(ierr); 627214bc6a2SJed Brown ierr = MatShift(*B,shift);CHKERRQ(ierr); 628214bc6a2SJed Brown } 629214bc6a2SJed Brown *flg = SAME_PRECONDITIONER; 630214bc6a2SJed Brown } 631214bc6a2SJed Brown } else { 63224989b8cSPeter Brune if (!ijacobian) { 6330910c330SBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,A,B,flg);CHKERRQ(ierr); 634214bc6a2SJed Brown ierr = MatScale(*A,-1);CHKERRQ(ierr); 635214bc6a2SJed Brown ierr = MatShift(*A,shift);CHKERRQ(ierr); 636316643e7SJed Brown if (*A != *B) { 637316643e7SJed Brown ierr = MatScale(*B,-1);CHKERRQ(ierr); 638316643e7SJed Brown ierr = MatShift(*B,shift);CHKERRQ(ierr); 639316643e7SJed Brown } 64024989b8cSPeter Brune } else if (rhsjacobian) { 641214bc6a2SJed Brown Mat Arhs,Brhs; 642214bc6a2SJed Brown MatStructure axpy,flg2 = DIFFERENT_NONZERO_PATTERN; 643214bc6a2SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 6440910c330SBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,&Arhs,&Brhs,&flg2);CHKERRQ(ierr); 645214bc6a2SJed Brown axpy = (*flg == flg2) ? SAME_NONZERO_PATTERN : DIFFERENT_NONZERO_PATTERN; 646214bc6a2SJed Brown ierr = MatAXPY(*A,-1,Arhs,axpy);CHKERRQ(ierr); 647214bc6a2SJed Brown if (*A != *B) { 648214bc6a2SJed Brown ierr = MatAXPY(*B,-1,Brhs,axpy);CHKERRQ(ierr); 649214bc6a2SJed Brown } 650214bc6a2SJed Brown *flg = PetscMin(*flg,flg2); 651214bc6a2SJed Brown } 652316643e7SJed Brown } 6530026cea9SSean Farley 6540026cea9SSean Farley ts->ijacobian.time = t; 6550910c330SBarry Smith ts->ijacobian.X = U; 6560910c330SBarry Smith ts->ijacobian.Xdot = Udot; 6570910c330SBarry Smith ierr = PetscObjectStateQuery((PetscObject)U,&ts->ijacobian.Xstate);CHKERRQ(ierr); 6580910c330SBarry Smith ierr = PetscObjectStateQuery((PetscObject)Udot,&ts->ijacobian.Xdotstate);CHKERRQ(ierr); 6590026cea9SSean Farley ts->ijacobian.shift = shift; 6600026cea9SSean Farley ts->ijacobian.imex = imex; 6610026cea9SSean Farley ts->ijacobian.mstructure = *flg; 6620910c330SBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,*A,*B);CHKERRQ(ierr); 663316643e7SJed Brown PetscFunctionReturn(0); 664316643e7SJed Brown } 665316643e7SJed Brown 666316643e7SJed Brown #undef __FUNCT__ 6674a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction" 668d763cef2SBarry Smith /*@C 669d763cef2SBarry Smith TSSetRHSFunction - Sets the routine for evaluating the function, 670b5abc632SBarry Smith where U_t = G(t,u). 671d763cef2SBarry Smith 6723f9fe445SBarry Smith Logically Collective on TS 673d763cef2SBarry Smith 674d763cef2SBarry Smith Input Parameters: 675d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 676ca94891dSJed Brown . r - vector to put the computed right hand side (or PETSC_NULL to have it created) 677d763cef2SBarry Smith . f - routine for evaluating the right-hand-side function 678d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 679d763cef2SBarry Smith function evaluation routine (may be PETSC_NULL) 680d763cef2SBarry Smith 681d763cef2SBarry Smith Calling sequence of func: 68287828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Vec F,void *ctx); 683d763cef2SBarry Smith 684d763cef2SBarry Smith + t - current timestep 685d763cef2SBarry Smith . u - input vector 686d763cef2SBarry Smith . F - function vector 687d763cef2SBarry Smith - ctx - [optional] user-defined function context 688d763cef2SBarry Smith 689d763cef2SBarry Smith Level: beginner 690d763cef2SBarry Smith 691d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 692d763cef2SBarry Smith 693d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian() 694d763cef2SBarry Smith @*/ 695089b2837SJed Brown PetscErrorCode TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx) 696d763cef2SBarry Smith { 697089b2837SJed Brown PetscErrorCode ierr; 698089b2837SJed Brown SNES snes; 699e856ceecSJed Brown Vec ralloc = PETSC_NULL; 70024989b8cSPeter Brune DM dm; 701d763cef2SBarry Smith 702089b2837SJed Brown PetscFunctionBegin; 7030700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 704ca94891dSJed Brown if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 70524989b8cSPeter Brune 70624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 70724989b8cSPeter Brune ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr); 708089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 709e856ceecSJed Brown if (!r && !ts->dm && ts->vec_sol) { 710e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 711e856ceecSJed Brown r = ralloc; 712e856ceecSJed Brown } 713089b2837SJed Brown ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 714e856ceecSJed Brown ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 715d763cef2SBarry Smith PetscFunctionReturn(0); 716d763cef2SBarry Smith } 717d763cef2SBarry Smith 7184a2ae208SSatish Balay #undef __FUNCT__ 719ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction" 720ef20d060SBarry Smith /*@C 721abd5a294SJed Brown TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE 722ef20d060SBarry Smith 723ef20d060SBarry Smith Logically Collective on TS 724ef20d060SBarry Smith 725ef20d060SBarry Smith Input Parameters: 726ef20d060SBarry Smith + ts - the TS context obtained from TSCreate() 727ef20d060SBarry Smith . f - routine for evaluating the solution 728ef20d060SBarry Smith - ctx - [optional] user-defined context for private data for the 729ef20d060SBarry Smith function evaluation routine (may be PETSC_NULL) 730ef20d060SBarry Smith 731ef20d060SBarry Smith Calling sequence of func: 732ef20d060SBarry Smith $ func (TS ts,PetscReal t,Vec u,void *ctx); 733ef20d060SBarry Smith 734ef20d060SBarry Smith + t - current timestep 735ef20d060SBarry Smith . u - output vector 736ef20d060SBarry Smith - ctx - [optional] user-defined function context 737ef20d060SBarry Smith 738abd5a294SJed Brown Notes: 739abd5a294SJed Brown This routine is used for testing accuracy of time integration schemes when you already know the solution. 740abd5a294SJed Brown If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to 741abd5a294SJed Brown create closed-form solutions with non-physical forcing terms. 742abd5a294SJed Brown 7434f09c107SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 744abd5a294SJed Brown 745ef20d060SBarry Smith Level: beginner 746ef20d060SBarry Smith 747ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 748ef20d060SBarry Smith 749abd5a294SJed Brown .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction() 750ef20d060SBarry Smith @*/ 751ef20d060SBarry Smith PetscErrorCode TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 752ef20d060SBarry Smith { 753ef20d060SBarry Smith PetscErrorCode ierr; 754ef20d060SBarry Smith DM dm; 755ef20d060SBarry Smith 756ef20d060SBarry Smith PetscFunctionBegin; 757ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 758ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 759ef20d060SBarry Smith ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr); 760ef20d060SBarry Smith PetscFunctionReturn(0); 761ef20d060SBarry Smith } 762ef20d060SBarry Smith 763ef20d060SBarry Smith #undef __FUNCT__ 7644a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian" 765d763cef2SBarry Smith /*@C 766d763cef2SBarry Smith TSSetRHSJacobian - Sets the function to compute the Jacobian of F, 767b5abc632SBarry Smith where U_t = G(U,t), as well as the location to store the matrix. 768d763cef2SBarry Smith 7693f9fe445SBarry Smith Logically Collective on TS 770d763cef2SBarry Smith 771d763cef2SBarry Smith Input Parameters: 772d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 773d763cef2SBarry Smith . A - Jacobian matrix 774d763cef2SBarry Smith . B - preconditioner matrix (usually same as A) 775d763cef2SBarry Smith . f - the Jacobian evaluation routine 776d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 777d763cef2SBarry Smith Jacobian evaluation routine (may be PETSC_NULL) 778d763cef2SBarry Smith 779d763cef2SBarry Smith Calling sequence of func: 78087828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Mat *A,Mat *B,MatStructure *flag,void *ctx); 781d763cef2SBarry Smith 782d763cef2SBarry Smith + t - current timestep 783d763cef2SBarry Smith . u - input vector 784d763cef2SBarry Smith . A - matrix A, where U_t = A(t)u 785d763cef2SBarry Smith . B - preconditioner matrix, usually the same as A 786d763cef2SBarry Smith . flag - flag indicating information about the preconditioner matrix 78794b7f48cSBarry Smith structure (same as flag in KSPSetOperators()) 788d763cef2SBarry Smith - ctx - [optional] user-defined context for matrix evaluation routine 789d763cef2SBarry Smith 790d763cef2SBarry Smith Notes: 79194b7f48cSBarry Smith See KSPSetOperators() for important information about setting the flag 792d763cef2SBarry Smith output parameter in the routine func(). Be sure to read this information! 793d763cef2SBarry Smith 794d763cef2SBarry Smith The routine func() takes Mat * as the matrix arguments rather than Mat. 795d763cef2SBarry Smith This allows the matrix evaluation routine to replace A and/or B with a 79656335db2SHong Zhang completely new matrix structure (not just different matrix elements) 797d763cef2SBarry Smith when appropriate, for instance, if the nonzero structure is changing 798d763cef2SBarry Smith throughout the global iterations. 799d763cef2SBarry Smith 800d763cef2SBarry Smith Level: beginner 801d763cef2SBarry Smith 802d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian 803d763cef2SBarry Smith 804ab637aeaSJed Brown .seealso: SNESDefaultComputeJacobianColor(), TSSetRHSFunction() 805d763cef2SBarry Smith 806d763cef2SBarry Smith @*/ 807089b2837SJed Brown PetscErrorCode TSSetRHSJacobian(TS ts,Mat A,Mat B,TSRHSJacobian f,void *ctx) 808d763cef2SBarry Smith { 809277b19d0SLisandro Dalcin PetscErrorCode ierr; 810089b2837SJed Brown SNES snes; 81124989b8cSPeter Brune DM dm; 81224989b8cSPeter Brune TSIJacobian ijacobian; 813277b19d0SLisandro Dalcin 814d763cef2SBarry Smith PetscFunctionBegin; 8150700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 816277b19d0SLisandro Dalcin if (A) PetscValidHeaderSpecific(A,MAT_CLASSID,2); 817277b19d0SLisandro Dalcin if (B) PetscValidHeaderSpecific(B,MAT_CLASSID,3); 818277b19d0SLisandro Dalcin if (A) PetscCheckSameComm(ts,1,A,2); 819277b19d0SLisandro Dalcin if (B) PetscCheckSameComm(ts,1,B,3); 820d763cef2SBarry Smith 82124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 82224989b8cSPeter Brune ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr); 82324989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,&ijacobian,PETSC_NULL);CHKERRQ(ierr); 82424989b8cSPeter Brune 825089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 8265f659677SPeter Brune if (!ijacobian) { 827089b2837SJed Brown ierr = SNESSetJacobian(snes,A,B,SNESTSFormJacobian,ts);CHKERRQ(ierr); 8280e4ef248SJed Brown } 8290e4ef248SJed Brown if (A) { 8300e4ef248SJed Brown ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr); 8310e4ef248SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 8320e4ef248SJed Brown ts->Arhs = A; 8330e4ef248SJed Brown } 8340e4ef248SJed Brown if (B) { 8350e4ef248SJed Brown ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr); 8360e4ef248SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 8370e4ef248SJed Brown ts->Brhs = B; 8380e4ef248SJed Brown } 839d763cef2SBarry Smith PetscFunctionReturn(0); 840d763cef2SBarry Smith } 841d763cef2SBarry Smith 842316643e7SJed Brown 843316643e7SJed Brown #undef __FUNCT__ 844316643e7SJed Brown #define __FUNCT__ "TSSetIFunction" 845316643e7SJed Brown /*@C 846b5abc632SBarry Smith TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved. 847316643e7SJed Brown 8483f9fe445SBarry Smith Logically Collective on TS 849316643e7SJed Brown 850316643e7SJed Brown Input Parameters: 851316643e7SJed Brown + ts - the TS context obtained from TSCreate() 852ca94891dSJed Brown . r - vector to hold the residual (or PETSC_NULL to have it created internally) 853316643e7SJed Brown . f - the function evaluation routine 854316643e7SJed Brown - ctx - user-defined context for private data for the function evaluation routine (may be PETSC_NULL) 855316643e7SJed Brown 856316643e7SJed Brown Calling sequence of f: 857316643e7SJed Brown $ f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx); 858316643e7SJed Brown 859316643e7SJed Brown + t - time at step/stage being solved 860316643e7SJed Brown . u - state vector 861316643e7SJed Brown . u_t - time derivative of state vector 862316643e7SJed Brown . F - function vector 863316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 864316643e7SJed Brown 865316643e7SJed Brown Important: 866d6cbdb99SBarry Smith The user MUST call either this routine, TSSetRHSFunction(). This routine must be used when not solving an ODE, for example a DAE. 867316643e7SJed Brown 868316643e7SJed Brown Level: beginner 869316643e7SJed Brown 870316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian 871316643e7SJed Brown 872d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian() 873316643e7SJed Brown @*/ 874089b2837SJed Brown PetscErrorCode TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx) 875316643e7SJed Brown { 876089b2837SJed Brown PetscErrorCode ierr; 877089b2837SJed Brown SNES snes; 878e856ceecSJed Brown Vec resalloc = PETSC_NULL; 87924989b8cSPeter Brune DM dm; 880316643e7SJed Brown 881316643e7SJed Brown PetscFunctionBegin; 8820700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 883ca94891dSJed Brown if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2); 88424989b8cSPeter Brune 88524989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 88624989b8cSPeter Brune ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr); 88724989b8cSPeter Brune 888089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 889e856ceecSJed Brown if (!res && !ts->dm && ts->vec_sol) { 890e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr); 891e856ceecSJed Brown res = resalloc; 892e856ceecSJed Brown } 893089b2837SJed Brown ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr); 894e856ceecSJed Brown ierr = VecDestroy(&resalloc);CHKERRQ(ierr); 89524989b8cSPeter Brune 896089b2837SJed Brown PetscFunctionReturn(0); 897089b2837SJed Brown } 898089b2837SJed Brown 899089b2837SJed Brown #undef __FUNCT__ 900089b2837SJed Brown #define __FUNCT__ "TSGetIFunction" 901089b2837SJed Brown /*@C 902089b2837SJed Brown TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it. 903089b2837SJed Brown 904089b2837SJed Brown Not Collective 905089b2837SJed Brown 906089b2837SJed Brown Input Parameter: 907089b2837SJed Brown . ts - the TS context 908089b2837SJed Brown 909089b2837SJed Brown Output Parameter: 910089b2837SJed Brown + r - vector to hold residual (or PETSC_NULL) 911089b2837SJed Brown . func - the function to compute residual (or PETSC_NULL) 912089b2837SJed Brown - ctx - the function context (or PETSC_NULL) 913089b2837SJed Brown 914089b2837SJed Brown Level: advanced 915089b2837SJed Brown 916089b2837SJed Brown .keywords: TS, nonlinear, get, function 917089b2837SJed Brown 918089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction() 919089b2837SJed Brown @*/ 920089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx) 921089b2837SJed Brown { 922089b2837SJed Brown PetscErrorCode ierr; 923089b2837SJed Brown SNES snes; 92424989b8cSPeter Brune DM dm; 925089b2837SJed Brown 926089b2837SJed Brown PetscFunctionBegin; 927089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 928089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 929089b2837SJed Brown ierr = SNESGetFunction(snes,r,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 93024989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 93124989b8cSPeter Brune ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr); 932089b2837SJed Brown PetscFunctionReturn(0); 933089b2837SJed Brown } 934089b2837SJed Brown 935089b2837SJed Brown #undef __FUNCT__ 936089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction" 937089b2837SJed Brown /*@C 938089b2837SJed Brown TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it. 939089b2837SJed Brown 940089b2837SJed Brown Not Collective 941089b2837SJed Brown 942089b2837SJed Brown Input Parameter: 943089b2837SJed Brown . ts - the TS context 944089b2837SJed Brown 945089b2837SJed Brown Output Parameter: 946089b2837SJed Brown + r - vector to hold computed right hand side (or PETSC_NULL) 947089b2837SJed Brown . func - the function to compute right hand side (or PETSC_NULL) 948089b2837SJed Brown - ctx - the function context (or PETSC_NULL) 949089b2837SJed Brown 950089b2837SJed Brown Level: advanced 951089b2837SJed Brown 952089b2837SJed Brown .keywords: TS, nonlinear, get, function 953089b2837SJed Brown 954089b2837SJed Brown .seealso: TSSetRhsfunction(), SNESGetFunction() 955089b2837SJed Brown @*/ 956089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx) 957089b2837SJed Brown { 958089b2837SJed Brown PetscErrorCode ierr; 959089b2837SJed Brown SNES snes; 96024989b8cSPeter Brune DM dm; 961089b2837SJed Brown 962089b2837SJed Brown PetscFunctionBegin; 963089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 964089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 965089b2837SJed Brown ierr = SNESGetFunction(snes,r,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 96624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 96724989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr); 968316643e7SJed Brown PetscFunctionReturn(0); 969316643e7SJed Brown } 970316643e7SJed Brown 971316643e7SJed Brown #undef __FUNCT__ 972316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian" 973316643e7SJed Brown /*@C 974a4f0a591SBarry Smith TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function 975a4f0a591SBarry Smith you provided with TSSetIFunction(). 976316643e7SJed Brown 9773f9fe445SBarry Smith Logically Collective on TS 978316643e7SJed Brown 979316643e7SJed Brown Input Parameters: 980316643e7SJed Brown + ts - the TS context obtained from TSCreate() 981316643e7SJed Brown . A - Jacobian matrix 982316643e7SJed Brown . B - preconditioning matrix for A (may be same as A) 983316643e7SJed Brown . f - the Jacobian evaluation routine 984316643e7SJed Brown - ctx - user-defined context for private data for the Jacobian evaluation routine (may be PETSC_NULL) 985316643e7SJed Brown 986316643e7SJed Brown Calling sequence of f: 9871b4a444bSJed Brown $ f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat *A,Mat *B,MatStructure *flag,void *ctx); 988316643e7SJed Brown 989316643e7SJed Brown + t - time at step/stage being solved 9901b4a444bSJed Brown . U - state vector 9911b4a444bSJed Brown . U_t - time derivative of state vector 992316643e7SJed Brown . a - shift 993b5abc632SBarry Smith . A - Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t 994316643e7SJed Brown . B - preconditioning matrix for A, may be same as A 995316643e7SJed Brown . flag - flag indicating information about the preconditioner matrix 996316643e7SJed Brown structure (same as flag in KSPSetOperators()) 997316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 998316643e7SJed Brown 999316643e7SJed Brown Notes: 1000316643e7SJed Brown The matrices A and B are exactly the matrices that are used by SNES for the nonlinear solve. 1001316643e7SJed Brown 1002a4f0a591SBarry Smith The matrix dF/dU + a*dF/dU_t you provide turns out to be 1003b5abc632SBarry Smith the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved. 1004a4f0a591SBarry Smith The time integrator internally approximates U_t by W+a*U where the positive "shift" 1005a4f0a591SBarry Smith a and vector W depend on the integration method, step size, and past states. For example with 1006a4f0a591SBarry Smith the backward Euler method a = 1/dt and W = -a*U(previous timestep) so 1007a4f0a591SBarry Smith W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt 1008a4f0a591SBarry Smith 1009316643e7SJed Brown Level: beginner 1010316643e7SJed Brown 1011316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian 1012316643e7SJed Brown 1013ab637aeaSJed Brown .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESDefaultComputeJacobianColor(), SNESDefaultComputeJacobian() 1014316643e7SJed Brown 1015316643e7SJed Brown @*/ 10167087cfbeSBarry Smith PetscErrorCode TSSetIJacobian(TS ts,Mat A,Mat B,TSIJacobian f,void *ctx) 1017316643e7SJed Brown { 1018316643e7SJed Brown PetscErrorCode ierr; 1019089b2837SJed Brown SNES snes; 102024989b8cSPeter Brune DM dm; 1021316643e7SJed Brown 1022316643e7SJed Brown PetscFunctionBegin; 10230700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 10240700a824SBarry Smith if (A) PetscValidHeaderSpecific(A,MAT_CLASSID,2); 10250700a824SBarry Smith if (B) PetscValidHeaderSpecific(B,MAT_CLASSID,3); 1026316643e7SJed Brown if (A) PetscCheckSameComm(ts,1,A,2); 1027316643e7SJed Brown if (B) PetscCheckSameComm(ts,1,B,3); 102824989b8cSPeter Brune 102924989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 103024989b8cSPeter Brune ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr); 103124989b8cSPeter Brune 1032089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1033089b2837SJed Brown ierr = SNESSetJacobian(snes,A,B,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1034316643e7SJed Brown PetscFunctionReturn(0); 1035316643e7SJed Brown } 1036316643e7SJed Brown 10374a2ae208SSatish Balay #undef __FUNCT__ 103855849f57SBarry Smith #define __FUNCT__ "TSLoad" 103955849f57SBarry Smith /*@C 104055849f57SBarry Smith TSLoad - Loads a KSP that has been stored in binary with KSPView(). 104155849f57SBarry Smith 104255849f57SBarry Smith Collective on PetscViewer 104355849f57SBarry Smith 104455849f57SBarry Smith Input Parameters: 104555849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or 104655849f57SBarry Smith some related function before a call to TSLoad(). 104755849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() 104855849f57SBarry Smith 104955849f57SBarry Smith Level: intermediate 105055849f57SBarry Smith 105155849f57SBarry Smith Notes: 105255849f57SBarry Smith The type is determined by the data in the file, any type set into the TS before this call is ignored. 105355849f57SBarry Smith 105455849f57SBarry Smith Notes for advanced users: 105555849f57SBarry Smith Most users should not need to know the details of the binary storage 105655849f57SBarry Smith format, since TSLoad() and TSView() completely hide these details. 105755849f57SBarry Smith But for anyone who's interested, the standard binary matrix storage 105855849f57SBarry Smith format is 105955849f57SBarry Smith .vb 106055849f57SBarry Smith has not yet been determined 106155849f57SBarry Smith .ve 106255849f57SBarry Smith 106355849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad() 106455849f57SBarry Smith @*/ 1065f2c2a1b9SBarry Smith PetscErrorCode TSLoad(TS ts, PetscViewer viewer) 106655849f57SBarry Smith { 106755849f57SBarry Smith PetscErrorCode ierr; 106855849f57SBarry Smith PetscBool isbinary; 106955849f57SBarry Smith PetscInt classid; 107055849f57SBarry Smith char type[256]; 107155849f57SBarry Smith 107255849f57SBarry Smith PetscFunctionBegin; 1073f2c2a1b9SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 107455849f57SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 107555849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 107655849f57SBarry Smith if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()"); 107755849f57SBarry Smith 107855849f57SBarry Smith ierr = PetscViewerBinaryRead(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr); 1079f2c2a1b9SBarry Smith if (classid != TS_FILE_CLASSID) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_ARG_WRONG,"Not TS next in file"); 108055849f57SBarry Smith ierr = PetscViewerBinaryRead(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr); 1081f2c2a1b9SBarry Smith ierr = TSSetType(ts, type);CHKERRQ(ierr); 1082f2c2a1b9SBarry Smith if (ts->ops->load) { 1083f2c2a1b9SBarry Smith ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr); 1084f2c2a1b9SBarry Smith } 1085f2c2a1b9SBarry Smith ierr = DMCreate(((PetscObject)ts)->comm,&ts->dm);CHKERRQ(ierr); 1086f2c2a1b9SBarry Smith ierr = DMLoad(ts->dm,viewer);CHKERRQ(ierr); 1087f2c2a1b9SBarry Smith ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr); 1088f2c2a1b9SBarry Smith ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr); 108955849f57SBarry Smith PetscFunctionReturn(0); 109055849f57SBarry Smith } 109155849f57SBarry Smith 109255849f57SBarry Smith #undef __FUNCT__ 10934a2ae208SSatish Balay #define __FUNCT__ "TSView" 10947e2c5f70SBarry Smith /*@C 1095d763cef2SBarry Smith TSView - Prints the TS data structure. 1096d763cef2SBarry Smith 10974c49b128SBarry Smith Collective on TS 1098d763cef2SBarry Smith 1099d763cef2SBarry Smith Input Parameters: 1100d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1101d763cef2SBarry Smith - viewer - visualization context 1102d763cef2SBarry Smith 1103d763cef2SBarry Smith Options Database Key: 1104d763cef2SBarry Smith . -ts_view - calls TSView() at end of TSStep() 1105d763cef2SBarry Smith 1106d763cef2SBarry Smith Notes: 1107d763cef2SBarry Smith The available visualization contexts include 1108b0a32e0cSBarry Smith + PETSC_VIEWER_STDOUT_SELF - standard output (default) 1109b0a32e0cSBarry Smith - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 1110d763cef2SBarry Smith output where only the first processor opens 1111d763cef2SBarry Smith the file. All other processors send their 1112d763cef2SBarry Smith data to the first processor to print. 1113d763cef2SBarry Smith 1114d763cef2SBarry Smith The user can open an alternative visualization context with 1115b0a32e0cSBarry Smith PetscViewerASCIIOpen() - output to a specified file. 1116d763cef2SBarry Smith 1117d763cef2SBarry Smith Level: beginner 1118d763cef2SBarry Smith 1119d763cef2SBarry Smith .keywords: TS, timestep, view 1120d763cef2SBarry Smith 1121b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen() 1122d763cef2SBarry Smith @*/ 11237087cfbeSBarry Smith PetscErrorCode TSView(TS ts,PetscViewer viewer) 1124d763cef2SBarry Smith { 1125dfbe8321SBarry Smith PetscErrorCode ierr; 112619fd82e9SBarry Smith TSType type; 1127*2b0a91c0SBarry Smith PetscBool iascii,isstring,isundials,isbinary,isdraw; 1128d763cef2SBarry Smith 1129d763cef2SBarry Smith PetscFunctionBegin; 11300700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 11313050cee2SBarry Smith if (!viewer) { 11327adad957SLisandro Dalcin ierr = PetscViewerASCIIGetStdout(((PetscObject)ts)->comm,&viewer);CHKERRQ(ierr); 11333050cee2SBarry Smith } 11340700a824SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1135c9780b6fSBarry Smith PetscCheckSameComm(ts,1,viewer,2); 1136fd16b177SBarry Smith 1137251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1138251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 113955849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 1140*2b0a91c0SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 114132077d6dSBarry Smith if (iascii) { 1142317d6ea6SBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer,"TS Object");CHKERRQ(ierr); 114377431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr); 1144a83599f4SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum time=%G\n",ts->max_time);CHKERRQ(ierr); 1145d763cef2SBarry Smith if (ts->problem_type == TS_NONLINEAR) { 11465ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr); 1147c610991cSLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr); 1148d763cef2SBarry Smith } 11495ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr); 1150193ac0bcSJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr); 1151d52bd9f3SBarry Smith if (ts->ops->view) { 1152d52bd9f3SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1153d52bd9f3SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1154d52bd9f3SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1155d52bd9f3SBarry Smith } 11560f5bd95cSBarry Smith } else if (isstring) { 1157a313700dSBarry Smith ierr = TSGetType(ts,&type);CHKERRQ(ierr); 1158b0a32e0cSBarry Smith ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr); 115955849f57SBarry Smith } else if (isbinary) { 116055849f57SBarry Smith PetscInt classid = TS_FILE_CLASSID; 116155849f57SBarry Smith MPI_Comm comm; 116255849f57SBarry Smith PetscMPIInt rank; 116355849f57SBarry Smith char type[256]; 116455849f57SBarry Smith 116555849f57SBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 116655849f57SBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 116755849f57SBarry Smith if (!rank) { 116855849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 116955849f57SBarry Smith ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr); 117055849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 117155849f57SBarry Smith } 117255849f57SBarry Smith if (ts->ops->view) { 117355849f57SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 117455849f57SBarry Smith } 1175f2c2a1b9SBarry Smith ierr = DMView(ts->dm,viewer);CHKERRQ(ierr); 1176f2c2a1b9SBarry Smith ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr); 1177*2b0a91c0SBarry Smith } else if (isdraw) { 1178*2b0a91c0SBarry Smith PetscDraw draw; 1179*2b0a91c0SBarry Smith char str[36]; 1180*2b0a91c0SBarry Smith PetscReal x,y,bottom; 1181*2b0a91c0SBarry Smith 1182*2b0a91c0SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 1183*2b0a91c0SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 1184*2b0a91c0SBarry Smith ierr = PetscStrcpy(str,"TS: ");CHKERRQ(ierr); 1185*2b0a91c0SBarry Smith ierr = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr); 1186*2b0a91c0SBarry Smith ierr = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,&bottom);CHKERRQ(ierr); 1187*2b0a91c0SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 1188*2b0a91c0SBarry Smith if (ts->ops->view) { 1189*2b0a91c0SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1190*2b0a91c0SBarry Smith } 1191*2b0a91c0SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 1192d763cef2SBarry Smith } 1193b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1194251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr); 1195b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1196d763cef2SBarry Smith PetscFunctionReturn(0); 1197d763cef2SBarry Smith } 1198d763cef2SBarry Smith 1199d763cef2SBarry Smith 12004a2ae208SSatish Balay #undef __FUNCT__ 12014a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext" 1202b07ff414SBarry Smith /*@ 1203d763cef2SBarry Smith TSSetApplicationContext - Sets an optional user-defined context for 1204d763cef2SBarry Smith the timesteppers. 1205d763cef2SBarry Smith 12063f9fe445SBarry Smith Logically Collective on TS 1207d763cef2SBarry Smith 1208d763cef2SBarry Smith Input Parameters: 1209d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1210d763cef2SBarry Smith - usrP - optional user context 1211d763cef2SBarry Smith 1212d763cef2SBarry Smith Level: intermediate 1213d763cef2SBarry Smith 1214d763cef2SBarry Smith .keywords: TS, timestep, set, application, context 1215d763cef2SBarry Smith 1216d763cef2SBarry Smith .seealso: TSGetApplicationContext() 1217d763cef2SBarry Smith @*/ 12187087cfbeSBarry Smith PetscErrorCode TSSetApplicationContext(TS ts,void *usrP) 1219d763cef2SBarry Smith { 1220d763cef2SBarry Smith PetscFunctionBegin; 12210700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1222d763cef2SBarry Smith ts->user = usrP; 1223d763cef2SBarry Smith PetscFunctionReturn(0); 1224d763cef2SBarry Smith } 1225d763cef2SBarry Smith 12264a2ae208SSatish Balay #undef __FUNCT__ 12274a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext" 1228b07ff414SBarry Smith /*@ 1229d763cef2SBarry Smith TSGetApplicationContext - Gets the user-defined context for the 1230d763cef2SBarry Smith timestepper. 1231d763cef2SBarry Smith 1232d763cef2SBarry Smith Not Collective 1233d763cef2SBarry Smith 1234d763cef2SBarry Smith Input Parameter: 1235d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1236d763cef2SBarry Smith 1237d763cef2SBarry Smith Output Parameter: 1238d763cef2SBarry Smith . usrP - user context 1239d763cef2SBarry Smith 1240d763cef2SBarry Smith Level: intermediate 1241d763cef2SBarry Smith 1242d763cef2SBarry Smith .keywords: TS, timestep, get, application, context 1243d763cef2SBarry Smith 1244d763cef2SBarry Smith .seealso: TSSetApplicationContext() 1245d763cef2SBarry Smith @*/ 1246e71120c6SJed Brown PetscErrorCode TSGetApplicationContext(TS ts,void *usrP) 1247d763cef2SBarry Smith { 1248d763cef2SBarry Smith PetscFunctionBegin; 12490700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1250e71120c6SJed Brown *(void**)usrP = ts->user; 1251d763cef2SBarry Smith PetscFunctionReturn(0); 1252d763cef2SBarry Smith } 1253d763cef2SBarry Smith 12544a2ae208SSatish Balay #undef __FUNCT__ 12554a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber" 1256d763cef2SBarry Smith /*@ 1257b8123daeSJed Brown TSGetTimeStepNumber - Gets the number of time steps completed. 1258d763cef2SBarry Smith 1259d763cef2SBarry Smith Not Collective 1260d763cef2SBarry Smith 1261d763cef2SBarry Smith Input Parameter: 1262d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1263d763cef2SBarry Smith 1264d763cef2SBarry Smith Output Parameter: 1265b8123daeSJed Brown . iter - number of steps completed so far 1266d763cef2SBarry Smith 1267d763cef2SBarry Smith Level: intermediate 1268d763cef2SBarry Smith 1269d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number 1270b8123daeSJed Brown .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStep() 1271d763cef2SBarry Smith @*/ 12727087cfbeSBarry Smith PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt* iter) 1273d763cef2SBarry Smith { 1274d763cef2SBarry Smith PetscFunctionBegin; 12750700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 12764482741eSBarry Smith PetscValidIntPointer(iter,2); 1277d763cef2SBarry Smith *iter = ts->steps; 1278d763cef2SBarry Smith PetscFunctionReturn(0); 1279d763cef2SBarry Smith } 1280d763cef2SBarry Smith 12814a2ae208SSatish Balay #undef __FUNCT__ 12824a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep" 1283d763cef2SBarry Smith /*@ 1284d763cef2SBarry Smith TSSetInitialTimeStep - Sets the initial timestep to be used, 1285d763cef2SBarry Smith as well as the initial time. 1286d763cef2SBarry Smith 12873f9fe445SBarry Smith Logically Collective on TS 1288d763cef2SBarry Smith 1289d763cef2SBarry Smith Input Parameters: 1290d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1291d763cef2SBarry Smith . initial_time - the initial time 1292d763cef2SBarry Smith - time_step - the size of the timestep 1293d763cef2SBarry Smith 1294d763cef2SBarry Smith Level: intermediate 1295d763cef2SBarry Smith 1296d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep() 1297d763cef2SBarry Smith 1298d763cef2SBarry Smith .keywords: TS, set, initial, timestep 1299d763cef2SBarry Smith @*/ 13007087cfbeSBarry Smith PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step) 1301d763cef2SBarry Smith { 1302e144a568SJed Brown PetscErrorCode ierr; 1303e144a568SJed Brown 1304d763cef2SBarry Smith PetscFunctionBegin; 13050700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1306e144a568SJed Brown ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 1307d8cd7023SBarry Smith ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr); 1308d763cef2SBarry Smith PetscFunctionReturn(0); 1309d763cef2SBarry Smith } 1310d763cef2SBarry Smith 13114a2ae208SSatish Balay #undef __FUNCT__ 13124a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep" 1313d763cef2SBarry Smith /*@ 1314d763cef2SBarry Smith TSSetTimeStep - Allows one to reset the timestep at any time, 1315d763cef2SBarry Smith useful for simple pseudo-timestepping codes. 1316d763cef2SBarry Smith 13173f9fe445SBarry Smith Logically Collective on TS 1318d763cef2SBarry Smith 1319d763cef2SBarry Smith Input Parameters: 1320d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1321d763cef2SBarry Smith - time_step - the size of the timestep 1322d763cef2SBarry Smith 1323d763cef2SBarry Smith Level: intermediate 1324d763cef2SBarry Smith 1325d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1326d763cef2SBarry Smith 1327d763cef2SBarry Smith .keywords: TS, set, timestep 1328d763cef2SBarry Smith @*/ 13297087cfbeSBarry Smith PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step) 1330d763cef2SBarry Smith { 1331d763cef2SBarry Smith PetscFunctionBegin; 13320700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1333c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,time_step,2); 1334d763cef2SBarry Smith ts->time_step = time_step; 133531748224SBarry Smith ts->time_step_orig = time_step; 1336d763cef2SBarry Smith PetscFunctionReturn(0); 1337d763cef2SBarry Smith } 1338d763cef2SBarry Smith 13394a2ae208SSatish Balay #undef __FUNCT__ 1340a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime" 1341a43b19c4SJed Brown /*@ 1342a43b19c4SJed Brown TSSetExactFinalTime - Determines whether to interpolate solution to the 1343a43b19c4SJed Brown exact final time requested by the user or just returns it at the final time 1344a43b19c4SJed Brown it computed. 1345a43b19c4SJed Brown 1346a43b19c4SJed Brown Logically Collective on TS 1347a43b19c4SJed Brown 1348a43b19c4SJed Brown Input Parameter: 1349a43b19c4SJed Brown + ts - the time-step context 1350a43b19c4SJed Brown - ft - PETSC_TRUE if interpolates, else PETSC_FALSE 1351a43b19c4SJed Brown 1352a43b19c4SJed Brown Level: beginner 1353a43b19c4SJed Brown 1354a43b19c4SJed Brown .seealso: TSSetDuration() 1355a43b19c4SJed Brown @*/ 1356a43b19c4SJed Brown PetscErrorCode TSSetExactFinalTime(TS ts,PetscBool flg) 1357a43b19c4SJed Brown { 1358a43b19c4SJed Brown PetscFunctionBegin; 1359a43b19c4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1360d8cd7023SBarry Smith PetscValidLogicalCollectiveBool(ts,flg,2); 1361a43b19c4SJed Brown ts->exact_final_time = flg; 1362a43b19c4SJed Brown PetscFunctionReturn(0); 1363a43b19c4SJed Brown } 1364a43b19c4SJed Brown 1365a43b19c4SJed Brown #undef __FUNCT__ 13664a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep" 1367d763cef2SBarry Smith /*@ 1368d763cef2SBarry Smith TSGetTimeStep - Gets the current timestep size. 1369d763cef2SBarry Smith 1370d763cef2SBarry Smith Not Collective 1371d763cef2SBarry Smith 1372d763cef2SBarry Smith Input Parameter: 1373d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1374d763cef2SBarry Smith 1375d763cef2SBarry Smith Output Parameter: 1376d763cef2SBarry Smith . dt - the current timestep size 1377d763cef2SBarry Smith 1378d763cef2SBarry Smith Level: intermediate 1379d763cef2SBarry Smith 1380d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1381d763cef2SBarry Smith 1382d763cef2SBarry Smith .keywords: TS, get, timestep 1383d763cef2SBarry Smith @*/ 13847087cfbeSBarry Smith PetscErrorCode TSGetTimeStep(TS ts,PetscReal* dt) 1385d763cef2SBarry Smith { 1386d763cef2SBarry Smith PetscFunctionBegin; 13870700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1388f7cf8827SBarry Smith PetscValidRealPointer(dt,2); 1389d763cef2SBarry Smith *dt = ts->time_step; 1390d763cef2SBarry Smith PetscFunctionReturn(0); 1391d763cef2SBarry Smith } 1392d763cef2SBarry Smith 13934a2ae208SSatish Balay #undef __FUNCT__ 13944a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution" 1395d8e5e3e6SSatish Balay /*@ 1396d763cef2SBarry Smith TSGetSolution - Returns the solution at the present timestep. It 1397d763cef2SBarry Smith is valid to call this routine inside the function that you are evaluating 1398d763cef2SBarry Smith in order to move to the new timestep. This vector not changed until 1399d763cef2SBarry Smith the solution at the next timestep has been calculated. 1400d763cef2SBarry Smith 1401d763cef2SBarry Smith Not Collective, but Vec returned is parallel if TS is parallel 1402d763cef2SBarry Smith 1403d763cef2SBarry Smith Input Parameter: 1404d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1405d763cef2SBarry Smith 1406d763cef2SBarry Smith Output Parameter: 1407d763cef2SBarry Smith . v - the vector containing the solution 1408d763cef2SBarry Smith 1409d763cef2SBarry Smith Level: intermediate 1410d763cef2SBarry Smith 1411d763cef2SBarry Smith .seealso: TSGetTimeStep() 1412d763cef2SBarry Smith 1413d763cef2SBarry Smith .keywords: TS, timestep, get, solution 1414d763cef2SBarry Smith @*/ 14157087cfbeSBarry Smith PetscErrorCode TSGetSolution(TS ts,Vec *v) 1416d763cef2SBarry Smith { 1417d763cef2SBarry Smith PetscFunctionBegin; 14180700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 14194482741eSBarry Smith PetscValidPointer(v,2); 14208737fe31SLisandro Dalcin *v = ts->vec_sol; 1421d763cef2SBarry Smith PetscFunctionReturn(0); 1422d763cef2SBarry Smith } 1423d763cef2SBarry Smith 1424bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */ 14254a2ae208SSatish Balay #undef __FUNCT__ 1426bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType" 1427d8e5e3e6SSatish Balay /*@ 1428bdad233fSMatthew Knepley TSSetProblemType - Sets the type of problem to be solved. 1429d763cef2SBarry Smith 1430bdad233fSMatthew Knepley Not collective 1431d763cef2SBarry Smith 1432bdad233fSMatthew Knepley Input Parameters: 1433bdad233fSMatthew Knepley + ts - The TS 1434bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 1435d763cef2SBarry Smith .vb 14360910c330SBarry Smith U_t - A U = 0 (linear) 14370910c330SBarry Smith U_t - A(t) U = 0 (linear) 14380910c330SBarry Smith F(t,U,U_t) = 0 (nonlinear) 1439d763cef2SBarry Smith .ve 1440d763cef2SBarry Smith 1441d763cef2SBarry Smith Level: beginner 1442d763cef2SBarry Smith 1443bdad233fSMatthew Knepley .keywords: TS, problem type 1444bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 1445d763cef2SBarry Smith @*/ 14467087cfbeSBarry Smith PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 1447a7cc72afSBarry Smith { 14489e2a6581SJed Brown PetscErrorCode ierr; 14499e2a6581SJed Brown 1450d763cef2SBarry Smith PetscFunctionBegin; 14510700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1452bdad233fSMatthew Knepley ts->problem_type = type; 14539e2a6581SJed Brown if (type == TS_LINEAR) { 14549e2a6581SJed Brown SNES snes; 14559e2a6581SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 14569e2a6581SJed Brown ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr); 14579e2a6581SJed Brown } 1458d763cef2SBarry Smith PetscFunctionReturn(0); 1459d763cef2SBarry Smith } 1460d763cef2SBarry Smith 1461bdad233fSMatthew Knepley #undef __FUNCT__ 1462bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType" 1463bdad233fSMatthew Knepley /*@C 1464bdad233fSMatthew Knepley TSGetProblemType - Gets the type of problem to be solved. 1465bdad233fSMatthew Knepley 1466bdad233fSMatthew Knepley Not collective 1467bdad233fSMatthew Knepley 1468bdad233fSMatthew Knepley Input Parameter: 1469bdad233fSMatthew Knepley . ts - The TS 1470bdad233fSMatthew Knepley 1471bdad233fSMatthew Knepley Output Parameter: 1472bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 1473bdad233fSMatthew Knepley .vb 1474089b2837SJed Brown M U_t = A U 1475089b2837SJed Brown M(t) U_t = A(t) U 1476b5abc632SBarry Smith F(t,U,U_t) 1477bdad233fSMatthew Knepley .ve 1478bdad233fSMatthew Knepley 1479bdad233fSMatthew Knepley Level: beginner 1480bdad233fSMatthew Knepley 1481bdad233fSMatthew Knepley .keywords: TS, problem type 1482bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 1483bdad233fSMatthew Knepley @*/ 14847087cfbeSBarry Smith PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 1485a7cc72afSBarry Smith { 1486bdad233fSMatthew Knepley PetscFunctionBegin; 14870700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 14884482741eSBarry Smith PetscValidIntPointer(type,2); 1489bdad233fSMatthew Knepley *type = ts->problem_type; 1490bdad233fSMatthew Knepley PetscFunctionReturn(0); 1491bdad233fSMatthew Knepley } 1492d763cef2SBarry Smith 14934a2ae208SSatish Balay #undef __FUNCT__ 14944a2ae208SSatish Balay #define __FUNCT__ "TSSetUp" 1495d763cef2SBarry Smith /*@ 1496d763cef2SBarry Smith TSSetUp - Sets up the internal data structures for the later use 1497d763cef2SBarry Smith of a timestepper. 1498d763cef2SBarry Smith 1499d763cef2SBarry Smith Collective on TS 1500d763cef2SBarry Smith 1501d763cef2SBarry Smith Input Parameter: 1502d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1503d763cef2SBarry Smith 1504d763cef2SBarry Smith Notes: 1505d763cef2SBarry Smith For basic use of the TS solvers the user need not explicitly call 1506d763cef2SBarry Smith TSSetUp(), since these actions will automatically occur during 1507d763cef2SBarry Smith the call to TSStep(). However, if one wishes to control this 1508d763cef2SBarry Smith phase separately, TSSetUp() should be called after TSCreate() 1509d763cef2SBarry Smith and optional routines of the form TSSetXXX(), but before TSStep(). 1510d763cef2SBarry Smith 1511d763cef2SBarry Smith Level: advanced 1512d763cef2SBarry Smith 1513d763cef2SBarry Smith .keywords: TS, timestep, setup 1514d763cef2SBarry Smith 1515d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy() 1516d763cef2SBarry Smith @*/ 15177087cfbeSBarry Smith PetscErrorCode TSSetUp(TS ts) 1518d763cef2SBarry Smith { 1519dfbe8321SBarry Smith PetscErrorCode ierr; 15206c6b9e74SPeter Brune DM dm; 15216c6b9e74SPeter Brune PetscErrorCode (*func)(SNES,Vec,Vec,void*); 15226c6b9e74SPeter Brune PetscErrorCode (*jac)(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 15236c6b9e74SPeter Brune TSIJacobian ijac; 15246c6b9e74SPeter Brune TSRHSJacobian rhsjac; 1525d763cef2SBarry Smith 1526d763cef2SBarry Smith PetscFunctionBegin; 15270700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1528277b19d0SLisandro Dalcin if (ts->setupcalled) PetscFunctionReturn(0); 1529277b19d0SLisandro Dalcin 15307adad957SLisandro Dalcin if (!((PetscObject)ts)->type_name) { 15319596e0b4SJed Brown ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr); 1532d763cef2SBarry Smith } 1533a43b19c4SJed Brown if (ts->exact_final_time == PETSC_DECIDE) ts->exact_final_time = PETSC_FALSE; 1534277b19d0SLisandro Dalcin 1535277b19d0SLisandro Dalcin if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first"); 1536277b19d0SLisandro Dalcin 15371c3436cfSJed Brown ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 15381c3436cfSJed Brown 1539277b19d0SLisandro Dalcin if (ts->ops->setup) { 1540000e7ae3SMatthew Knepley ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr); 1541277b19d0SLisandro Dalcin } 1542277b19d0SLisandro Dalcin 15436c6b9e74SPeter Brune /* in the case where we've set a DMTSFunction or what have you, we need the default SNESFunction 15446c6b9e74SPeter Brune to be set right but can't do it elsewhere due to the overreliance on ctx=ts. 15456c6b9e74SPeter Brune */ 15466c6b9e74SPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 15476c6b9e74SPeter Brune ierr = DMSNESGetFunction(dm,&func,PETSC_NULL);CHKERRQ(ierr); 15486c6b9e74SPeter Brune if (!func) { 15496c6b9e74SPeter Brune ierr =DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr); 15506c6b9e74SPeter Brune } 15516c6b9e74SPeter 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. 15526c6b9e74SPeter Brune Otherwise, the SNES will use coloring internally to form the Jacobian. 15536c6b9e74SPeter Brune */ 15546c6b9e74SPeter Brune ierr = DMSNESGetJacobian(dm,&jac,PETSC_NULL);CHKERRQ(ierr); 15556c6b9e74SPeter Brune ierr = DMTSGetIJacobian(dm,&ijac,PETSC_NULL);CHKERRQ(ierr); 15566c6b9e74SPeter Brune ierr = DMTSGetRHSJacobian(dm,&rhsjac,PETSC_NULL);CHKERRQ(ierr); 15576c6b9e74SPeter Brune if (!jac && (ijac || rhsjac)) { 15586c6b9e74SPeter Brune ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr); 15596c6b9e74SPeter Brune } 1560277b19d0SLisandro Dalcin ts->setupcalled = PETSC_TRUE; 1561277b19d0SLisandro Dalcin PetscFunctionReturn(0); 1562277b19d0SLisandro Dalcin } 1563277b19d0SLisandro Dalcin 1564277b19d0SLisandro Dalcin #undef __FUNCT__ 1565277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset" 1566277b19d0SLisandro Dalcin /*@ 1567277b19d0SLisandro Dalcin TSReset - Resets a TS context and removes any allocated Vecs and Mats. 1568277b19d0SLisandro Dalcin 1569277b19d0SLisandro Dalcin Collective on TS 1570277b19d0SLisandro Dalcin 1571277b19d0SLisandro Dalcin Input Parameter: 1572277b19d0SLisandro Dalcin . ts - the TS context obtained from TSCreate() 1573277b19d0SLisandro Dalcin 1574277b19d0SLisandro Dalcin Level: beginner 1575277b19d0SLisandro Dalcin 1576277b19d0SLisandro Dalcin .keywords: TS, timestep, reset 1577277b19d0SLisandro Dalcin 1578277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy() 1579277b19d0SLisandro Dalcin @*/ 1580277b19d0SLisandro Dalcin PetscErrorCode TSReset(TS ts) 1581277b19d0SLisandro Dalcin { 1582277b19d0SLisandro Dalcin PetscErrorCode ierr; 1583277b19d0SLisandro Dalcin 1584277b19d0SLisandro Dalcin PetscFunctionBegin; 1585277b19d0SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1586277b19d0SLisandro Dalcin if (ts->ops->reset) { 1587277b19d0SLisandro Dalcin ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr); 1588277b19d0SLisandro Dalcin } 1589277b19d0SLisandro Dalcin if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);} 15904e684422SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 15914e684422SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1592214bc6a2SJed Brown ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr); 15936bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 1594e3d84a46SJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 1595e3d84a46SJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 159638637c2eSJed Brown ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr); 1597277b19d0SLisandro Dalcin ts->setupcalled = PETSC_FALSE; 1598d763cef2SBarry Smith PetscFunctionReturn(0); 1599d763cef2SBarry Smith } 1600d763cef2SBarry Smith 16014a2ae208SSatish Balay #undef __FUNCT__ 16024a2ae208SSatish Balay #define __FUNCT__ "TSDestroy" 1603d8e5e3e6SSatish Balay /*@ 1604d763cef2SBarry Smith TSDestroy - Destroys the timestepper context that was created 1605d763cef2SBarry Smith with TSCreate(). 1606d763cef2SBarry Smith 1607d763cef2SBarry Smith Collective on TS 1608d763cef2SBarry Smith 1609d763cef2SBarry Smith Input Parameter: 1610d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1611d763cef2SBarry Smith 1612d763cef2SBarry Smith Level: beginner 1613d763cef2SBarry Smith 1614d763cef2SBarry Smith .keywords: TS, timestepper, destroy 1615d763cef2SBarry Smith 1616d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve() 1617d763cef2SBarry Smith @*/ 16186bf464f9SBarry Smith PetscErrorCode TSDestroy(TS *ts) 1619d763cef2SBarry Smith { 16206849ba73SBarry Smith PetscErrorCode ierr; 1621d763cef2SBarry Smith 1622d763cef2SBarry Smith PetscFunctionBegin; 16236bf464f9SBarry Smith if (!*ts) PetscFunctionReturn(0); 16246bf464f9SBarry Smith PetscValidHeaderSpecific((*ts),TS_CLASSID,1); 16256bf464f9SBarry Smith if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);} 1626d763cef2SBarry Smith 16276bf464f9SBarry Smith ierr = TSReset((*ts));CHKERRQ(ierr); 1628277b19d0SLisandro Dalcin 1629be0abb6dSBarry Smith /* if memory was published with AMS then destroy it */ 16306bf464f9SBarry Smith ierr = PetscObjectDepublish((*ts));CHKERRQ(ierr); 16316bf464f9SBarry Smith if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);} 16326d4c513bSLisandro Dalcin 163384df9cb4SJed Brown ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr); 16346bf464f9SBarry Smith ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr); 16356bf464f9SBarry Smith ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr); 16366bf464f9SBarry Smith ierr = TSMonitorCancel((*ts));CHKERRQ(ierr); 16376d4c513bSLisandro Dalcin 1638a79aaaedSSatish Balay ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr); 1639d763cef2SBarry Smith PetscFunctionReturn(0); 1640d763cef2SBarry Smith } 1641d763cef2SBarry Smith 16424a2ae208SSatish Balay #undef __FUNCT__ 16434a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES" 1644d8e5e3e6SSatish Balay /*@ 1645d763cef2SBarry Smith TSGetSNES - Returns the SNES (nonlinear solver) associated with 1646d763cef2SBarry Smith a TS (timestepper) context. Valid only for nonlinear problems. 1647d763cef2SBarry Smith 1648d763cef2SBarry Smith Not Collective, but SNES is parallel if TS is parallel 1649d763cef2SBarry Smith 1650d763cef2SBarry Smith Input Parameter: 1651d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1652d763cef2SBarry Smith 1653d763cef2SBarry Smith Output Parameter: 1654d763cef2SBarry Smith . snes - the nonlinear solver context 1655d763cef2SBarry Smith 1656d763cef2SBarry Smith Notes: 1657d763cef2SBarry Smith The user can then directly manipulate the SNES context to set various 1658d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 165994b7f48cSBarry Smith KSP, KSP, and PC contexts as well. 1660d763cef2SBarry Smith 1661d763cef2SBarry Smith TSGetSNES() does not work for integrators that do not use SNES; in 1662d763cef2SBarry Smith this case TSGetSNES() returns PETSC_NULL in snes. 1663d763cef2SBarry Smith 1664d763cef2SBarry Smith Level: beginner 1665d763cef2SBarry Smith 1666d763cef2SBarry Smith .keywords: timestep, get, SNES 1667d763cef2SBarry Smith @*/ 16687087cfbeSBarry Smith PetscErrorCode TSGetSNES(TS ts,SNES *snes) 1669d763cef2SBarry Smith { 1670d372ba47SLisandro Dalcin PetscErrorCode ierr; 1671d372ba47SLisandro Dalcin 1672d763cef2SBarry Smith PetscFunctionBegin; 16730700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 16744482741eSBarry Smith PetscValidPointer(snes,2); 1675d372ba47SLisandro Dalcin if (!ts->snes) { 1676d372ba47SLisandro Dalcin ierr = SNESCreate(((PetscObject)ts)->comm,&ts->snes);CHKERRQ(ierr); 16776c6b9e74SPeter Brune ierr = SNESSetFunction(ts->snes,PETSC_NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 1678d372ba47SLisandro Dalcin ierr = PetscLogObjectParent(ts,ts->snes);CHKERRQ(ierr); 1679d372ba47SLisandro Dalcin ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr); 1680496e6a7aSJed Brown if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 16819e2a6581SJed Brown if (ts->problem_type == TS_LINEAR) { 16829e2a6581SJed Brown ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); 16839e2a6581SJed Brown } 1684d372ba47SLisandro Dalcin } 1685d763cef2SBarry Smith *snes = ts->snes; 1686d763cef2SBarry Smith PetscFunctionReturn(0); 1687d763cef2SBarry Smith } 1688d763cef2SBarry Smith 16894a2ae208SSatish Balay #undef __FUNCT__ 169094b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP" 1691d8e5e3e6SSatish Balay /*@ 169294b7f48cSBarry Smith TSGetKSP - Returns the KSP (linear solver) associated with 1693d763cef2SBarry Smith a TS (timestepper) context. 1694d763cef2SBarry Smith 169594b7f48cSBarry Smith Not Collective, but KSP is parallel if TS is parallel 1696d763cef2SBarry Smith 1697d763cef2SBarry Smith Input Parameter: 1698d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1699d763cef2SBarry Smith 1700d763cef2SBarry Smith Output Parameter: 170194b7f48cSBarry Smith . ksp - the nonlinear solver context 1702d763cef2SBarry Smith 1703d763cef2SBarry Smith Notes: 170494b7f48cSBarry Smith The user can then directly manipulate the KSP context to set various 1705d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 1706d763cef2SBarry Smith KSP and PC contexts as well. 1707d763cef2SBarry Smith 170894b7f48cSBarry Smith TSGetKSP() does not work for integrators that do not use KSP; 170994b7f48cSBarry Smith in this case TSGetKSP() returns PETSC_NULL in ksp. 1710d763cef2SBarry Smith 1711d763cef2SBarry Smith Level: beginner 1712d763cef2SBarry Smith 171394b7f48cSBarry Smith .keywords: timestep, get, KSP 1714d763cef2SBarry Smith @*/ 17157087cfbeSBarry Smith PetscErrorCode TSGetKSP(TS ts,KSP *ksp) 1716d763cef2SBarry Smith { 1717d372ba47SLisandro Dalcin PetscErrorCode ierr; 1718089b2837SJed Brown SNES snes; 1719d372ba47SLisandro Dalcin 1720d763cef2SBarry Smith PetscFunctionBegin; 17210700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 17224482741eSBarry Smith PetscValidPointer(ksp,2); 172317186662SBarry Smith if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first"); 1724e32f2f54SBarry Smith if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()"); 1725089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1726089b2837SJed Brown ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr); 1727d763cef2SBarry Smith PetscFunctionReturn(0); 1728d763cef2SBarry Smith } 1729d763cef2SBarry Smith 1730d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */ 1731d763cef2SBarry Smith 17324a2ae208SSatish Balay #undef __FUNCT__ 1733adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration" 1734adb62b0dSMatthew Knepley /*@ 1735adb62b0dSMatthew Knepley TSGetDuration - Gets the maximum number of timesteps to use and 1736adb62b0dSMatthew Knepley maximum time for iteration. 1737adb62b0dSMatthew Knepley 17383f9fe445SBarry Smith Not Collective 1739adb62b0dSMatthew Knepley 1740adb62b0dSMatthew Knepley Input Parameters: 1741adb62b0dSMatthew Knepley + ts - the TS context obtained from TSCreate() 1742adb62b0dSMatthew Knepley . maxsteps - maximum number of iterations to use, or PETSC_NULL 1743adb62b0dSMatthew Knepley - maxtime - final time to iterate to, or PETSC_NULL 1744adb62b0dSMatthew Knepley 1745adb62b0dSMatthew Knepley Level: intermediate 1746adb62b0dSMatthew Knepley 1747adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time 1748adb62b0dSMatthew Knepley @*/ 17497087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 1750adb62b0dSMatthew Knepley { 1751adb62b0dSMatthew Knepley PetscFunctionBegin; 17520700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1753abc0a331SBarry Smith if (maxsteps) { 17544482741eSBarry Smith PetscValidIntPointer(maxsteps,2); 1755adb62b0dSMatthew Knepley *maxsteps = ts->max_steps; 1756adb62b0dSMatthew Knepley } 1757abc0a331SBarry Smith if (maxtime) { 17584482741eSBarry Smith PetscValidScalarPointer(maxtime,3); 1759adb62b0dSMatthew Knepley *maxtime = ts->max_time; 1760adb62b0dSMatthew Knepley } 1761adb62b0dSMatthew Knepley PetscFunctionReturn(0); 1762adb62b0dSMatthew Knepley } 1763adb62b0dSMatthew Knepley 1764adb62b0dSMatthew Knepley #undef __FUNCT__ 17654a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration" 1766d763cef2SBarry Smith /*@ 1767d763cef2SBarry Smith TSSetDuration - Sets the maximum number of timesteps to use and 1768d763cef2SBarry Smith maximum time for iteration. 1769d763cef2SBarry Smith 17703f9fe445SBarry Smith Logically Collective on TS 1771d763cef2SBarry Smith 1772d763cef2SBarry Smith Input Parameters: 1773d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1774d763cef2SBarry Smith . maxsteps - maximum number of iterations to use 1775d763cef2SBarry Smith - maxtime - final time to iterate to 1776d763cef2SBarry Smith 1777d763cef2SBarry Smith Options Database Keys: 1778d763cef2SBarry Smith . -ts_max_steps <maxsteps> - Sets maxsteps 17793bca7d26SBarry Smith . -ts_final_time <maxtime> - Sets maxtime 1780d763cef2SBarry Smith 1781d763cef2SBarry Smith Notes: 1782d763cef2SBarry Smith The default maximum number of iterations is 5000. Default time is 5.0 1783d763cef2SBarry Smith 1784d763cef2SBarry Smith Level: intermediate 1785d763cef2SBarry Smith 1786d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations 1787a43b19c4SJed Brown 1788a43b19c4SJed Brown .seealso: TSSetExactFinalTime() 1789d763cef2SBarry Smith @*/ 17907087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime) 1791d763cef2SBarry Smith { 1792d763cef2SBarry Smith PetscFunctionBegin; 17930700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1794c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(ts,maxsteps,2); 1795c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,maxtime,2); 179639b7ec4bSSean Farley if (maxsteps >= 0) ts->max_steps = maxsteps; 179739b7ec4bSSean Farley if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime; 1798d763cef2SBarry Smith PetscFunctionReturn(0); 1799d763cef2SBarry Smith } 1800d763cef2SBarry Smith 18014a2ae208SSatish Balay #undef __FUNCT__ 18024a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution" 1803d763cef2SBarry Smith /*@ 1804d763cef2SBarry Smith TSSetSolution - Sets the initial solution vector 1805d763cef2SBarry Smith for use by the TS routines. 1806d763cef2SBarry Smith 18073f9fe445SBarry Smith Logically Collective on TS and Vec 1808d763cef2SBarry Smith 1809d763cef2SBarry Smith Input Parameters: 1810d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 18110910c330SBarry Smith - u - the solution vector 1812d763cef2SBarry Smith 1813d763cef2SBarry Smith Level: beginner 1814d763cef2SBarry Smith 1815d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions 1816d763cef2SBarry Smith @*/ 18170910c330SBarry Smith PetscErrorCode TSSetSolution(TS ts,Vec u) 1818d763cef2SBarry Smith { 18198737fe31SLisandro Dalcin PetscErrorCode ierr; 1820496e6a7aSJed Brown DM dm; 18218737fe31SLisandro Dalcin 1822d763cef2SBarry Smith PetscFunctionBegin; 18230700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 18240910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,2); 18250910c330SBarry Smith ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr); 18266bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 18270910c330SBarry Smith ts->vec_sol = u; 1828496e6a7aSJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 18290910c330SBarry Smith ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr); 1830d763cef2SBarry Smith PetscFunctionReturn(0); 1831d763cef2SBarry Smith } 1832d763cef2SBarry Smith 1833e74ef692SMatthew Knepley #undef __FUNCT__ 1834e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep" 1835ac226902SBarry Smith /*@C 1836000e7ae3SMatthew Knepley TSSetPreStep - Sets the general-purpose function 18373f2090d5SJed Brown called once at the beginning of each time step. 1838000e7ae3SMatthew Knepley 18393f9fe445SBarry Smith Logically Collective on TS 1840000e7ae3SMatthew Knepley 1841000e7ae3SMatthew Knepley Input Parameters: 1842000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 1843000e7ae3SMatthew Knepley - func - The function 1844000e7ae3SMatthew Knepley 1845000e7ae3SMatthew Knepley Calling sequence of func: 1846000e7ae3SMatthew Knepley . func (TS ts); 1847000e7ae3SMatthew Knepley 1848000e7ae3SMatthew Knepley Level: intermediate 1849000e7ae3SMatthew Knepley 1850b8123daeSJed Brown Note: 1851b8123daeSJed Brown If a step is rejected, TSStep() will call this routine again before each attempt. 1852b8123daeSJed Brown The last completed time step number can be queried using TSGetTimeStepNumber(), the 1853b8123daeSJed Brown size of the step being attempted can be obtained using TSGetTimeStep(). 1854b8123daeSJed Brown 1855000e7ae3SMatthew Knepley .keywords: TS, timestep 1856b8123daeSJed Brown .seealso: TSSetPreStage(), TSSetPostStep(), TSStep() 1857000e7ae3SMatthew Knepley @*/ 18587087cfbeSBarry Smith PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS)) 1859000e7ae3SMatthew Knepley { 1860000e7ae3SMatthew Knepley PetscFunctionBegin; 18610700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1862000e7ae3SMatthew Knepley ts->ops->prestep = func; 1863000e7ae3SMatthew Knepley PetscFunctionReturn(0); 1864000e7ae3SMatthew Knepley } 1865000e7ae3SMatthew Knepley 1866e74ef692SMatthew Knepley #undef __FUNCT__ 18673f2090d5SJed Brown #define __FUNCT__ "TSPreStep" 186809ee8438SJed Brown /*@ 18693f2090d5SJed Brown TSPreStep - Runs the user-defined pre-step function. 18703f2090d5SJed Brown 18713f2090d5SJed Brown Collective on TS 18723f2090d5SJed Brown 18733f2090d5SJed Brown Input Parameters: 18743f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 18753f2090d5SJed Brown 18763f2090d5SJed Brown Notes: 18773f2090d5SJed Brown TSPreStep() is typically used within time stepping implementations, 18783f2090d5SJed Brown so most users would not generally call this routine themselves. 18793f2090d5SJed Brown 18803f2090d5SJed Brown Level: developer 18813f2090d5SJed Brown 18823f2090d5SJed Brown .keywords: TS, timestep 1883b8123daeSJed Brown .seealso: TSSetPreStep(), TSPreStage(), TSPostStep() 18843f2090d5SJed Brown @*/ 18857087cfbeSBarry Smith PetscErrorCode TSPreStep(TS ts) 18863f2090d5SJed Brown { 18873f2090d5SJed Brown PetscErrorCode ierr; 18883f2090d5SJed Brown 18893f2090d5SJed Brown PetscFunctionBegin; 18900700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 189172ac3e02SJed Brown if (ts->ops->prestep) { 18923f2090d5SJed Brown PetscStackPush("TS PreStep function"); 18933f2090d5SJed Brown ierr = (*ts->ops->prestep)(ts);CHKERRQ(ierr); 18943f2090d5SJed Brown PetscStackPop; 1895312ce896SJed Brown } 18963f2090d5SJed Brown PetscFunctionReturn(0); 18973f2090d5SJed Brown } 18983f2090d5SJed Brown 18993f2090d5SJed Brown #undef __FUNCT__ 1900b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage" 1901b8123daeSJed Brown /*@C 1902b8123daeSJed Brown TSSetPreStage - Sets the general-purpose function 1903b8123daeSJed Brown called once at the beginning of each stage. 1904b8123daeSJed Brown 1905b8123daeSJed Brown Logically Collective on TS 1906b8123daeSJed Brown 1907b8123daeSJed Brown Input Parameters: 1908b8123daeSJed Brown + ts - The TS context obtained from TSCreate() 1909b8123daeSJed Brown - func - The function 1910b8123daeSJed Brown 1911b8123daeSJed Brown Calling sequence of func: 1912b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime); 1913b8123daeSJed Brown 1914b8123daeSJed Brown Level: intermediate 1915b8123daeSJed Brown 1916b8123daeSJed Brown Note: 1917b8123daeSJed Brown There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 1918b8123daeSJed Brown The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 1919b8123daeSJed Brown attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 1920b8123daeSJed Brown 1921b8123daeSJed Brown .keywords: TS, timestep 1922b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 1923b8123daeSJed Brown @*/ 1924b8123daeSJed Brown PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal)) 1925b8123daeSJed Brown { 1926b8123daeSJed Brown PetscFunctionBegin; 1927b8123daeSJed Brown PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1928b8123daeSJed Brown ts->ops->prestage = func; 1929b8123daeSJed Brown PetscFunctionReturn(0); 1930b8123daeSJed Brown } 1931b8123daeSJed Brown 1932b8123daeSJed Brown #undef __FUNCT__ 1933b8123daeSJed Brown #define __FUNCT__ "TSPreStage" 1934b8123daeSJed Brown /*@ 1935b8123daeSJed Brown TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage() 1936b8123daeSJed Brown 1937b8123daeSJed Brown Collective on TS 1938b8123daeSJed Brown 1939b8123daeSJed Brown Input Parameters: 1940b8123daeSJed Brown . ts - The TS context obtained from TSCreate() 1941b8123daeSJed Brown 1942b8123daeSJed Brown Notes: 1943b8123daeSJed Brown TSPreStage() is typically used within time stepping implementations, 1944b8123daeSJed Brown most users would not generally call this routine themselves. 1945b8123daeSJed Brown 1946b8123daeSJed Brown Level: developer 1947b8123daeSJed Brown 1948b8123daeSJed Brown .keywords: TS, timestep 1949b8123daeSJed Brown .seealso: TSSetPreStep(), TSPreStep(), TSPostStep() 1950b8123daeSJed Brown @*/ 1951b8123daeSJed Brown PetscErrorCode TSPreStage(TS ts, PetscReal stagetime) 1952b8123daeSJed Brown { 1953b8123daeSJed Brown PetscErrorCode ierr; 1954b8123daeSJed Brown 1955b8123daeSJed Brown PetscFunctionBegin; 1956b8123daeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1957b8123daeSJed Brown if (ts->ops->prestage) { 1958b8123daeSJed Brown PetscStackPush("TS PreStage function"); 1959b8123daeSJed Brown ierr = (*ts->ops->prestage)(ts,stagetime);CHKERRQ(ierr); 1960b8123daeSJed Brown PetscStackPop; 1961b8123daeSJed Brown } 1962b8123daeSJed Brown PetscFunctionReturn(0); 1963b8123daeSJed Brown } 1964b8123daeSJed Brown 1965b8123daeSJed Brown #undef __FUNCT__ 1966e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep" 1967ac226902SBarry Smith /*@C 1968000e7ae3SMatthew Knepley TSSetPostStep - Sets the general-purpose function 19693f2090d5SJed Brown called once at the end of each time step. 1970000e7ae3SMatthew Knepley 19713f9fe445SBarry Smith Logically Collective on TS 1972000e7ae3SMatthew Knepley 1973000e7ae3SMatthew Knepley Input Parameters: 1974000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 1975000e7ae3SMatthew Knepley - func - The function 1976000e7ae3SMatthew Knepley 1977000e7ae3SMatthew Knepley Calling sequence of func: 1978b8123daeSJed Brown $ func (TS ts); 1979000e7ae3SMatthew Knepley 1980000e7ae3SMatthew Knepley Level: intermediate 1981000e7ae3SMatthew Knepley 1982000e7ae3SMatthew Knepley .keywords: TS, timestep 1983b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime() 1984000e7ae3SMatthew Knepley @*/ 19857087cfbeSBarry Smith PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS)) 1986000e7ae3SMatthew Knepley { 1987000e7ae3SMatthew Knepley PetscFunctionBegin; 19880700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1989000e7ae3SMatthew Knepley ts->ops->poststep = func; 1990000e7ae3SMatthew Knepley PetscFunctionReturn(0); 1991000e7ae3SMatthew Knepley } 1992000e7ae3SMatthew Knepley 1993e74ef692SMatthew Knepley #undef __FUNCT__ 19943f2090d5SJed Brown #define __FUNCT__ "TSPostStep" 199509ee8438SJed Brown /*@ 19963f2090d5SJed Brown TSPostStep - Runs the user-defined post-step function. 19973f2090d5SJed Brown 19983f2090d5SJed Brown Collective on TS 19993f2090d5SJed Brown 20003f2090d5SJed Brown Input Parameters: 20013f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 20023f2090d5SJed Brown 20033f2090d5SJed Brown Notes: 20043f2090d5SJed Brown TSPostStep() is typically used within time stepping implementations, 20053f2090d5SJed Brown so most users would not generally call this routine themselves. 20063f2090d5SJed Brown 20073f2090d5SJed Brown Level: developer 20083f2090d5SJed Brown 20093f2090d5SJed Brown .keywords: TS, timestep 20103f2090d5SJed Brown @*/ 20117087cfbeSBarry Smith PetscErrorCode TSPostStep(TS ts) 20123f2090d5SJed Brown { 20133f2090d5SJed Brown PetscErrorCode ierr; 20143f2090d5SJed Brown 20153f2090d5SJed Brown PetscFunctionBegin; 20160700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 201772ac3e02SJed Brown if (ts->ops->poststep) { 20183f2090d5SJed Brown PetscStackPush("TS PostStep function"); 20193f2090d5SJed Brown ierr = (*ts->ops->poststep)(ts);CHKERRQ(ierr); 20203f2090d5SJed Brown PetscStackPop; 202172ac3e02SJed Brown } 20223f2090d5SJed Brown PetscFunctionReturn(0); 20233f2090d5SJed Brown } 20243f2090d5SJed Brown 2025d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */ 2026d763cef2SBarry Smith 20274a2ae208SSatish Balay #undef __FUNCT__ 2028a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet" 2029d763cef2SBarry Smith /*@C 2030a6570f20SBarry Smith TSMonitorSet - Sets an ADDITIONAL function that is to be used at every 2031d763cef2SBarry Smith timestep to display the iteration's progress. 2032d763cef2SBarry Smith 20333f9fe445SBarry Smith Logically Collective on TS 2034d763cef2SBarry Smith 2035d763cef2SBarry Smith Input Parameters: 2036d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2037e213d8f1SJed Brown . monitor - monitoring routine 2038329f5518SBarry Smith . mctx - [optional] user-defined context for private data for the 2039b3006f0bSLois Curfman McInnes monitor routine (use PETSC_NULL if no context is desired) 2040b3006f0bSLois Curfman McInnes - monitordestroy - [optional] routine that frees monitor context 2041b3006f0bSLois Curfman McInnes (may be PETSC_NULL) 2042d763cef2SBarry Smith 2043e213d8f1SJed Brown Calling sequence of monitor: 20440910c330SBarry Smith $ int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx) 2045d763cef2SBarry Smith 2046d763cef2SBarry Smith + ts - the TS context 204788c05cc5SBarry 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 204888c05cc5SBarry Smith been interpolated to) 20491f06c33eSBarry Smith . time - current time 20500910c330SBarry Smith . u - current iterate 2051d763cef2SBarry Smith - mctx - [optional] monitoring context 2052d763cef2SBarry Smith 2053d763cef2SBarry Smith Notes: 2054d763cef2SBarry Smith This routine adds an additional monitor to the list of monitors that 2055d763cef2SBarry Smith already has been loaded. 2056d763cef2SBarry Smith 2057025f1a04SBarry Smith Fortran notes: Only a single monitor function can be set for each TS object 2058025f1a04SBarry Smith 2059d763cef2SBarry Smith Level: intermediate 2060d763cef2SBarry Smith 2061d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 2062d763cef2SBarry Smith 2063a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel() 2064d763cef2SBarry Smith @*/ 2065c2efdce3SBarry Smith PetscErrorCode TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**)) 2066d763cef2SBarry Smith { 2067d763cef2SBarry Smith PetscFunctionBegin; 20680700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 206917186662SBarry Smith if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 2070d763cef2SBarry Smith ts->monitor[ts->numbermonitors] = monitor; 20718704b422SBarry Smith ts->monitordestroy[ts->numbermonitors] = mdestroy; 2072d763cef2SBarry Smith ts->monitorcontext[ts->numbermonitors++] = (void*)mctx; 2073d763cef2SBarry Smith PetscFunctionReturn(0); 2074d763cef2SBarry Smith } 2075d763cef2SBarry Smith 20764a2ae208SSatish Balay #undef __FUNCT__ 2077a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel" 2078d763cef2SBarry Smith /*@C 2079a6570f20SBarry Smith TSMonitorCancel - Clears all the monitors that have been set on a time-step object. 2080d763cef2SBarry Smith 20813f9fe445SBarry Smith Logically Collective on TS 2082d763cef2SBarry Smith 2083d763cef2SBarry Smith Input Parameters: 2084d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2085d763cef2SBarry Smith 2086d763cef2SBarry Smith Notes: 2087d763cef2SBarry Smith There is no way to remove a single, specific monitor. 2088d763cef2SBarry Smith 2089d763cef2SBarry Smith Level: intermediate 2090d763cef2SBarry Smith 2091d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 2092d763cef2SBarry Smith 2093a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet() 2094d763cef2SBarry Smith @*/ 20957087cfbeSBarry Smith PetscErrorCode TSMonitorCancel(TS ts) 2096d763cef2SBarry Smith { 2097d952e501SBarry Smith PetscErrorCode ierr; 2098d952e501SBarry Smith PetscInt i; 2099d952e501SBarry Smith 2100d763cef2SBarry Smith PetscFunctionBegin; 21010700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2102d952e501SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 21038704b422SBarry Smith if (ts->monitordestroy[i]) { 21048704b422SBarry Smith ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr); 2105d952e501SBarry Smith } 2106d952e501SBarry Smith } 2107d763cef2SBarry Smith ts->numbermonitors = 0; 2108d763cef2SBarry Smith PetscFunctionReturn(0); 2109d763cef2SBarry Smith } 2110d763cef2SBarry Smith 21114a2ae208SSatish Balay #undef __FUNCT__ 2112a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault" 2113d8e5e3e6SSatish Balay /*@ 2114a6570f20SBarry Smith TSMonitorDefault - Sets the Default monitor 21155516499fSSatish Balay 21165516499fSSatish Balay Level: intermediate 211741251cbbSSatish Balay 21185516499fSSatish Balay .keywords: TS, set, monitor 21195516499fSSatish Balay 212041251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet() 212141251cbbSSatish Balay @*/ 2122649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy) 2123d763cef2SBarry Smith { 2124dfbe8321SBarry Smith PetscErrorCode ierr; 2125649052a6SBarry Smith PetscViewer viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(((PetscObject)ts)->comm); 2126d132466eSBarry Smith 2127d763cef2SBarry Smith PetscFunctionBegin; 2128649052a6SBarry Smith ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 2129971832b6SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g\n",step,(double)ts->time_step,(double)ptime);CHKERRQ(ierr); 2130649052a6SBarry Smith ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 2131d763cef2SBarry Smith PetscFunctionReturn(0); 2132d763cef2SBarry Smith } 2133d763cef2SBarry Smith 21344a2ae208SSatish Balay #undef __FUNCT__ 2135cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages" 2136cd652676SJed Brown /*@ 2137cd652676SJed Brown TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available. 2138cd652676SJed Brown 2139cd652676SJed Brown Logically Collective on TS 2140cd652676SJed Brown 2141cd652676SJed Brown Input Argument: 2142cd652676SJed Brown . ts - time stepping context 2143cd652676SJed Brown 2144cd652676SJed Brown Output Argument: 2145cd652676SJed Brown . flg - PETSC_TRUE or PETSC_FALSE 2146cd652676SJed Brown 2147cd652676SJed Brown Level: intermediate 2148cd652676SJed Brown 2149cd652676SJed Brown .keywords: TS, set 2150cd652676SJed Brown 2151cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep() 2152cd652676SJed Brown @*/ 2153cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg) 2154cd652676SJed Brown { 2155cd652676SJed Brown PetscFunctionBegin; 2156cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2157cd652676SJed Brown ts->retain_stages = flg; 2158cd652676SJed Brown PetscFunctionReturn(0); 2159cd652676SJed Brown } 2160cd652676SJed Brown 2161cd652676SJed Brown #undef __FUNCT__ 2162cd652676SJed Brown #define __FUNCT__ "TSInterpolate" 2163cd652676SJed Brown /*@ 2164cd652676SJed Brown TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval 2165cd652676SJed Brown 2166cd652676SJed Brown Collective on TS 2167cd652676SJed Brown 2168cd652676SJed Brown Input Argument: 2169cd652676SJed Brown + ts - time stepping context 2170cd652676SJed Brown - t - time to interpolate to 2171cd652676SJed Brown 2172cd652676SJed Brown Output Argument: 21730910c330SBarry Smith . U - state at given time 2174cd652676SJed Brown 2175cd652676SJed Brown Notes: 2176cd652676SJed Brown The user should call TSSetRetainStages() before taking a step in which interpolation will be requested. 2177cd652676SJed Brown 2178cd652676SJed Brown Level: intermediate 2179cd652676SJed Brown 2180cd652676SJed Brown Developer Notes: 2181cd652676SJed Brown TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints. 2182cd652676SJed Brown 2183cd652676SJed Brown .keywords: TS, set 2184cd652676SJed Brown 2185cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep() 2186cd652676SJed Brown @*/ 21870910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U) 2188cd652676SJed Brown { 2189cd652676SJed Brown PetscErrorCode ierr; 2190cd652676SJed Brown 2191cd652676SJed Brown PetscFunctionBegin; 2192cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2193d8cd7023SBarry Smith if (t < ts->ptime - ts->time_step_prev || t > ts->ptime) SETERRQ3(((PetscObject)ts)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Requested time %G not in last time steps [%G,%G]",t,ts->ptime-ts->time_step_prev,ts->ptime); 2194cd652676SJed Brown if (!ts->ops->interpolate) SETERRQ1(((PetscObject)ts)->comm,PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name); 21950910c330SBarry Smith ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr); 2196cd652676SJed Brown PetscFunctionReturn(0); 2197cd652676SJed Brown } 2198cd652676SJed Brown 2199cd652676SJed Brown #undef __FUNCT__ 22004a2ae208SSatish Balay #define __FUNCT__ "TSStep" 2201d763cef2SBarry Smith /*@ 22026d9e5789SSean Farley TSStep - Steps one time step 2203d763cef2SBarry Smith 2204d763cef2SBarry Smith Collective on TS 2205d763cef2SBarry Smith 2206d763cef2SBarry Smith Input Parameter: 2207d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2208d763cef2SBarry Smith 22096d9e5789SSean Farley Level: intermediate 2210d763cef2SBarry Smith 2211b8123daeSJed Brown Notes: 2212b8123daeSJed Brown The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may 2213b8123daeSJed Brown be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages. 2214b8123daeSJed Brown 221525cb2221SBarry Smith This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the 221625cb2221SBarry Smith time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep. 221725cb2221SBarry Smith 2218d763cef2SBarry Smith .keywords: TS, timestep, solve 2219d763cef2SBarry Smith 222025cb2221SBarry Smith .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate() 2221d763cef2SBarry Smith @*/ 2222193ac0bcSJed Brown PetscErrorCode TSStep(TS ts) 2223d763cef2SBarry Smith { 2224362cd11cSLisandro Dalcin PetscReal ptime_prev; 2225dfbe8321SBarry Smith PetscErrorCode ierr; 2226d763cef2SBarry Smith 2227d763cef2SBarry Smith PetscFunctionBegin; 22280700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2229d405a339SMatthew Knepley ierr = TSSetUp(ts);CHKERRQ(ierr); 2230d405a339SMatthew Knepley 2231362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_ITERATING; 2232362cd11cSLisandro Dalcin 2233362cd11cSLisandro Dalcin ptime_prev = ts->ptime; 2234d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 2235193ac0bcSJed Brown ierr = (*ts->ops->step)(ts);CHKERRQ(ierr); 2236d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 2237362cd11cSLisandro Dalcin ts->time_step_prev = ts->ptime - ptime_prev; 2238362cd11cSLisandro Dalcin 2239362cd11cSLisandro Dalcin if (ts->reason < 0) { 2240cef5090cSJed Brown if (ts->errorifstepfailed) { 2241cef5090cSJed Brown if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) { 2242cef5090cSJed Brown SETERRQ1(((PetscObject)ts)->comm,PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_snes_failures or make negative to attempt recovery",TSConvergedReasons[ts->reason]); 2243cef5090cSJed Brown } else SETERRQ1(((PetscObject)ts)->comm,PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 2244cef5090cSJed Brown } 2245362cd11cSLisandro Dalcin } else if (!ts->reason) { 2246362cd11cSLisandro Dalcin if (ts->steps >= ts->max_steps) 2247362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_ITS; 2248362cd11cSLisandro Dalcin else if (ts->ptime >= ts->max_time) 2249362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_TIME; 2250362cd11cSLisandro Dalcin } 2251362cd11cSLisandro Dalcin 2252d763cef2SBarry Smith PetscFunctionReturn(0); 2253d763cef2SBarry Smith } 2254d763cef2SBarry Smith 22554a2ae208SSatish Balay #undef __FUNCT__ 225605175c85SJed Brown #define __FUNCT__ "TSEvaluateStep" 225705175c85SJed Brown /*@ 225805175c85SJed Brown TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy. 225905175c85SJed Brown 22601c3436cfSJed Brown Collective on TS 226105175c85SJed Brown 226205175c85SJed Brown Input Arguments: 22631c3436cfSJed Brown + ts - time stepping context 22641c3436cfSJed Brown . order - desired order of accuracy 22651c3436cfSJed Brown - done - whether the step was evaluated at this order (pass PETSC_NULL to generate an error if not available) 226605175c85SJed Brown 226705175c85SJed Brown Output Arguments: 22680910c330SBarry Smith . U - state at the end of the current step 226905175c85SJed Brown 227005175c85SJed Brown Level: advanced 227105175c85SJed Brown 2272108c343cSJed Brown Notes: 2273108c343cSJed Brown This function cannot be called until all stages have been evaluated. 2274108c343cSJed 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. 2275108c343cSJed Brown 22761c3436cfSJed Brown .seealso: TSStep(), TSAdapt 227705175c85SJed Brown @*/ 22780910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done) 227905175c85SJed Brown { 228005175c85SJed Brown PetscErrorCode ierr; 228105175c85SJed Brown 228205175c85SJed Brown PetscFunctionBegin; 228305175c85SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 228405175c85SJed Brown PetscValidType(ts,1); 22850910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 22861c3436cfSJed Brown if (!ts->ops->evaluatestep) SETERRQ1(((PetscObject)ts)->comm,PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name); 22870910c330SBarry Smith ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr); 228805175c85SJed Brown PetscFunctionReturn(0); 228905175c85SJed Brown } 229005175c85SJed Brown 229105175c85SJed Brown #undef __FUNCT__ 22926a4d4014SLisandro Dalcin #define __FUNCT__ "TSSolve" 22936a4d4014SLisandro Dalcin /*@ 22946a4d4014SLisandro Dalcin TSSolve - Steps the requested number of timesteps. 22956a4d4014SLisandro Dalcin 22966a4d4014SLisandro Dalcin Collective on TS 22976a4d4014SLisandro Dalcin 22986a4d4014SLisandro Dalcin Input Parameter: 22996a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 2300cc708dedSBarry Smith - u - the solution vector (can be null if TSSetSolution() was used, otherwise must contain the initial conditions) 23015a3a76d0SJed Brown 23026a4d4014SLisandro Dalcin Level: beginner 23036a4d4014SLisandro Dalcin 23045a3a76d0SJed Brown Notes: 23055a3a76d0SJed Brown The final time returned by this function may be different from the time of the internally 23065a3a76d0SJed Brown held state accessible by TSGetSolution() and TSGetTime() because the method may have 23075a3a76d0SJed Brown stepped over the final time. 23085a3a76d0SJed Brown 23096a4d4014SLisandro Dalcin .keywords: TS, timestep, solve 23106a4d4014SLisandro Dalcin 23116a4d4014SLisandro Dalcin .seealso: TSCreate(), TSSetSolution(), TSStep() 23126a4d4014SLisandro Dalcin @*/ 2313cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u) 23146a4d4014SLisandro Dalcin { 23154d7d938eSLisandro Dalcin PetscBool flg; 23164d7d938eSLisandro Dalcin char filename[PETSC_MAX_PATH_LEN]; 23174d7d938eSLisandro Dalcin PetscViewer viewer; 23186a4d4014SLisandro Dalcin PetscErrorCode ierr; 2319f22f69f0SBarry Smith 23206a4d4014SLisandro Dalcin PetscFunctionBegin; 23210700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2322f2c2a1b9SBarry Smith if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2); 23235a3a76d0SJed Brown if (ts->exact_final_time) { /* Need ts->vec_sol to be distinct so it is not overwritten when we interpolate at the end */ 23240910c330SBarry Smith if (!ts->vec_sol || u == ts->vec_sol) { 23255a3a76d0SJed Brown Vec y; 23260910c330SBarry Smith ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 23275a3a76d0SJed Brown ierr = TSSetSolution(ts,y);CHKERRQ(ierr); 23285a3a76d0SJed Brown ierr = VecDestroy(&y);CHKERRQ(ierr); /* grant ownership */ 23295a3a76d0SJed Brown } 2330f2c2a1b9SBarry Smith if (u) { 23310910c330SBarry Smith ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr); 2332f2c2a1b9SBarry Smith } 23335a3a76d0SJed Brown } else { 2334f2c2a1b9SBarry Smith if (u) { 23350910c330SBarry Smith ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 23365a3a76d0SJed Brown } 2337f2c2a1b9SBarry Smith } 2338b5d403baSSean Farley ierr = TSSetUp(ts);CHKERRQ(ierr); 23396a4d4014SLisandro Dalcin /* reset time step and iteration counters */ 2340193ac0bcSJed Brown ts->steps = 0; 23415ef26d82SJed Brown ts->ksp_its = 0; 23425ef26d82SJed Brown ts->snes_its = 0; 2343c610991cSLisandro Dalcin ts->num_snes_failures = 0; 2344c610991cSLisandro Dalcin ts->reject = 0; 2345193ac0bcSJed Brown ts->reason = TS_CONVERGED_ITERATING; 2346193ac0bcSJed Brown 2347193ac0bcSJed Brown if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 2348193ac0bcSJed Brown ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr); 23490910c330SBarry Smith ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr); 2350cc708dedSBarry Smith ts->solvetime = ts->ptime; 2351193ac0bcSJed Brown } else { 23526a4d4014SLisandro Dalcin /* steps the requested number of timesteps. */ 2353362cd11cSLisandro Dalcin ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 2354362cd11cSLisandro Dalcin if (ts->steps >= ts->max_steps) 2355362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_ITS; 2356362cd11cSLisandro Dalcin else if (ts->ptime >= ts->max_time) 2357362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_TIME; 2358e1a7a14fSJed Brown while (!ts->reason) { 2359193ac0bcSJed Brown ierr = TSStep(ts);CHKERRQ(ierr); 2360193ac0bcSJed Brown ierr = TSPostStep(ts);CHKERRQ(ierr); 2361193ac0bcSJed Brown ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 2362193ac0bcSJed Brown } 2363362cd11cSLisandro Dalcin if (ts->exact_final_time && ts->ptime > ts->max_time) { 23640910c330SBarry Smith ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr); 2365cc708dedSBarry Smith ts->solvetime = ts->max_time; 23660574a7fbSJed Brown } else { 23670910c330SBarry Smith ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr); 2368cc708dedSBarry Smith ts->solvetime = ts->ptime; 23690574a7fbSJed Brown } 2370193ac0bcSJed Brown } 23713923b477SBarry Smith ierr = TSMonitor(ts,-1,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 23724d7d938eSLisandro Dalcin ierr = PetscOptionsGetString(((PetscObject)ts)->prefix,"-ts_view",filename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 23734d7d938eSLisandro Dalcin if (flg && !PetscPreLoadingOn) { 23744d7d938eSLisandro Dalcin ierr = PetscViewerASCIIOpen(((PetscObject)ts)->comm,filename,&viewer);CHKERRQ(ierr); 23754d7d938eSLisandro Dalcin ierr = TSView(ts,viewer);CHKERRQ(ierr); 23764d7d938eSLisandro Dalcin ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 2377193ac0bcSJed Brown } 2378*2b0a91c0SBarry Smith flg = PETSC_FALSE; 2379*2b0a91c0SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)ts)->prefix,"-ts_view_draw",&flg,PETSC_NULL);CHKERRQ(ierr); 2380*2b0a91c0SBarry Smith if (flg) { 2381*2b0a91c0SBarry Smith ierr = PetscViewerDrawOpen(((PetscObject)ts)->comm,PETSC_NULL,"TS Solver",0,0,600,600,&viewer);CHKERRQ(ierr); 2382*2b0a91c0SBarry Smith ierr = TSView(ts,viewer);CHKERRQ(ierr); 2383*2b0a91c0SBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 2384*2b0a91c0SBarry Smith } 23856a4d4014SLisandro Dalcin PetscFunctionReturn(0); 23866a4d4014SLisandro Dalcin } 23876a4d4014SLisandro Dalcin 23886a4d4014SLisandro Dalcin #undef __FUNCT__ 23894a2ae208SSatish Balay #define __FUNCT__ "TSMonitor" 2390228d79bcSJed Brown /*@ 2391228d79bcSJed Brown TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet() 2392228d79bcSJed Brown 2393228d79bcSJed Brown Collective on TS 2394228d79bcSJed Brown 2395228d79bcSJed Brown Input Parameters: 2396228d79bcSJed Brown + ts - time stepping context obtained from TSCreate() 2397228d79bcSJed Brown . step - step number that has just completed 2398228d79bcSJed Brown . ptime - model time of the state 23990910c330SBarry Smith - u - state at the current model time 2400228d79bcSJed Brown 2401228d79bcSJed Brown Notes: 2402228d79bcSJed Brown TSMonitor() is typically used within the time stepping implementations. 2403228d79bcSJed Brown Users might call this function when using the TSStep() interface instead of TSSolve(). 2404228d79bcSJed Brown 2405228d79bcSJed Brown Level: advanced 2406228d79bcSJed Brown 2407228d79bcSJed Brown .keywords: TS, timestep 2408228d79bcSJed Brown @*/ 24090910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u) 2410d763cef2SBarry Smith { 24116849ba73SBarry Smith PetscErrorCode ierr; 2412a7cc72afSBarry Smith PetscInt i,n = ts->numbermonitors; 2413d763cef2SBarry Smith 2414d763cef2SBarry Smith PetscFunctionBegin; 2415d763cef2SBarry Smith for (i=0; i<n; i++) { 24160910c330SBarry Smith ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr); 2417d763cef2SBarry Smith } 2418d763cef2SBarry Smith PetscFunctionReturn(0); 2419d763cef2SBarry Smith } 2420d763cef2SBarry Smith 2421d763cef2SBarry Smith /* ------------------------------------------------------------------------*/ 24220b039ecaSBarry Smith struct _n_TSMonitorLGCtx { 24230b039ecaSBarry Smith PetscDrawLG lg; 24240b039ecaSBarry Smith PetscInt howoften; /* when > 0 uses step % howoften, when negative only final solution plotted */ 2425201da799SBarry Smith PetscInt ksp_its,snes_its; 24260b039ecaSBarry Smith }; 24270b039ecaSBarry Smith 2428d763cef2SBarry Smith 24294a2ae208SSatish Balay #undef __FUNCT__ 2430a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate" 2431d763cef2SBarry Smith /*@C 2432a9f9c1f6SBarry Smith TSMonitorLGCtxCreate - Creates a line graph context for use with 2433a9f9c1f6SBarry Smith TS to monitor the solution process graphically in various ways 2434d763cef2SBarry Smith 2435d763cef2SBarry Smith Collective on TS 2436d763cef2SBarry Smith 2437d763cef2SBarry Smith Input Parameters: 2438d763cef2SBarry Smith + host - the X display to open, or null for the local machine 2439d763cef2SBarry Smith . label - the title to put in the title bar 24407c922b88SBarry Smith . x, y - the screen coordinates of the upper left coordinate of the window 2441a9f9c1f6SBarry Smith . m, n - the screen width and height in pixels 2442a9f9c1f6SBarry Smith - howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time 2443d763cef2SBarry Smith 2444d763cef2SBarry Smith Output Parameter: 24450b039ecaSBarry Smith . ctx - the context 2446d763cef2SBarry Smith 2447d763cef2SBarry Smith Options Database Key: 24484f09c107SBarry Smith + -ts_monitor_lg_timestep - automatically sets line graph monitor 24494f09c107SBarry Smith . -ts_monitor_lg_solution - 245099fdda47SBarry Smith . -ts_monitor_lg_error - 245199fdda47SBarry Smith . -ts_monitor_lg_ksp_iterations - 245299fdda47SBarry Smith . -ts_monitor_lg_snes_iterations - 245399fdda47SBarry Smith - -lg_indicate_data_points <true,false> - indicate the data points (at each time step) on the plot; default is true 2454d763cef2SBarry Smith 2455d763cef2SBarry Smith Notes: 2456a9f9c1f6SBarry Smith Use TSMonitorLGCtxDestroy() to destroy. 2457d763cef2SBarry Smith 2458d763cef2SBarry Smith Level: intermediate 2459d763cef2SBarry Smith 24607c922b88SBarry Smith .keywords: TS, monitor, line graph, residual, seealso 2461d763cef2SBarry Smith 24624f09c107SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError() 24637c922b88SBarry Smith 2464d763cef2SBarry Smith @*/ 2465a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx) 2466d763cef2SBarry Smith { 2467b0a32e0cSBarry Smith PetscDraw win; 2468dfbe8321SBarry Smith PetscErrorCode ierr; 246999fdda47SBarry Smith PetscBool flg = PETSC_TRUE; 2470d763cef2SBarry Smith 2471d763cef2SBarry Smith PetscFunctionBegin; 2472201da799SBarry Smith ierr = PetscNew(struct _n_TSMonitorLGCtx,ctx);CHKERRQ(ierr); 2473a80ad3e0SBarry Smith ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&win);CHKERRQ(ierr); 24743fbbecb0SBarry Smith ierr = PetscDrawSetFromOptions(win);CHKERRQ(ierr); 24750b039ecaSBarry Smith ierr = PetscDrawLGCreate(win,1,&(*ctx)->lg);CHKERRQ(ierr); 247699fdda47SBarry Smith ierr = PetscOptionsGetBool(PETSC_NULL,"-lg_indicate_data_points",&flg,PETSC_NULL);CHKERRQ(ierr); 247799fdda47SBarry Smith if (flg) { 24780b039ecaSBarry Smith ierr = PetscDrawLGIndicateDataPoints((*ctx)->lg);CHKERRQ(ierr); 247999fdda47SBarry Smith } 24800b039ecaSBarry Smith ierr = PetscLogObjectParent((*ctx)->lg,win);CHKERRQ(ierr); 2481a9f9c1f6SBarry Smith (*ctx)->howoften = howoften; 2482d763cef2SBarry Smith PetscFunctionReturn(0); 2483d763cef2SBarry Smith } 2484d763cef2SBarry Smith 24854a2ae208SSatish Balay #undef __FUNCT__ 24864f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep" 24874f09c107SBarry Smith PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 2488d763cef2SBarry Smith { 24890b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 2490c32365f1SBarry Smith PetscReal x = ptime,y; 2491dfbe8321SBarry Smith PetscErrorCode ierr; 2492d763cef2SBarry Smith 2493d763cef2SBarry Smith PetscFunctionBegin; 2494a9f9c1f6SBarry Smith if (!n) { 2495a9f9c1f6SBarry Smith PetscDrawAxis axis; 2496a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 2497a9f9c1f6SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time step");CHKERRQ(ierr); 2498a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 2499a9f9c1f6SBarry Smith } 2500c32365f1SBarry Smith ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr); 25010b039ecaSBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 250299fdda47SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften))) || ((ctx->howoften == -1) && (n == -1))){ 25030b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 25043923b477SBarry Smith } 2505d763cef2SBarry Smith PetscFunctionReturn(0); 2506d763cef2SBarry Smith } 2507d763cef2SBarry Smith 25084a2ae208SSatish Balay #undef __FUNCT__ 2509a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy" 2510d763cef2SBarry Smith /*@C 2511a9f9c1f6SBarry Smith TSMonitorLGCtxDestroy - Destroys a line graph context that was created 2512a9f9c1f6SBarry Smith with TSMonitorLGCtxCreate(). 2513d763cef2SBarry Smith 25140b039ecaSBarry Smith Collective on TSMonitorLGCtx 2515d763cef2SBarry Smith 2516d763cef2SBarry Smith Input Parameter: 25170b039ecaSBarry Smith . ctx - the monitor context 2518d763cef2SBarry Smith 2519d763cef2SBarry Smith Level: intermediate 2520d763cef2SBarry Smith 2521d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy 2522d763cef2SBarry Smith 25234f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep(); 2524d763cef2SBarry Smith @*/ 2525a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx) 2526d763cef2SBarry Smith { 2527b0a32e0cSBarry Smith PetscDraw draw; 2528dfbe8321SBarry Smith PetscErrorCode ierr; 2529d763cef2SBarry Smith 2530d763cef2SBarry Smith PetscFunctionBegin; 25310b039ecaSBarry Smith ierr = PetscDrawLGGetDraw((*ctx)->lg,&draw);CHKERRQ(ierr); 25326bf464f9SBarry Smith ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 25330b039ecaSBarry Smith ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr); 25340b039ecaSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 2535d763cef2SBarry Smith PetscFunctionReturn(0); 2536d763cef2SBarry Smith } 2537d763cef2SBarry Smith 25384a2ae208SSatish Balay #undef __FUNCT__ 25394a2ae208SSatish Balay #define __FUNCT__ "TSGetTime" 2540d763cef2SBarry Smith /*@ 2541b8123daeSJed Brown TSGetTime - Gets the time of the most recently completed step. 2542d763cef2SBarry Smith 2543d763cef2SBarry Smith Not Collective 2544d763cef2SBarry Smith 2545d763cef2SBarry Smith Input Parameter: 2546d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2547d763cef2SBarry Smith 2548d763cef2SBarry Smith Output Parameter: 2549d763cef2SBarry Smith . t - the current time 2550d763cef2SBarry Smith 2551d763cef2SBarry Smith Level: beginner 2552d763cef2SBarry Smith 2553b8123daeSJed Brown Note: 2554b8123daeSJed Brown When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(), 2555b8123daeSJed Brown TSSetPreStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated. 2556b8123daeSJed Brown 2557d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 2558d763cef2SBarry Smith 2559d763cef2SBarry Smith .keywords: TS, get, time 2560d763cef2SBarry Smith @*/ 25617087cfbeSBarry Smith PetscErrorCode TSGetTime(TS ts,PetscReal* t) 2562d763cef2SBarry Smith { 2563d763cef2SBarry Smith PetscFunctionBegin; 25640700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2565f7cf8827SBarry Smith PetscValidRealPointer(t,2); 2566d763cef2SBarry Smith *t = ts->ptime; 2567d763cef2SBarry Smith PetscFunctionReturn(0); 2568d763cef2SBarry Smith } 2569d763cef2SBarry Smith 25704a2ae208SSatish Balay #undef __FUNCT__ 25716a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime" 25726a4d4014SLisandro Dalcin /*@ 25736a4d4014SLisandro Dalcin TSSetTime - Allows one to reset the time. 25746a4d4014SLisandro Dalcin 25753f9fe445SBarry Smith Logically Collective on TS 25766a4d4014SLisandro Dalcin 25776a4d4014SLisandro Dalcin Input Parameters: 25786a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 25796a4d4014SLisandro Dalcin - time - the time 25806a4d4014SLisandro Dalcin 25816a4d4014SLisandro Dalcin Level: intermediate 25826a4d4014SLisandro Dalcin 25836a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration() 25846a4d4014SLisandro Dalcin 25856a4d4014SLisandro Dalcin .keywords: TS, set, time 25866a4d4014SLisandro Dalcin @*/ 25877087cfbeSBarry Smith PetscErrorCode TSSetTime(TS ts, PetscReal t) 25886a4d4014SLisandro Dalcin { 25896a4d4014SLisandro Dalcin PetscFunctionBegin; 25900700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2591c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,t,2); 25926a4d4014SLisandro Dalcin ts->ptime = t; 25936a4d4014SLisandro Dalcin PetscFunctionReturn(0); 25946a4d4014SLisandro Dalcin } 25956a4d4014SLisandro Dalcin 25966a4d4014SLisandro Dalcin #undef __FUNCT__ 25974a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix" 2598d763cef2SBarry Smith /*@C 2599d763cef2SBarry Smith TSSetOptionsPrefix - Sets the prefix used for searching for all 2600d763cef2SBarry Smith TS options in the database. 2601d763cef2SBarry Smith 26023f9fe445SBarry Smith Logically Collective on TS 2603d763cef2SBarry Smith 2604d763cef2SBarry Smith Input Parameter: 2605d763cef2SBarry Smith + ts - The TS context 2606d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 2607d763cef2SBarry Smith 2608d763cef2SBarry Smith Notes: 2609d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 2610d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 2611d763cef2SBarry Smith hyphen. 2612d763cef2SBarry Smith 2613d763cef2SBarry Smith Level: advanced 2614d763cef2SBarry Smith 2615d763cef2SBarry Smith .keywords: TS, set, options, prefix, database 2616d763cef2SBarry Smith 2617d763cef2SBarry Smith .seealso: TSSetFromOptions() 2618d763cef2SBarry Smith 2619d763cef2SBarry Smith @*/ 26207087cfbeSBarry Smith PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[]) 2621d763cef2SBarry Smith { 2622dfbe8321SBarry Smith PetscErrorCode ierr; 2623089b2837SJed Brown SNES snes; 2624d763cef2SBarry Smith 2625d763cef2SBarry Smith PetscFunctionBegin; 26260700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2627d763cef2SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 2628089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2629089b2837SJed Brown ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr); 2630d763cef2SBarry Smith PetscFunctionReturn(0); 2631d763cef2SBarry Smith } 2632d763cef2SBarry Smith 2633d763cef2SBarry Smith 26344a2ae208SSatish Balay #undef __FUNCT__ 26354a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix" 2636d763cef2SBarry Smith /*@C 2637d763cef2SBarry Smith TSAppendOptionsPrefix - Appends to the prefix used for searching for all 2638d763cef2SBarry Smith TS options in the database. 2639d763cef2SBarry Smith 26403f9fe445SBarry Smith Logically Collective on TS 2641d763cef2SBarry Smith 2642d763cef2SBarry Smith Input Parameter: 2643d763cef2SBarry Smith + ts - The TS context 2644d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 2645d763cef2SBarry Smith 2646d763cef2SBarry Smith Notes: 2647d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 2648d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 2649d763cef2SBarry Smith hyphen. 2650d763cef2SBarry Smith 2651d763cef2SBarry Smith Level: advanced 2652d763cef2SBarry Smith 2653d763cef2SBarry Smith .keywords: TS, append, options, prefix, database 2654d763cef2SBarry Smith 2655d763cef2SBarry Smith .seealso: TSGetOptionsPrefix() 2656d763cef2SBarry Smith 2657d763cef2SBarry Smith @*/ 26587087cfbeSBarry Smith PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[]) 2659d763cef2SBarry Smith { 2660dfbe8321SBarry Smith PetscErrorCode ierr; 2661089b2837SJed Brown SNES snes; 2662d763cef2SBarry Smith 2663d763cef2SBarry Smith PetscFunctionBegin; 26640700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2665d763cef2SBarry Smith ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 2666089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2667089b2837SJed Brown ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr); 2668d763cef2SBarry Smith PetscFunctionReturn(0); 2669d763cef2SBarry Smith } 2670d763cef2SBarry Smith 26714a2ae208SSatish Balay #undef __FUNCT__ 26724a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix" 2673d763cef2SBarry Smith /*@C 2674d763cef2SBarry Smith TSGetOptionsPrefix - Sets the prefix used for searching for all 2675d763cef2SBarry Smith TS options in the database. 2676d763cef2SBarry Smith 2677d763cef2SBarry Smith Not Collective 2678d763cef2SBarry Smith 2679d763cef2SBarry Smith Input Parameter: 2680d763cef2SBarry Smith . ts - The TS context 2681d763cef2SBarry Smith 2682d763cef2SBarry Smith Output Parameter: 2683d763cef2SBarry Smith . prefix - A pointer to the prefix string used 2684d763cef2SBarry Smith 2685d763cef2SBarry Smith Notes: On the fortran side, the user should pass in a string 'prifix' of 2686d763cef2SBarry Smith sufficient length to hold the prefix. 2687d763cef2SBarry Smith 2688d763cef2SBarry Smith Level: intermediate 2689d763cef2SBarry Smith 2690d763cef2SBarry Smith .keywords: TS, get, options, prefix, database 2691d763cef2SBarry Smith 2692d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix() 2693d763cef2SBarry Smith @*/ 26947087cfbeSBarry Smith PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[]) 2695d763cef2SBarry Smith { 2696dfbe8321SBarry Smith PetscErrorCode ierr; 2697d763cef2SBarry Smith 2698d763cef2SBarry Smith PetscFunctionBegin; 26990700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 27004482741eSBarry Smith PetscValidPointer(prefix,2); 2701d763cef2SBarry Smith ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 2702d763cef2SBarry Smith PetscFunctionReturn(0); 2703d763cef2SBarry Smith } 2704d763cef2SBarry Smith 27054a2ae208SSatish Balay #undef __FUNCT__ 27064a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian" 2707d763cef2SBarry Smith /*@C 2708d763cef2SBarry Smith TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 2709d763cef2SBarry Smith 2710d763cef2SBarry Smith Not Collective, but parallel objects are returned if TS is parallel 2711d763cef2SBarry Smith 2712d763cef2SBarry Smith Input Parameter: 2713d763cef2SBarry Smith . ts - The TS context obtained from TSCreate() 2714d763cef2SBarry Smith 2715d763cef2SBarry Smith Output Parameters: 2716b5abc632SBarry Smith + J - The Jacobian J of F, where U_t = G(U,t) 2717d763cef2SBarry Smith . M - The preconditioner matrix, usually the same as J 2718089b2837SJed Brown . func - Function to compute the Jacobian of the RHS 2719d763cef2SBarry Smith - ctx - User-defined context for Jacobian evaluation routine 2720d763cef2SBarry Smith 2721d763cef2SBarry Smith Notes: You can pass in PETSC_NULL for any return argument you do not need. 2722d763cef2SBarry Smith 2723d763cef2SBarry Smith Level: intermediate 2724d763cef2SBarry Smith 272526d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 2726d763cef2SBarry Smith 2727d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian 2728d763cef2SBarry Smith @*/ 2729089b2837SJed Brown PetscErrorCode TSGetRHSJacobian(TS ts,Mat *J,Mat *M,TSRHSJacobian *func,void **ctx) 2730d763cef2SBarry Smith { 2731089b2837SJed Brown PetscErrorCode ierr; 2732089b2837SJed Brown SNES snes; 273324989b8cSPeter Brune DM dm; 2734089b2837SJed Brown 2735d763cef2SBarry Smith PetscFunctionBegin; 2736089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2737089b2837SJed Brown ierr = SNESGetJacobian(snes,J,M,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 273824989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 273924989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr); 2740d763cef2SBarry Smith PetscFunctionReturn(0); 2741d763cef2SBarry Smith } 2742d763cef2SBarry Smith 27431713a123SBarry Smith #undef __FUNCT__ 27442eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian" 27452eca1d9cSJed Brown /*@C 27462eca1d9cSJed Brown TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 27472eca1d9cSJed Brown 27482eca1d9cSJed Brown Not Collective, but parallel objects are returned if TS is parallel 27492eca1d9cSJed Brown 27502eca1d9cSJed Brown Input Parameter: 27512eca1d9cSJed Brown . ts - The TS context obtained from TSCreate() 27522eca1d9cSJed Brown 27532eca1d9cSJed Brown Output Parameters: 27542eca1d9cSJed Brown + A - The Jacobian of F(t,U,U_t) 27552eca1d9cSJed Brown . B - The preconditioner matrix, often the same as A 27562eca1d9cSJed Brown . f - The function to compute the matrices 27572eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine 27582eca1d9cSJed Brown 27592eca1d9cSJed Brown Notes: You can pass in PETSC_NULL for any return argument you do not need. 27602eca1d9cSJed Brown 27612eca1d9cSJed Brown Level: advanced 27622eca1d9cSJed Brown 27632eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 27642eca1d9cSJed Brown 27652eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian 27662eca1d9cSJed Brown @*/ 27677087cfbeSBarry Smith PetscErrorCode TSGetIJacobian(TS ts,Mat *A,Mat *B,TSIJacobian *f,void **ctx) 27682eca1d9cSJed Brown { 2769089b2837SJed Brown PetscErrorCode ierr; 2770089b2837SJed Brown SNES snes; 277124989b8cSPeter Brune DM dm; 27720910c330SBarry Smith 27732eca1d9cSJed Brown PetscFunctionBegin; 2774089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2775f7d39f7aSBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 2776089b2837SJed Brown ierr = SNESGetJacobian(snes,A,B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 277724989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 277824989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr); 27792eca1d9cSJed Brown PetscFunctionReturn(0); 27802eca1d9cSJed Brown } 27812eca1d9cSJed Brown 278283a4ac43SBarry Smith struct _n_TSMonitorDrawCtx { 27836083293cSBarry Smith PetscViewer viewer; 27846083293cSBarry Smith Vec initialsolution; 27856083293cSBarry Smith PetscBool showinitial; 278683a4ac43SBarry Smith PetscInt howoften; /* when > 0 uses step % howoften, when negative only final solution plotted */ 278783a4ac43SBarry Smith }; 27886083293cSBarry Smith 27892eca1d9cSJed Brown #undef __FUNCT__ 279083a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution" 27911713a123SBarry Smith /*@C 279283a4ac43SBarry Smith TSMonitorDrawSolution - Monitors progress of the TS solvers by calling 27931713a123SBarry Smith VecView() for the solution at each timestep 27941713a123SBarry Smith 27951713a123SBarry Smith Collective on TS 27961713a123SBarry Smith 27971713a123SBarry Smith Input Parameters: 27981713a123SBarry Smith + ts - the TS context 27991713a123SBarry Smith . step - current time-step 2800142b95e3SSatish Balay . ptime - current time 28011713a123SBarry Smith - dummy - either a viewer or PETSC_NULL 28021713a123SBarry Smith 280399fdda47SBarry Smith Options Database: 280499fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 280599fdda47SBarry Smith 280699fdda47SBarry 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 280799fdda47SBarry Smith will look bad 280899fdda47SBarry Smith 28091713a123SBarry Smith Level: intermediate 28101713a123SBarry Smith 28111713a123SBarry Smith .keywords: TS, vector, monitor, view 28121713a123SBarry Smith 2813a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 28141713a123SBarry Smith @*/ 28150910c330SBarry Smith PetscErrorCode TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 28161713a123SBarry Smith { 2817dfbe8321SBarry Smith PetscErrorCode ierr; 281883a4ac43SBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 28191713a123SBarry Smith 28201713a123SBarry Smith PetscFunctionBegin; 28216083293cSBarry Smith if (!step && ictx->showinitial) { 28226083293cSBarry Smith if (!ictx->initialsolution) { 28230910c330SBarry Smith ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr); 28241713a123SBarry Smith } 28250910c330SBarry Smith ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr); 28266083293cSBarry Smith } 28273fbbecb0SBarry Smith if (!(((ictx->howoften > 0) && (!(step % ictx->howoften)) && (step > -1)) || ((ictx->howoften == -1) && (step == -1)))) PetscFunctionReturn(0); 28280dcf80beSBarry Smith 28296083293cSBarry Smith if (ictx->showinitial) { 28306083293cSBarry Smith PetscReal pause; 28316083293cSBarry Smith ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr); 28326083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr); 28336083293cSBarry Smith ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr); 28346083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr); 28356083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr); 28366083293cSBarry Smith } 28370910c330SBarry Smith ierr = VecView(u,ictx->viewer);CHKERRQ(ierr); 28386083293cSBarry Smith if (ictx->showinitial) { 28396083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr); 28406083293cSBarry Smith } 28411713a123SBarry Smith PetscFunctionReturn(0); 28421713a123SBarry Smith } 28431713a123SBarry Smith 28441713a123SBarry Smith 28456c699258SBarry Smith #undef __FUNCT__ 284683a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy" 28476083293cSBarry Smith /*@C 284883a4ac43SBarry Smith TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution() 28496083293cSBarry Smith 28506083293cSBarry Smith Collective on TS 28516083293cSBarry Smith 28526083293cSBarry Smith Input Parameters: 28536083293cSBarry Smith . ctx - the monitor context 28546083293cSBarry Smith 28556083293cSBarry Smith Level: intermediate 28566083293cSBarry Smith 28576083293cSBarry Smith .keywords: TS, vector, monitor, view 28586083293cSBarry Smith 285983a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError() 28606083293cSBarry Smith @*/ 286183a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx) 28626083293cSBarry Smith { 28636083293cSBarry Smith PetscErrorCode ierr; 28646083293cSBarry Smith 28656083293cSBarry Smith PetscFunctionBegin; 286683a4ac43SBarry Smith ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr); 286783a4ac43SBarry Smith ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr); 286883a4ac43SBarry Smith ierr = PetscFree(*ictx);CHKERRQ(ierr); 28696083293cSBarry Smith PetscFunctionReturn(0); 28706083293cSBarry Smith } 28716083293cSBarry Smith 28726083293cSBarry Smith #undef __FUNCT__ 287383a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate" 28746083293cSBarry Smith /*@C 287583a4ac43SBarry Smith TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx 28766083293cSBarry Smith 28776083293cSBarry Smith Collective on TS 28786083293cSBarry Smith 28796083293cSBarry Smith Input Parameter: 28806083293cSBarry Smith . ts - time-step context 28816083293cSBarry Smith 28826083293cSBarry Smith Output Patameter: 28836083293cSBarry Smith . ctx - the monitor context 28846083293cSBarry Smith 288599fdda47SBarry Smith Options Database: 288699fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 288799fdda47SBarry Smith 28886083293cSBarry Smith Level: intermediate 28896083293cSBarry Smith 28906083293cSBarry Smith .keywords: TS, vector, monitor, view 28916083293cSBarry Smith 289283a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx() 28936083293cSBarry Smith @*/ 289483a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx) 28956083293cSBarry Smith { 28966083293cSBarry Smith PetscErrorCode ierr; 28976083293cSBarry Smith 28986083293cSBarry Smith PetscFunctionBegin; 289983a4ac43SBarry Smith ierr = PetscNew(struct _n_TSMonitorDrawCtx,ctx);CHKERRQ(ierr); 290083a4ac43SBarry Smith ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr); 290183a4ac43SBarry Smith (*ctx)->showinitial = PETSC_FALSE; 290283a4ac43SBarry Smith (*ctx)->howoften = howoften; 290399fdda47SBarry Smith ierr = PetscOptionsGetBool(PETSC_NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,PETSC_NULL);CHKERRQ(ierr); 29046083293cSBarry Smith PetscFunctionReturn(0); 29056083293cSBarry Smith } 29066083293cSBarry Smith 29076083293cSBarry Smith #undef __FUNCT__ 290883a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError" 29093a471f94SBarry Smith /*@C 291083a4ac43SBarry Smith TSMonitorDrawError - Monitors progress of the TS solvers by calling 29113a471f94SBarry Smith VecView() for the error at each timestep 29123a471f94SBarry Smith 29133a471f94SBarry Smith Collective on TS 29143a471f94SBarry Smith 29153a471f94SBarry Smith Input Parameters: 29163a471f94SBarry Smith + ts - the TS context 29173a471f94SBarry Smith . step - current time-step 29183a471f94SBarry Smith . ptime - current time 29193a471f94SBarry Smith - dummy - either a viewer or PETSC_NULL 29203a471f94SBarry Smith 29213a471f94SBarry Smith Level: intermediate 29223a471f94SBarry Smith 29233a471f94SBarry Smith .keywords: TS, vector, monitor, view 29243a471f94SBarry Smith 29253a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 29263a471f94SBarry Smith @*/ 29270910c330SBarry Smith PetscErrorCode TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 29283a471f94SBarry Smith { 29293a471f94SBarry Smith PetscErrorCode ierr; 293083a4ac43SBarry Smith TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy; 293183a4ac43SBarry Smith PetscViewer viewer = ctx->viewer; 29323a471f94SBarry Smith Vec work; 29333a471f94SBarry Smith 29343a471f94SBarry Smith PetscFunctionBegin; 29353fbbecb0SBarry Smith if (!(((ctx->howoften > 0) && (!(step % ctx->howoften)) && (step > -1)) || ((ctx->howoften == -1) && (step == -1)))) PetscFunctionReturn(0); 29360910c330SBarry Smith ierr = VecDuplicate(u,&work);CHKERRQ(ierr); 29373a471f94SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr); 29380910c330SBarry Smith ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr); 29393a471f94SBarry Smith ierr = VecView(work,viewer);CHKERRQ(ierr); 29403a471f94SBarry Smith ierr = VecDestroy(&work);CHKERRQ(ierr); 29413a471f94SBarry Smith PetscFunctionReturn(0); 29423a471f94SBarry Smith } 29433a471f94SBarry Smith 29442a34c10cSBarry Smith #include <petsc-private/dmimpl.h> 29453a471f94SBarry Smith #undef __FUNCT__ 29466c699258SBarry Smith #define __FUNCT__ "TSSetDM" 29476c699258SBarry Smith /*@ 29486c699258SBarry Smith TSSetDM - Sets the DM that may be used by some preconditioners 29496c699258SBarry Smith 29503f9fe445SBarry Smith Logically Collective on TS and DM 29516c699258SBarry Smith 29526c699258SBarry Smith Input Parameters: 29536c699258SBarry Smith + ts - the preconditioner context 29546c699258SBarry Smith - dm - the dm 29556c699258SBarry Smith 29566c699258SBarry Smith Level: intermediate 29576c699258SBarry Smith 29586c699258SBarry Smith 29596c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM() 29606c699258SBarry Smith @*/ 29617087cfbeSBarry Smith PetscErrorCode TSSetDM(TS ts,DM dm) 29626c699258SBarry Smith { 29636c699258SBarry Smith PetscErrorCode ierr; 2964089b2837SJed Brown SNES snes; 2965942e3340SBarry Smith DMTS tsdm; 29666c699258SBarry Smith 29676c699258SBarry Smith PetscFunctionBegin; 29680700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 296970663e4aSLisandro Dalcin ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr); 2970942e3340SBarry Smith if (ts->dm) { /* Move the DMTS context over to the new DM unless the new DM already has one */ 29712a34c10cSBarry Smith if (ts->dm->dmts && !dm->dmts) { 2972942e3340SBarry Smith ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr); 2973942e3340SBarry Smith ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr); 297424989b8cSPeter Brune if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */ 297524989b8cSPeter Brune tsdm->originaldm = dm; 297624989b8cSPeter Brune } 297724989b8cSPeter Brune } 29786bf464f9SBarry Smith ierr = DMDestroy(&ts->dm);CHKERRQ(ierr); 297924989b8cSPeter Brune } 29806c699258SBarry Smith ts->dm = dm; 2981089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2982089b2837SJed Brown ierr = SNESSetDM(snes,dm);CHKERRQ(ierr); 29836c699258SBarry Smith PetscFunctionReturn(0); 29846c699258SBarry Smith } 29856c699258SBarry Smith 29866c699258SBarry Smith #undef __FUNCT__ 29876c699258SBarry Smith #define __FUNCT__ "TSGetDM" 29886c699258SBarry Smith /*@ 29896c699258SBarry Smith TSGetDM - Gets the DM that may be used by some preconditioners 29906c699258SBarry Smith 29913f9fe445SBarry Smith Not Collective 29926c699258SBarry Smith 29936c699258SBarry Smith Input Parameter: 29946c699258SBarry Smith . ts - the preconditioner context 29956c699258SBarry Smith 29966c699258SBarry Smith Output Parameter: 29976c699258SBarry Smith . dm - the dm 29986c699258SBarry Smith 29996c699258SBarry Smith Level: intermediate 30006c699258SBarry Smith 30016c699258SBarry Smith 30026c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM() 30036c699258SBarry Smith @*/ 30047087cfbeSBarry Smith PetscErrorCode TSGetDM(TS ts,DM *dm) 30056c699258SBarry Smith { 3006496e6a7aSJed Brown PetscErrorCode ierr; 3007496e6a7aSJed Brown 30086c699258SBarry Smith PetscFunctionBegin; 30090700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3010496e6a7aSJed Brown if (!ts->dm) { 3011496e6a7aSJed Brown ierr = DMShellCreate(((PetscObject)ts)->comm,&ts->dm);CHKERRQ(ierr); 3012496e6a7aSJed Brown if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 3013496e6a7aSJed Brown } 30146c699258SBarry Smith *dm = ts->dm; 30156c699258SBarry Smith PetscFunctionReturn(0); 30166c699258SBarry Smith } 30171713a123SBarry Smith 30180f5c6efeSJed Brown #undef __FUNCT__ 30190f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction" 30200f5c6efeSJed Brown /*@ 30210f5c6efeSJed Brown SNESTSFormFunction - Function to evaluate nonlinear residual 30220f5c6efeSJed Brown 30233f9fe445SBarry Smith Logically Collective on SNES 30240f5c6efeSJed Brown 30250f5c6efeSJed Brown Input Parameter: 3026d42a1c89SJed Brown + snes - nonlinear solver 30270910c330SBarry Smith . U - the current state at which to evaluate the residual 3028d42a1c89SJed Brown - ctx - user context, must be a TS 30290f5c6efeSJed Brown 30300f5c6efeSJed Brown Output Parameter: 30310f5c6efeSJed Brown . F - the nonlinear residual 30320f5c6efeSJed Brown 30330f5c6efeSJed Brown Notes: 30340f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 30350f5c6efeSJed Brown It is most frequently passed to MatFDColoringSetFunction(). 30360f5c6efeSJed Brown 30370f5c6efeSJed Brown Level: advanced 30380f5c6efeSJed Brown 30390f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction() 30400f5c6efeSJed Brown @*/ 30410910c330SBarry Smith PetscErrorCode SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx) 30420f5c6efeSJed Brown { 30430f5c6efeSJed Brown TS ts = (TS)ctx; 30440f5c6efeSJed Brown PetscErrorCode ierr; 30450f5c6efeSJed Brown 30460f5c6efeSJed Brown PetscFunctionBegin; 30470f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 30480910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 30490f5c6efeSJed Brown PetscValidHeaderSpecific(F,VEC_CLASSID,3); 30500f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,4); 30510910c330SBarry Smith ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr); 30520f5c6efeSJed Brown PetscFunctionReturn(0); 30530f5c6efeSJed Brown } 30540f5c6efeSJed Brown 30550f5c6efeSJed Brown #undef __FUNCT__ 30560f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian" 30570f5c6efeSJed Brown /*@ 30580f5c6efeSJed Brown SNESTSFormJacobian - Function to evaluate the Jacobian 30590f5c6efeSJed Brown 30600f5c6efeSJed Brown Collective on SNES 30610f5c6efeSJed Brown 30620f5c6efeSJed Brown Input Parameter: 30630f5c6efeSJed Brown + snes - nonlinear solver 30640910c330SBarry Smith . U - the current state at which to evaluate the residual 30650f5c6efeSJed Brown - ctx - user context, must be a TS 30660f5c6efeSJed Brown 30670f5c6efeSJed Brown Output Parameter: 30680f5c6efeSJed Brown + A - the Jacobian 30690f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A) 30700f5c6efeSJed Brown - flag - indicates any structure change in the matrix 30710f5c6efeSJed Brown 30720f5c6efeSJed Brown Notes: 30730f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 30740f5c6efeSJed Brown 30750f5c6efeSJed Brown Level: developer 30760f5c6efeSJed Brown 30770f5c6efeSJed Brown .seealso: SNESSetJacobian() 30780f5c6efeSJed Brown @*/ 30790910c330SBarry Smith PetscErrorCode SNESTSFormJacobian(SNES snes,Vec U,Mat *A,Mat *B,MatStructure *flag,void *ctx) 30800f5c6efeSJed Brown { 30810f5c6efeSJed Brown TS ts = (TS)ctx; 30820f5c6efeSJed Brown PetscErrorCode ierr; 30830f5c6efeSJed Brown 30840f5c6efeSJed Brown PetscFunctionBegin; 30850f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 30860910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 30870f5c6efeSJed Brown PetscValidPointer(A,3); 30880f5c6efeSJed Brown PetscValidHeaderSpecific(*A,MAT_CLASSID,3); 30890f5c6efeSJed Brown PetscValidPointer(B,4); 30900f5c6efeSJed Brown PetscValidHeaderSpecific(*B,MAT_CLASSID,4); 30910f5c6efeSJed Brown PetscValidPointer(flag,5); 30920f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,6); 30930910c330SBarry Smith ierr = (ts->ops->snesjacobian)(snes,U,A,B,flag,ts);CHKERRQ(ierr); 30940f5c6efeSJed Brown PetscFunctionReturn(0); 30950f5c6efeSJed Brown } 3096325fc9f4SBarry Smith 30970e4ef248SJed Brown #undef __FUNCT__ 30980e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear" 30990e4ef248SJed Brown /*@C 31000e4ef248SJed Brown TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only 31010e4ef248SJed Brown 31020e4ef248SJed Brown Collective on TS 31030e4ef248SJed Brown 31040e4ef248SJed Brown Input Arguments: 31050e4ef248SJed Brown + ts - time stepping context 31060e4ef248SJed Brown . t - time at which to evaluate 31070910c330SBarry Smith . U - state at which to evaluate 31080e4ef248SJed Brown - ctx - context 31090e4ef248SJed Brown 31100e4ef248SJed Brown Output Arguments: 31110e4ef248SJed Brown . F - right hand side 31120e4ef248SJed Brown 31130e4ef248SJed Brown Level: intermediate 31140e4ef248SJed Brown 31150e4ef248SJed Brown Notes: 31160e4ef248SJed Brown This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems. 31170e4ef248SJed Brown The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian(). 31180e4ef248SJed Brown 31190e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 31200e4ef248SJed Brown @*/ 31210910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx) 31220e4ef248SJed Brown { 31230e4ef248SJed Brown PetscErrorCode ierr; 31240e4ef248SJed Brown Mat Arhs,Brhs; 31250e4ef248SJed Brown MatStructure flg2; 31260e4ef248SJed Brown 31270e4ef248SJed Brown PetscFunctionBegin; 31280e4ef248SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 31290910c330SBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,&Arhs,&Brhs,&flg2);CHKERRQ(ierr); 31300910c330SBarry Smith ierr = MatMult(Arhs,U,F);CHKERRQ(ierr); 31310e4ef248SJed Brown PetscFunctionReturn(0); 31320e4ef248SJed Brown } 31330e4ef248SJed Brown 31340e4ef248SJed Brown #undef __FUNCT__ 31350e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant" 31360e4ef248SJed Brown /*@C 31370e4ef248SJed Brown TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 31380e4ef248SJed Brown 31390e4ef248SJed Brown Collective on TS 31400e4ef248SJed Brown 31410e4ef248SJed Brown Input Arguments: 31420e4ef248SJed Brown + ts - time stepping context 31430e4ef248SJed Brown . t - time at which to evaluate 31440910c330SBarry Smith . U - state at which to evaluate 31450e4ef248SJed Brown - ctx - context 31460e4ef248SJed Brown 31470e4ef248SJed Brown Output Arguments: 31480e4ef248SJed Brown + A - pointer to operator 31490e4ef248SJed Brown . B - pointer to preconditioning matrix 31500e4ef248SJed Brown - flg - matrix structure flag 31510e4ef248SJed Brown 31520e4ef248SJed Brown Level: intermediate 31530e4ef248SJed Brown 31540e4ef248SJed Brown Notes: 31550e4ef248SJed Brown This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems. 31560e4ef248SJed Brown 31570e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear() 31580e4ef248SJed Brown @*/ 31590910c330SBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat *A,Mat *B,MatStructure *flg,void *ctx) 31600e4ef248SJed Brown { 31610e4ef248SJed Brown PetscFunctionBegin; 31620e4ef248SJed Brown *flg = SAME_PRECONDITIONER; 31630e4ef248SJed Brown PetscFunctionReturn(0); 31640e4ef248SJed Brown } 31650e4ef248SJed Brown 31660026cea9SSean Farley #undef __FUNCT__ 31670026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear" 31680026cea9SSean Farley /*@C 31690026cea9SSean Farley TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 31700026cea9SSean Farley 31710026cea9SSean Farley Collective on TS 31720026cea9SSean Farley 31730026cea9SSean Farley Input Arguments: 31740026cea9SSean Farley + ts - time stepping context 31750026cea9SSean Farley . t - time at which to evaluate 31760910c330SBarry Smith . U - state at which to evaluate 31770910c330SBarry Smith . Udot - time derivative of state vector 31780026cea9SSean Farley - ctx - context 31790026cea9SSean Farley 31800026cea9SSean Farley Output Arguments: 31810026cea9SSean Farley . F - left hand side 31820026cea9SSean Farley 31830026cea9SSean Farley Level: intermediate 31840026cea9SSean Farley 31850026cea9SSean Farley Notes: 31860910c330SBarry 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 31870026cea9SSean Farley user is required to write their own TSComputeIFunction. 31880026cea9SSean Farley This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems. 31890026cea9SSean Farley The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian(). 31900026cea9SSean Farley 31910026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant() 31920026cea9SSean Farley @*/ 31930910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx) 31940026cea9SSean Farley { 31950026cea9SSean Farley PetscErrorCode ierr; 31960026cea9SSean Farley Mat A,B; 31970026cea9SSean Farley MatStructure flg2; 31980026cea9SSean Farley 31990026cea9SSean Farley PetscFunctionBegin; 32000026cea9SSean Farley ierr = TSGetIJacobian(ts,&A,&B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 32010910c330SBarry Smith ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,&A,&B,&flg2,PETSC_TRUE);CHKERRQ(ierr); 32020910c330SBarry Smith ierr = MatMult(A,Udot,F);CHKERRQ(ierr); 32030026cea9SSean Farley PetscFunctionReturn(0); 32040026cea9SSean Farley } 32050026cea9SSean Farley 32060026cea9SSean Farley #undef __FUNCT__ 32070026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant" 32080026cea9SSean Farley /*@C 320924e94211SJed Brown TSComputeIJacobianConstant - Reuses a Jacobian that is time-independent. 32100026cea9SSean Farley 32110026cea9SSean Farley Collective on TS 32120026cea9SSean Farley 32130026cea9SSean Farley Input Arguments: 32140026cea9SSean Farley + ts - time stepping context 32150026cea9SSean Farley . t - time at which to evaluate 32160910c330SBarry Smith . U - state at which to evaluate 32170910c330SBarry Smith . Udot - time derivative of state vector 32180026cea9SSean Farley . shift - shift to apply 32190026cea9SSean Farley - ctx - context 32200026cea9SSean Farley 32210026cea9SSean Farley Output Arguments: 32220026cea9SSean Farley + A - pointer to operator 32230026cea9SSean Farley . B - pointer to preconditioning matrix 32240026cea9SSean Farley - flg - matrix structure flag 32250026cea9SSean Farley 32260026cea9SSean Farley Level: intermediate 32270026cea9SSean Farley 32280026cea9SSean Farley Notes: 32290026cea9SSean Farley This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems. 32300026cea9SSean Farley 32310026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear() 32320026cea9SSean Farley @*/ 32330910c330SBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat *A,Mat *B,MatStructure *flg,void *ctx) 32340026cea9SSean Farley { 32350026cea9SSean Farley PetscFunctionBegin; 32360026cea9SSean Farley *flg = SAME_PRECONDITIONER; 32370026cea9SSean Farley PetscFunctionReturn(0); 32380026cea9SSean Farley } 32390026cea9SSean Farley 32404af1b03aSJed Brown #undef __FUNCT__ 32414af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason" 32424af1b03aSJed Brown /*@ 32434af1b03aSJed Brown TSGetConvergedReason - Gets the reason the TS iteration was stopped. 32444af1b03aSJed Brown 32454af1b03aSJed Brown Not Collective 32464af1b03aSJed Brown 32474af1b03aSJed Brown Input Parameter: 32484af1b03aSJed Brown . ts - the TS context 32494af1b03aSJed Brown 32504af1b03aSJed Brown Output Parameter: 32514af1b03aSJed Brown . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 32524af1b03aSJed Brown manual pages for the individual convergence tests for complete lists 32534af1b03aSJed Brown 3254487e0bb9SJed Brown Level: beginner 32554af1b03aSJed Brown 3256cd652676SJed Brown Notes: 3257cd652676SJed Brown Can only be called after the call to TSSolve() is complete. 32584af1b03aSJed Brown 32594af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test 32604af1b03aSJed Brown 32614af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason 32624af1b03aSJed Brown @*/ 32634af1b03aSJed Brown PetscErrorCode TSGetConvergedReason(TS ts,TSConvergedReason *reason) 32644af1b03aSJed Brown { 32654af1b03aSJed Brown PetscFunctionBegin; 32664af1b03aSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 32674af1b03aSJed Brown PetscValidPointer(reason,2); 32684af1b03aSJed Brown *reason = ts->reason; 32694af1b03aSJed Brown PetscFunctionReturn(0); 32704af1b03aSJed Brown } 32714af1b03aSJed Brown 3272fb1732b5SBarry Smith #undef __FUNCT__ 3273cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime" 3274cc708dedSBarry Smith /*@ 3275cc708dedSBarry Smith TSGetSolveTime - Gets the time after a call to TSSolve() 3276cc708dedSBarry Smith 3277cc708dedSBarry Smith Not Collective 3278cc708dedSBarry Smith 3279cc708dedSBarry Smith Input Parameter: 3280cc708dedSBarry Smith . ts - the TS context 3281cc708dedSBarry Smith 3282cc708dedSBarry Smith Output Parameter: 3283cc708dedSBarry Smith . ftime - the final time. This time should correspond to the final time set with TSSetDuration() 3284cc708dedSBarry Smith 3285487e0bb9SJed Brown Level: beginner 3286cc708dedSBarry Smith 3287cc708dedSBarry Smith Notes: 3288cc708dedSBarry Smith Can only be called after the call to TSSolve() is complete. 3289cc708dedSBarry Smith 3290cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test 3291cc708dedSBarry Smith 3292cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason 3293cc708dedSBarry Smith @*/ 3294cc708dedSBarry Smith PetscErrorCode TSGetSolveTime(TS ts,PetscReal *ftime) 3295cc708dedSBarry Smith { 3296cc708dedSBarry Smith PetscFunctionBegin; 3297cc708dedSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3298cc708dedSBarry Smith PetscValidPointer(ftime,2); 3299cc708dedSBarry Smith *ftime = ts->solvetime; 3300cc708dedSBarry Smith PetscFunctionReturn(0); 3301cc708dedSBarry Smith } 3302cc708dedSBarry Smith 3303cc708dedSBarry Smith #undef __FUNCT__ 33045ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations" 33059f67acb7SJed Brown /*@ 33065ef26d82SJed Brown TSGetSNESIterations - Gets the total number of nonlinear iterations 33079f67acb7SJed Brown used by the time integrator. 33089f67acb7SJed Brown 33099f67acb7SJed Brown Not Collective 33109f67acb7SJed Brown 33119f67acb7SJed Brown Input Parameter: 33129f67acb7SJed Brown . ts - TS context 33139f67acb7SJed Brown 33149f67acb7SJed Brown Output Parameter: 33159f67acb7SJed Brown . nits - number of nonlinear iterations 33169f67acb7SJed Brown 33179f67acb7SJed Brown Notes: 33189f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 33199f67acb7SJed Brown 33209f67acb7SJed Brown Level: intermediate 33219f67acb7SJed Brown 33229f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations 33239f67acb7SJed Brown 33245ef26d82SJed Brown .seealso: TSGetKSPIterations() 33259f67acb7SJed Brown @*/ 33265ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits) 33279f67acb7SJed Brown { 33289f67acb7SJed Brown PetscFunctionBegin; 33299f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 33309f67acb7SJed Brown PetscValidIntPointer(nits,2); 33315ef26d82SJed Brown *nits = ts->snes_its; 33329f67acb7SJed Brown PetscFunctionReturn(0); 33339f67acb7SJed Brown } 33349f67acb7SJed Brown 33359f67acb7SJed Brown #undef __FUNCT__ 33365ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations" 33379f67acb7SJed Brown /*@ 33385ef26d82SJed Brown TSGetKSPIterations - Gets the total number of linear iterations 33399f67acb7SJed Brown used by the time integrator. 33409f67acb7SJed Brown 33419f67acb7SJed Brown Not Collective 33429f67acb7SJed Brown 33439f67acb7SJed Brown Input Parameter: 33449f67acb7SJed Brown . ts - TS context 33459f67acb7SJed Brown 33469f67acb7SJed Brown Output Parameter: 33479f67acb7SJed Brown . lits - number of linear iterations 33489f67acb7SJed Brown 33499f67acb7SJed Brown Notes: 33509f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 33519f67acb7SJed Brown 33529f67acb7SJed Brown Level: intermediate 33539f67acb7SJed Brown 33549f67acb7SJed Brown .keywords: TS, get, number, linear, iterations 33559f67acb7SJed Brown 33565ef26d82SJed Brown .seealso: TSGetSNESIterations(), SNESGetKSPIterations() 33579f67acb7SJed Brown @*/ 33585ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits) 33599f67acb7SJed Brown { 33609f67acb7SJed Brown PetscFunctionBegin; 33619f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 33629f67acb7SJed Brown PetscValidIntPointer(lits,2); 33635ef26d82SJed Brown *lits = ts->ksp_its; 33649f67acb7SJed Brown PetscFunctionReturn(0); 33659f67acb7SJed Brown } 33669f67acb7SJed Brown 33679f67acb7SJed Brown #undef __FUNCT__ 3368cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections" 3369cef5090cSJed Brown /*@ 3370cef5090cSJed Brown TSGetStepRejections - Gets the total number of rejected steps. 3371cef5090cSJed Brown 3372cef5090cSJed Brown Not Collective 3373cef5090cSJed Brown 3374cef5090cSJed Brown Input Parameter: 3375cef5090cSJed Brown . ts - TS context 3376cef5090cSJed Brown 3377cef5090cSJed Brown Output Parameter: 3378cef5090cSJed Brown . rejects - number of steps rejected 3379cef5090cSJed Brown 3380cef5090cSJed Brown Notes: 3381cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 3382cef5090cSJed Brown 3383cef5090cSJed Brown Level: intermediate 3384cef5090cSJed Brown 3385cef5090cSJed Brown .keywords: TS, get, number 3386cef5090cSJed Brown 33875ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails() 3388cef5090cSJed Brown @*/ 3389cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects) 3390cef5090cSJed Brown { 3391cef5090cSJed Brown PetscFunctionBegin; 3392cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3393cef5090cSJed Brown PetscValidIntPointer(rejects,2); 3394cef5090cSJed Brown *rejects = ts->reject; 3395cef5090cSJed Brown PetscFunctionReturn(0); 3396cef5090cSJed Brown } 3397cef5090cSJed Brown 3398cef5090cSJed Brown #undef __FUNCT__ 3399cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures" 3400cef5090cSJed Brown /*@ 3401cef5090cSJed Brown TSGetSNESFailures - Gets the total number of failed SNES solves 3402cef5090cSJed Brown 3403cef5090cSJed Brown Not Collective 3404cef5090cSJed Brown 3405cef5090cSJed Brown Input Parameter: 3406cef5090cSJed Brown . ts - TS context 3407cef5090cSJed Brown 3408cef5090cSJed Brown Output Parameter: 3409cef5090cSJed Brown . fails - number of failed nonlinear solves 3410cef5090cSJed Brown 3411cef5090cSJed Brown Notes: 3412cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 3413cef5090cSJed Brown 3414cef5090cSJed Brown Level: intermediate 3415cef5090cSJed Brown 3416cef5090cSJed Brown .keywords: TS, get, number 3417cef5090cSJed Brown 34185ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures() 3419cef5090cSJed Brown @*/ 3420cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails) 3421cef5090cSJed Brown { 3422cef5090cSJed Brown PetscFunctionBegin; 3423cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3424cef5090cSJed Brown PetscValidIntPointer(fails,2); 3425cef5090cSJed Brown *fails = ts->num_snes_failures; 3426cef5090cSJed Brown PetscFunctionReturn(0); 3427cef5090cSJed Brown } 3428cef5090cSJed Brown 3429cef5090cSJed Brown #undef __FUNCT__ 3430cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections" 3431cef5090cSJed Brown /*@ 3432cef5090cSJed Brown TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails 3433cef5090cSJed Brown 3434cef5090cSJed Brown Not Collective 3435cef5090cSJed Brown 3436cef5090cSJed Brown Input Parameter: 3437cef5090cSJed Brown + ts - TS context 3438cef5090cSJed Brown - rejects - maximum number of rejected steps, pass -1 for unlimited 3439cef5090cSJed Brown 3440cef5090cSJed Brown Notes: 3441cef5090cSJed Brown The counter is reset to zero for each step 3442cef5090cSJed Brown 3443cef5090cSJed Brown Options Database Key: 3444cef5090cSJed Brown . -ts_max_reject - Maximum number of step rejections before a step fails 3445cef5090cSJed Brown 3446cef5090cSJed Brown Level: intermediate 3447cef5090cSJed Brown 3448cef5090cSJed Brown .keywords: TS, set, maximum, number 3449cef5090cSJed Brown 34505ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 3451cef5090cSJed Brown @*/ 3452cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects) 3453cef5090cSJed Brown { 3454cef5090cSJed Brown PetscFunctionBegin; 3455cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3456cef5090cSJed Brown ts->max_reject = rejects; 3457cef5090cSJed Brown PetscFunctionReturn(0); 3458cef5090cSJed Brown } 3459cef5090cSJed Brown 3460cef5090cSJed Brown #undef __FUNCT__ 3461cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures" 3462cef5090cSJed Brown /*@ 3463cef5090cSJed Brown TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves 3464cef5090cSJed Brown 3465cef5090cSJed Brown Not Collective 3466cef5090cSJed Brown 3467cef5090cSJed Brown Input Parameter: 3468cef5090cSJed Brown + ts - TS context 3469cef5090cSJed Brown - fails - maximum number of failed nonlinear solves, pass -1 for unlimited 3470cef5090cSJed Brown 3471cef5090cSJed Brown Notes: 3472cef5090cSJed Brown The counter is reset to zero for each successive call to TSSolve(). 3473cef5090cSJed Brown 3474cef5090cSJed Brown Options Database Key: 3475cef5090cSJed Brown . -ts_max_snes_failures - Maximum number of nonlinear solve failures 3476cef5090cSJed Brown 3477cef5090cSJed Brown Level: intermediate 3478cef5090cSJed Brown 3479cef5090cSJed Brown .keywords: TS, set, maximum, number 3480cef5090cSJed Brown 34815ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason() 3482cef5090cSJed Brown @*/ 3483cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails) 3484cef5090cSJed Brown { 3485cef5090cSJed Brown PetscFunctionBegin; 3486cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3487cef5090cSJed Brown ts->max_snes_failures = fails; 3488cef5090cSJed Brown PetscFunctionReturn(0); 3489cef5090cSJed Brown } 3490cef5090cSJed Brown 3491cef5090cSJed Brown #undef __FUNCT__ 3492cef5090cSJed Brown #define __FUNCT__ "TSSetErrorIfStepFails()" 3493cef5090cSJed Brown /*@ 3494cef5090cSJed Brown TSSetErrorIfStepFails - Error if no step succeeds 3495cef5090cSJed Brown 3496cef5090cSJed Brown Not Collective 3497cef5090cSJed Brown 3498cef5090cSJed Brown Input Parameter: 3499cef5090cSJed Brown + ts - TS context 3500cef5090cSJed Brown - err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure 3501cef5090cSJed Brown 3502cef5090cSJed Brown Options Database Key: 3503cef5090cSJed Brown . -ts_error_if_step_fails - Error if no step succeeds 3504cef5090cSJed Brown 3505cef5090cSJed Brown Level: intermediate 3506cef5090cSJed Brown 3507cef5090cSJed Brown .keywords: TS, set, error 3508cef5090cSJed Brown 35095ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 3510cef5090cSJed Brown @*/ 3511cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err) 3512cef5090cSJed Brown { 3513cef5090cSJed Brown PetscFunctionBegin; 3514cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3515cef5090cSJed Brown ts->errorifstepfailed = err; 3516cef5090cSJed Brown PetscFunctionReturn(0); 3517cef5090cSJed Brown } 3518cef5090cSJed Brown 3519cef5090cSJed Brown #undef __FUNCT__ 3520fb1732b5SBarry Smith #define __FUNCT__ "TSMonitorSolutionBinary" 3521fb1732b5SBarry Smith /*@C 3522fb1732b5SBarry Smith TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file 3523fb1732b5SBarry Smith 3524fb1732b5SBarry Smith Collective on TS 3525fb1732b5SBarry Smith 3526fb1732b5SBarry Smith Input Parameters: 3527fb1732b5SBarry Smith + ts - the TS context 3528fb1732b5SBarry Smith . step - current time-step 3529fb1732b5SBarry Smith . ptime - current time 35300910c330SBarry Smith . u - current state 3531fb1732b5SBarry Smith - viewer - binary viewer 3532fb1732b5SBarry Smith 3533fb1732b5SBarry Smith Level: intermediate 3534fb1732b5SBarry Smith 3535fb1732b5SBarry Smith .keywords: TS, vector, monitor, view 3536fb1732b5SBarry Smith 3537fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 3538fb1732b5SBarry Smith @*/ 35390910c330SBarry Smith PetscErrorCode TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec u,void *viewer) 3540fb1732b5SBarry Smith { 3541fb1732b5SBarry Smith PetscErrorCode ierr; 3542ed81e22dSJed Brown PetscViewer v = (PetscViewer)viewer; 3543fb1732b5SBarry Smith 3544fb1732b5SBarry Smith PetscFunctionBegin; 35450910c330SBarry Smith ierr = VecView(u,v);CHKERRQ(ierr); 3546ed81e22dSJed Brown PetscFunctionReturn(0); 3547ed81e22dSJed Brown } 3548ed81e22dSJed Brown 3549ed81e22dSJed Brown #undef __FUNCT__ 3550ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK" 3551ed81e22dSJed Brown /*@C 3552ed81e22dSJed Brown TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep. 3553ed81e22dSJed Brown 3554ed81e22dSJed Brown Collective on TS 3555ed81e22dSJed Brown 3556ed81e22dSJed Brown Input Parameters: 3557ed81e22dSJed Brown + ts - the TS context 3558ed81e22dSJed Brown . step - current time-step 3559ed81e22dSJed Brown . ptime - current time 35600910c330SBarry Smith . u - current state 3561ed81e22dSJed Brown - filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 3562ed81e22dSJed Brown 3563ed81e22dSJed Brown Level: intermediate 3564ed81e22dSJed Brown 3565ed81e22dSJed Brown Notes: 3566ed81e22dSJed 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. 3567ed81e22dSJed Brown These are named according to the file name template. 3568ed81e22dSJed Brown 3569ed81e22dSJed Brown This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy(). 3570ed81e22dSJed Brown 3571ed81e22dSJed Brown .keywords: TS, vector, monitor, view 3572ed81e22dSJed Brown 3573ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 3574ed81e22dSJed Brown @*/ 35750910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate) 3576ed81e22dSJed Brown { 3577ed81e22dSJed Brown PetscErrorCode ierr; 3578ed81e22dSJed Brown char filename[PETSC_MAX_PATH_LEN]; 3579ed81e22dSJed Brown PetscViewer viewer; 3580ed81e22dSJed Brown 3581ed81e22dSJed Brown PetscFunctionBegin; 35828caf3d72SBarry Smith ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr); 3583ed81e22dSJed Brown ierr = PetscViewerVTKOpen(((PetscObject)ts)->comm,filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr); 35840910c330SBarry Smith ierr = VecView(u,viewer);CHKERRQ(ierr); 3585ed81e22dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 3586ed81e22dSJed Brown PetscFunctionReturn(0); 3587ed81e22dSJed Brown } 3588ed81e22dSJed Brown 3589ed81e22dSJed Brown #undef __FUNCT__ 3590ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy" 3591ed81e22dSJed Brown /*@C 3592ed81e22dSJed Brown TSMonitorSolutionVTKDestroy - Destroy context for monitoring 3593ed81e22dSJed Brown 3594ed81e22dSJed Brown Collective on TS 3595ed81e22dSJed Brown 3596ed81e22dSJed Brown Input Parameters: 3597ed81e22dSJed Brown . filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 3598ed81e22dSJed Brown 3599ed81e22dSJed Brown Level: intermediate 3600ed81e22dSJed Brown 3601ed81e22dSJed Brown Note: 3602ed81e22dSJed Brown This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK(). 3603ed81e22dSJed Brown 3604ed81e22dSJed Brown .keywords: TS, vector, monitor, view 3605ed81e22dSJed Brown 3606ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK() 3607ed81e22dSJed Brown @*/ 3608ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate) 3609ed81e22dSJed Brown { 3610ed81e22dSJed Brown PetscErrorCode ierr; 3611ed81e22dSJed Brown 3612ed81e22dSJed Brown PetscFunctionBegin; 3613ed81e22dSJed Brown ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr); 3614fb1732b5SBarry Smith PetscFunctionReturn(0); 3615fb1732b5SBarry Smith } 3616fb1732b5SBarry Smith 361784df9cb4SJed Brown #undef __FUNCT__ 361884df9cb4SJed Brown #define __FUNCT__ "TSGetAdapt" 361984df9cb4SJed Brown /*@ 362084df9cb4SJed Brown TSGetAdapt - Get the adaptive controller context for the current method 362184df9cb4SJed Brown 3622ed81e22dSJed Brown Collective on TS if controller has not been created yet 362384df9cb4SJed Brown 362484df9cb4SJed Brown Input Arguments: 3625ed81e22dSJed Brown . ts - time stepping context 362684df9cb4SJed Brown 362784df9cb4SJed Brown Output Arguments: 3628ed81e22dSJed Brown . adapt - adaptive controller 362984df9cb4SJed Brown 363084df9cb4SJed Brown Level: intermediate 363184df9cb4SJed Brown 3632ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose() 363384df9cb4SJed Brown @*/ 363484df9cb4SJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt) 363584df9cb4SJed Brown { 363684df9cb4SJed Brown PetscErrorCode ierr; 363784df9cb4SJed Brown 363884df9cb4SJed Brown PetscFunctionBegin; 363984df9cb4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 364084df9cb4SJed Brown PetscValidPointer(adapt,2); 364184df9cb4SJed Brown if (!ts->adapt) { 364284df9cb4SJed Brown ierr = TSAdaptCreate(((PetscObject)ts)->comm,&ts->adapt);CHKERRQ(ierr); 36431c3436cfSJed Brown ierr = PetscLogObjectParent(ts,ts->adapt);CHKERRQ(ierr); 36441c3436cfSJed Brown ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr); 364584df9cb4SJed Brown } 364684df9cb4SJed Brown *adapt = ts->adapt; 364784df9cb4SJed Brown PetscFunctionReturn(0); 364884df9cb4SJed Brown } 3649d6ebe24aSShri Abhyankar 3650d6ebe24aSShri Abhyankar #undef __FUNCT__ 36511c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances" 36521c3436cfSJed Brown /*@ 36531c3436cfSJed Brown TSSetTolerances - Set tolerances for local truncation error when using adaptive controller 36541c3436cfSJed Brown 36551c3436cfSJed Brown Logically Collective 36561c3436cfSJed Brown 36571c3436cfSJed Brown Input Arguments: 36581c3436cfSJed Brown + ts - time integration context 36591c3436cfSJed Brown . atol - scalar absolute tolerances, PETSC_DECIDE to leave current value 36601c3436cfSJed Brown . vatol - vector of absolute tolerances or PETSC_NULL, used in preference to atol if present 36611c3436cfSJed Brown . rtol - scalar relative tolerances, PETSC_DECIDE to leave current value 36621c3436cfSJed Brown - vrtol - vector of relative tolerances or PETSC_NULL, used in preference to atol if present 36631c3436cfSJed Brown 36641c3436cfSJed Brown Level: beginner 36651c3436cfSJed Brown 3666c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances() 36671c3436cfSJed Brown @*/ 36681c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol) 36691c3436cfSJed Brown { 36701c3436cfSJed Brown PetscErrorCode ierr; 36711c3436cfSJed Brown 36721c3436cfSJed Brown PetscFunctionBegin; 3673c5033834SJed Brown if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol; 36741c3436cfSJed Brown if (vatol) { 36751c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr); 36761c3436cfSJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 36771c3436cfSJed Brown ts->vatol = vatol; 36781c3436cfSJed Brown } 3679c5033834SJed Brown if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol; 36801c3436cfSJed Brown if (vrtol) { 36811c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr); 36821c3436cfSJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 36831c3436cfSJed Brown ts->vrtol = vrtol; 36841c3436cfSJed Brown } 36851c3436cfSJed Brown PetscFunctionReturn(0); 36861c3436cfSJed Brown } 36871c3436cfSJed Brown 36881c3436cfSJed Brown #undef __FUNCT__ 3689c5033834SJed Brown #define __FUNCT__ "TSGetTolerances" 3690c5033834SJed Brown /*@ 3691c5033834SJed Brown TSGetTolerances - Get tolerances for local truncation error when using adaptive controller 3692c5033834SJed Brown 3693c5033834SJed Brown Logically Collective 3694c5033834SJed Brown 3695c5033834SJed Brown Input Arguments: 3696c5033834SJed Brown . ts - time integration context 3697c5033834SJed Brown 3698c5033834SJed Brown Output Arguments: 3699c5033834SJed Brown + atol - scalar absolute tolerances, PETSC_NULL to ignore 3700c5033834SJed Brown . vatol - vector of absolute tolerances, PETSC_NULL to ignore 3701c5033834SJed Brown . rtol - scalar relative tolerances, PETSC_NULL to ignore 3702c5033834SJed Brown - vrtol - vector of relative tolerances, PETSC_NULL to ignore 3703c5033834SJed Brown 3704c5033834SJed Brown Level: beginner 3705c5033834SJed Brown 3706c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances() 3707c5033834SJed Brown @*/ 3708c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol) 3709c5033834SJed Brown { 3710c5033834SJed Brown PetscFunctionBegin; 3711c5033834SJed Brown if (atol) *atol = ts->atol; 3712c5033834SJed Brown if (vatol) *vatol = ts->vatol; 3713c5033834SJed Brown if (rtol) *rtol = ts->rtol; 3714c5033834SJed Brown if (vrtol) *vrtol = ts->vrtol; 3715c5033834SJed Brown PetscFunctionReturn(0); 3716c5033834SJed Brown } 3717c5033834SJed Brown 3718c5033834SJed Brown #undef __FUNCT__ 37191c3436cfSJed Brown #define __FUNCT__ "TSErrorNormWRMS" 37201c3436cfSJed Brown /*@ 37211c3436cfSJed Brown TSErrorNormWRMS - compute a weighted norm of the difference between a vector and the current state 37221c3436cfSJed Brown 37231c3436cfSJed Brown Collective on TS 37241c3436cfSJed Brown 37251c3436cfSJed Brown Input Arguments: 37261c3436cfSJed Brown + ts - time stepping context 37271c3436cfSJed Brown - Y - state vector to be compared to ts->vec_sol 37281c3436cfSJed Brown 37291c3436cfSJed Brown Output Arguments: 37301c3436cfSJed Brown . norm - weighted norm, a value of 1.0 is considered small 37311c3436cfSJed Brown 37321c3436cfSJed Brown Level: developer 37331c3436cfSJed Brown 37341c3436cfSJed Brown .seealso: TSSetTolerances() 37351c3436cfSJed Brown @*/ 37361c3436cfSJed Brown PetscErrorCode TSErrorNormWRMS(TS ts,Vec Y,PetscReal *norm) 37371c3436cfSJed Brown { 37381c3436cfSJed Brown PetscErrorCode ierr; 37391c3436cfSJed Brown PetscInt i,n,N; 37400910c330SBarry Smith const PetscScalar *u,*y; 37410910c330SBarry Smith Vec U; 37421c3436cfSJed Brown PetscReal sum,gsum; 37431c3436cfSJed Brown 37441c3436cfSJed Brown PetscFunctionBegin; 37451c3436cfSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 37461c3436cfSJed Brown PetscValidHeaderSpecific(Y,VEC_CLASSID,2); 37471c3436cfSJed Brown PetscValidPointer(norm,3); 37480910c330SBarry Smith U = ts->vec_sol; 37490910c330SBarry Smith PetscCheckSameTypeAndComm(U,1,Y,2); 37500910c330SBarry Smith if (U == Y) SETERRQ(((PetscObject)U)->comm,PETSC_ERR_ARG_IDN,"Y cannot be the TS solution vector"); 37511c3436cfSJed Brown 37520910c330SBarry Smith ierr = VecGetSize(U,&N);CHKERRQ(ierr); 37530910c330SBarry Smith ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 37540910c330SBarry Smith ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 37551c3436cfSJed Brown ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 37561c3436cfSJed Brown sum = 0.; 3757ceefc113SJed Brown if (ts->vatol && ts->vrtol) { 3758ceefc113SJed Brown const PetscScalar *atol,*rtol; 3759ceefc113SJed Brown ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 3760ceefc113SJed Brown ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 3761ceefc113SJed Brown for (i=0; i<n; i++) { 37620910c330SBarry Smith PetscReal tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 37630910c330SBarry Smith sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 3764ceefc113SJed Brown } 3765ceefc113SJed Brown ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 3766ceefc113SJed Brown ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 3767ceefc113SJed Brown } else if (ts->vatol) { /* vector atol, scalar rtol */ 3768ceefc113SJed Brown const PetscScalar *atol; 3769ceefc113SJed Brown ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 3770ceefc113SJed Brown for (i=0; i<n; i++) { 37710910c330SBarry Smith PetscReal tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 37720910c330SBarry Smith sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 3773ceefc113SJed Brown } 3774ceefc113SJed Brown ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 3775ceefc113SJed Brown } else if (ts->vrtol) { /* scalar atol, vector rtol */ 3776ceefc113SJed Brown const PetscScalar *rtol; 3777ceefc113SJed Brown ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 3778ceefc113SJed Brown for (i=0; i<n; i++) { 37790910c330SBarry Smith PetscReal tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 37800910c330SBarry Smith sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 3781ceefc113SJed Brown } 3782ceefc113SJed Brown ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 3783ceefc113SJed Brown } else { /* scalar atol, scalar rtol */ 37841c3436cfSJed Brown for (i=0; i<n; i++) { 37850910c330SBarry Smith PetscReal tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 37860910c330SBarry Smith sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 37871c3436cfSJed Brown } 3788ceefc113SJed Brown } 37890910c330SBarry Smith ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 37901c3436cfSJed Brown ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 37911c3436cfSJed Brown 37921c3436cfSJed Brown ierr = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,((PetscObject)ts)->comm);CHKERRQ(ierr); 37931c3436cfSJed Brown *norm = PetscSqrtReal(gsum / N); 37941c3436cfSJed Brown if (PetscIsInfOrNanScalar(*norm)) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 37951c3436cfSJed Brown PetscFunctionReturn(0); 37961c3436cfSJed Brown } 37971c3436cfSJed Brown 37981c3436cfSJed Brown #undef __FUNCT__ 37998d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal" 38008d59e960SJed Brown /*@ 38018d59e960SJed Brown TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler 38028d59e960SJed Brown 38038d59e960SJed Brown Logically Collective on TS 38048d59e960SJed Brown 38058d59e960SJed Brown Input Arguments: 38068d59e960SJed Brown + ts - time stepping context 38078d59e960SJed Brown - cfltime - maximum stable time step if using forward Euler (value can be different on each process) 38088d59e960SJed Brown 38098d59e960SJed Brown Note: 38108d59e960SJed Brown After calling this function, the global CFL time can be obtained by calling TSGetCFLTime() 38118d59e960SJed Brown 38128d59e960SJed Brown Level: intermediate 38138d59e960SJed Brown 38148d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL 38158d59e960SJed Brown @*/ 38168d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime) 38178d59e960SJed Brown { 38188d59e960SJed Brown PetscFunctionBegin; 38198d59e960SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 38208d59e960SJed Brown ts->cfltime_local = cfltime; 38218d59e960SJed Brown ts->cfltime = -1.; 38228d59e960SJed Brown PetscFunctionReturn(0); 38238d59e960SJed Brown } 38248d59e960SJed Brown 38258d59e960SJed Brown #undef __FUNCT__ 38268d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime" 38278d59e960SJed Brown /*@ 38288d59e960SJed Brown TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler 38298d59e960SJed Brown 38308d59e960SJed Brown Collective on TS 38318d59e960SJed Brown 38328d59e960SJed Brown Input Arguments: 38338d59e960SJed Brown . ts - time stepping context 38348d59e960SJed Brown 38358d59e960SJed Brown Output Arguments: 38368d59e960SJed Brown . cfltime - maximum stable time step for forward Euler 38378d59e960SJed Brown 38388d59e960SJed Brown Level: advanced 38398d59e960SJed Brown 38408d59e960SJed Brown .seealso: TSSetCFLTimeLocal() 38418d59e960SJed Brown @*/ 38428d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime) 38438d59e960SJed Brown { 38448d59e960SJed Brown PetscErrorCode ierr; 38458d59e960SJed Brown 38468d59e960SJed Brown PetscFunctionBegin; 38478d59e960SJed Brown if (ts->cfltime < 0) { 38488d59e960SJed Brown ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,((PetscObject)ts)->comm);CHKERRQ(ierr); 38498d59e960SJed Brown } 38508d59e960SJed Brown *cfltime = ts->cfltime; 38518d59e960SJed Brown PetscFunctionReturn(0); 38528d59e960SJed Brown } 38538d59e960SJed Brown 38548d59e960SJed Brown #undef __FUNCT__ 3855d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds" 3856d6ebe24aSShri Abhyankar /*@ 3857d6ebe24aSShri Abhyankar TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu 3858d6ebe24aSShri Abhyankar 3859d6ebe24aSShri Abhyankar Input Parameters: 3860d6ebe24aSShri Abhyankar . ts - the TS context. 3861d6ebe24aSShri Abhyankar . xl - lower bound. 3862d6ebe24aSShri Abhyankar . xu - upper bound. 3863d6ebe24aSShri Abhyankar 3864d6ebe24aSShri Abhyankar Notes: 3865d6ebe24aSShri Abhyankar If this routine is not called then the lower and upper bounds are set to 386633c0c2ddSJed Brown SNES_VI_NINF and SNES_VI_INF respectively during SNESSetUp(). 3867d6ebe24aSShri Abhyankar 38682bd2b0e6SSatish Balay Level: advanced 38692bd2b0e6SSatish Balay 3870d6ebe24aSShri Abhyankar @*/ 3871d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu) 3872d6ebe24aSShri Abhyankar { 3873d6ebe24aSShri Abhyankar PetscErrorCode ierr; 3874d6ebe24aSShri Abhyankar SNES snes; 3875d6ebe24aSShri Abhyankar 3876d6ebe24aSShri Abhyankar PetscFunctionBegin; 3877d6ebe24aSShri Abhyankar ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3878d6ebe24aSShri Abhyankar ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr); 3879d6ebe24aSShri Abhyankar PetscFunctionReturn(0); 3880d6ebe24aSShri Abhyankar } 3881d6ebe24aSShri Abhyankar 3882325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 3883c6db04a5SJed Brown #include <mex.h> 3884325fc9f4SBarry Smith 3885325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext; 3886325fc9f4SBarry Smith 3887325fc9f4SBarry Smith #undef __FUNCT__ 3888325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab" 3889325fc9f4SBarry Smith /* 3890325fc9f4SBarry Smith TSComputeFunction_Matlab - Calls the function that has been set with 3891325fc9f4SBarry Smith TSSetFunctionMatlab(). 3892325fc9f4SBarry Smith 3893325fc9f4SBarry Smith Collective on TS 3894325fc9f4SBarry Smith 3895325fc9f4SBarry Smith Input Parameters: 3896325fc9f4SBarry Smith + snes - the TS context 38970910c330SBarry Smith - u - input vector 3898325fc9f4SBarry Smith 3899325fc9f4SBarry Smith Output Parameter: 3900325fc9f4SBarry Smith . y - function vector, as set by TSSetFunction() 3901325fc9f4SBarry Smith 3902325fc9f4SBarry Smith Notes: 3903325fc9f4SBarry Smith TSComputeFunction() is typically used within nonlinear solvers 3904325fc9f4SBarry Smith implementations, so most users would not generally call this routine 3905325fc9f4SBarry Smith themselves. 3906325fc9f4SBarry Smith 3907325fc9f4SBarry Smith Level: developer 3908325fc9f4SBarry Smith 3909325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 3910325fc9f4SBarry Smith 3911325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 3912325fc9f4SBarry Smith */ 39130910c330SBarry Smith PetscErrorCode TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx) 3914325fc9f4SBarry Smith { 3915325fc9f4SBarry Smith PetscErrorCode ierr; 3916325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext *)ctx; 3917325fc9f4SBarry Smith int nlhs = 1,nrhs = 7; 3918325fc9f4SBarry Smith mxArray *plhs[1],*prhs[7]; 3919325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,ly = 0,ls = 0; 3920325fc9f4SBarry Smith 3921325fc9f4SBarry Smith PetscFunctionBegin; 3922325fc9f4SBarry Smith PetscValidHeaderSpecific(snes,TS_CLASSID,1); 39230910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 39240910c330SBarry Smith PetscValidHeaderSpecific(udot,VEC_CLASSID,4); 3925325fc9f4SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,5); 39260910c330SBarry Smith PetscCheckSameComm(snes,1,u,3); 3927325fc9f4SBarry Smith PetscCheckSameComm(snes,1,y,5); 3928325fc9f4SBarry Smith 3929325fc9f4SBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 39300910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 39310910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr); 39320910c330SBarry Smith ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr); 3933325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 3934325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar(time); 3935325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 3936325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 3937325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)ly); 3938325fc9f4SBarry Smith prhs[5] = mxCreateString(sctx->funcname); 3939325fc9f4SBarry Smith prhs[6] = sctx->ctx; 3940325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr); 3941325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 3942325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 3943325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 3944325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 3945325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 3946325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 3947325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 3948325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 3949325fc9f4SBarry Smith PetscFunctionReturn(0); 3950325fc9f4SBarry Smith } 3951325fc9f4SBarry Smith 3952325fc9f4SBarry Smith 3953325fc9f4SBarry Smith #undef __FUNCT__ 3954325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab" 3955325fc9f4SBarry Smith /* 3956325fc9f4SBarry Smith TSSetFunctionMatlab - Sets the function evaluation routine and function 3957325fc9f4SBarry Smith vector for use by the TS routines in solving ODEs 3958e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 3959325fc9f4SBarry Smith 3960325fc9f4SBarry Smith Logically Collective on TS 3961325fc9f4SBarry Smith 3962325fc9f4SBarry Smith Input Parameters: 3963325fc9f4SBarry Smith + ts - the TS context 3964325fc9f4SBarry Smith - func - function evaluation routine 3965325fc9f4SBarry Smith 3966325fc9f4SBarry Smith Calling sequence of func: 39670910c330SBarry Smith $ func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx); 3968325fc9f4SBarry Smith 3969325fc9f4SBarry Smith Level: beginner 3970325fc9f4SBarry Smith 3971325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 3972325fc9f4SBarry Smith 3973325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 3974325fc9f4SBarry Smith */ 3975cdcf91faSSean Farley PetscErrorCode TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx) 3976325fc9f4SBarry Smith { 3977325fc9f4SBarry Smith PetscErrorCode ierr; 3978325fc9f4SBarry Smith TSMatlabContext *sctx; 3979325fc9f4SBarry Smith 3980325fc9f4SBarry Smith PetscFunctionBegin; 3981325fc9f4SBarry Smith /* currently sctx is memory bleed */ 3982325fc9f4SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 3983325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 3984325fc9f4SBarry Smith /* 3985325fc9f4SBarry Smith This should work, but it doesn't 3986325fc9f4SBarry Smith sctx->ctx = ctx; 3987325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 3988325fc9f4SBarry Smith */ 3989325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 3990cdcf91faSSean Farley ierr = TSSetIFunction(ts,PETSC_NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr); 3991325fc9f4SBarry Smith PetscFunctionReturn(0); 3992325fc9f4SBarry Smith } 3993325fc9f4SBarry Smith 3994325fc9f4SBarry Smith #undef __FUNCT__ 3995325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab" 3996325fc9f4SBarry Smith /* 3997325fc9f4SBarry Smith TSComputeJacobian_Matlab - Calls the function that has been set with 3998325fc9f4SBarry Smith TSSetJacobianMatlab(). 3999325fc9f4SBarry Smith 4000325fc9f4SBarry Smith Collective on TS 4001325fc9f4SBarry Smith 4002325fc9f4SBarry Smith Input Parameters: 4003cdcf91faSSean Farley + ts - the TS context 40040910c330SBarry Smith . u - input vector 4005325fc9f4SBarry Smith . A, B - the matrices 4006325fc9f4SBarry Smith - ctx - user context 4007325fc9f4SBarry Smith 4008325fc9f4SBarry Smith Output Parameter: 4009325fc9f4SBarry Smith . flag - structure of the matrix 4010325fc9f4SBarry Smith 4011325fc9f4SBarry Smith Level: developer 4012325fc9f4SBarry Smith 4013325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 4014325fc9f4SBarry Smith 4015325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 4016325fc9f4SBarry Smith @*/ 40170910c330SBarry Smith PetscErrorCode TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat *A,Mat *B,MatStructure *flag, void *ctx) 4018325fc9f4SBarry Smith { 4019325fc9f4SBarry Smith PetscErrorCode ierr; 4020325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext *)ctx; 4021325fc9f4SBarry Smith int nlhs = 2,nrhs = 9; 4022325fc9f4SBarry Smith mxArray *plhs[2],*prhs[9]; 4023325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0; 4024325fc9f4SBarry Smith 4025325fc9f4SBarry Smith PetscFunctionBegin; 4026cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 40270910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 4028325fc9f4SBarry Smith 40290910c330SBarry Smith /* call Matlab function in ctx with arguments u and y */ 4030325fc9f4SBarry Smith 4031cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 40320910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 40330910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr); 40340910c330SBarry Smith ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr); 40350910c330SBarry Smith ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr); 4036325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 4037325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar((double)time); 4038325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 4039325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 4040325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)shift); 4041325fc9f4SBarry Smith prhs[5] = mxCreateDoubleScalar((double)lA); 4042325fc9f4SBarry Smith prhs[6] = mxCreateDoubleScalar((double)lB); 4043325fc9f4SBarry Smith prhs[7] = mxCreateString(sctx->funcname); 4044325fc9f4SBarry Smith prhs[8] = sctx->ctx; 4045325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr); 4046325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 4047325fc9f4SBarry Smith *flag = (MatStructure) mxGetScalar(plhs[1]);CHKERRQ(ierr); 4048325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 4049325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 4050325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 4051325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 4052325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 4053325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 4054325fc9f4SBarry Smith mxDestroyArray(prhs[6]); 4055325fc9f4SBarry Smith mxDestroyArray(prhs[7]); 4056325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 4057325fc9f4SBarry Smith mxDestroyArray(plhs[1]); 4058325fc9f4SBarry Smith PetscFunctionReturn(0); 4059325fc9f4SBarry Smith } 4060325fc9f4SBarry Smith 4061325fc9f4SBarry Smith 4062325fc9f4SBarry Smith #undef __FUNCT__ 4063325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab" 4064325fc9f4SBarry Smith /* 4065325fc9f4SBarry Smith TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 4066e3c5b3baSBarry 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 4067325fc9f4SBarry Smith 4068325fc9f4SBarry Smith Logically Collective on TS 4069325fc9f4SBarry Smith 4070325fc9f4SBarry Smith Input Parameters: 4071cdcf91faSSean Farley + ts - the TS context 4072325fc9f4SBarry Smith . A,B - Jacobian matrices 4073325fc9f4SBarry Smith . func - function evaluation routine 4074325fc9f4SBarry Smith - ctx - user context 4075325fc9f4SBarry Smith 4076325fc9f4SBarry Smith Calling sequence of func: 40770910c330SBarry Smith $ flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx); 4078325fc9f4SBarry Smith 4079325fc9f4SBarry Smith 4080325fc9f4SBarry Smith Level: developer 4081325fc9f4SBarry Smith 4082325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 4083325fc9f4SBarry Smith 4084325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 4085325fc9f4SBarry Smith */ 4086cdcf91faSSean Farley PetscErrorCode TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx) 4087325fc9f4SBarry Smith { 4088325fc9f4SBarry Smith PetscErrorCode ierr; 4089325fc9f4SBarry Smith TSMatlabContext *sctx; 4090325fc9f4SBarry Smith 4091325fc9f4SBarry Smith PetscFunctionBegin; 4092325fc9f4SBarry Smith /* currently sctx is memory bleed */ 4093325fc9f4SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 4094325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 4095325fc9f4SBarry Smith /* 4096325fc9f4SBarry Smith This should work, but it doesn't 4097325fc9f4SBarry Smith sctx->ctx = ctx; 4098325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 4099325fc9f4SBarry Smith */ 4100325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 4101cdcf91faSSean Farley ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 4102325fc9f4SBarry Smith PetscFunctionReturn(0); 4103325fc9f4SBarry Smith } 4104325fc9f4SBarry Smith 4105b5b1a830SBarry Smith #undef __FUNCT__ 4106b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab" 4107b5b1a830SBarry Smith /* 4108b5b1a830SBarry Smith TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab(). 4109b5b1a830SBarry Smith 4110b5b1a830SBarry Smith Collective on TS 4111b5b1a830SBarry Smith 4112b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 4113b5b1a830SBarry Smith @*/ 41140910c330SBarry Smith PetscErrorCode TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx) 4115b5b1a830SBarry Smith { 4116b5b1a830SBarry Smith PetscErrorCode ierr; 4117b5b1a830SBarry Smith TSMatlabContext *sctx = (TSMatlabContext *)ctx; 4118a530c242SBarry Smith int nlhs = 1,nrhs = 6; 4119b5b1a830SBarry Smith mxArray *plhs[1],*prhs[6]; 4120b5b1a830SBarry Smith long long int lx = 0,ls = 0; 4121b5b1a830SBarry Smith 4122b5b1a830SBarry Smith PetscFunctionBegin; 4123cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 41240910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,4); 4125b5b1a830SBarry Smith 4126cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 41270910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 4128b5b1a830SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 4129b5b1a830SBarry Smith prhs[1] = mxCreateDoubleScalar((double)it); 4130b5b1a830SBarry Smith prhs[2] = mxCreateDoubleScalar((double)time); 4131b5b1a830SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lx); 4132b5b1a830SBarry Smith prhs[4] = mxCreateString(sctx->funcname); 4133b5b1a830SBarry Smith prhs[5] = sctx->ctx; 4134b5b1a830SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr); 4135b5b1a830SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 4136b5b1a830SBarry Smith mxDestroyArray(prhs[0]); 4137b5b1a830SBarry Smith mxDestroyArray(prhs[1]); 4138b5b1a830SBarry Smith mxDestroyArray(prhs[2]); 4139b5b1a830SBarry Smith mxDestroyArray(prhs[3]); 4140b5b1a830SBarry Smith mxDestroyArray(prhs[4]); 4141b5b1a830SBarry Smith mxDestroyArray(plhs[0]); 4142b5b1a830SBarry Smith PetscFunctionReturn(0); 4143b5b1a830SBarry Smith } 4144b5b1a830SBarry Smith 4145b5b1a830SBarry Smith 4146b5b1a830SBarry Smith #undef __FUNCT__ 4147b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab" 4148b5b1a830SBarry Smith /* 4149b5b1a830SBarry Smith TSMonitorSetMatlab - Sets the monitor function from Matlab 4150b5b1a830SBarry Smith 4151b5b1a830SBarry Smith Level: developer 4152b5b1a830SBarry Smith 4153b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function 4154b5b1a830SBarry Smith 4155b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 4156b5b1a830SBarry Smith */ 4157cdcf91faSSean Farley PetscErrorCode TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx) 4158b5b1a830SBarry Smith { 4159b5b1a830SBarry Smith PetscErrorCode ierr; 4160b5b1a830SBarry Smith TSMatlabContext *sctx; 4161b5b1a830SBarry Smith 4162b5b1a830SBarry Smith PetscFunctionBegin; 4163b5b1a830SBarry Smith /* currently sctx is memory bleed */ 4164b5b1a830SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 4165b5b1a830SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 4166b5b1a830SBarry Smith /* 4167b5b1a830SBarry Smith This should work, but it doesn't 4168b5b1a830SBarry Smith sctx->ctx = ctx; 4169b5b1a830SBarry Smith mexMakeArrayPersistent(sctx->ctx); 4170b5b1a830SBarry Smith */ 4171b5b1a830SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 4172cdcf91faSSean Farley ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,PETSC_NULL);CHKERRQ(ierr); 4173b5b1a830SBarry Smith PetscFunctionReturn(0); 4174b5b1a830SBarry Smith } 4175325fc9f4SBarry Smith #endif 4176b3603a34SBarry Smith 41770b039ecaSBarry Smith 41780b039ecaSBarry Smith 4179b3603a34SBarry Smith #undef __FUNCT__ 41804f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution" 4181b3603a34SBarry Smith /*@C 41824f09c107SBarry Smith TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector 4183b3603a34SBarry Smith in a time based line graph 4184b3603a34SBarry Smith 4185b3603a34SBarry Smith Collective on TS 4186b3603a34SBarry Smith 4187b3603a34SBarry Smith Input Parameters: 4188b3603a34SBarry Smith + ts - the TS context 4189b3603a34SBarry Smith . step - current time-step 4190b3603a34SBarry Smith . ptime - current time 4191b3603a34SBarry Smith - lg - a line graph object 4192b3603a34SBarry Smith 4193b3603a34SBarry Smith Level: intermediate 4194b3603a34SBarry Smith 41950b039ecaSBarry Smith Notes: each process in a parallel run displays its component solutions in a separate window 4196b3603a34SBarry Smith 4197b3603a34SBarry Smith .keywords: TS, vector, monitor, view 4198b3603a34SBarry Smith 4199b3603a34SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 4200b3603a34SBarry Smith @*/ 42010910c330SBarry Smith PetscErrorCode TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 4202b3603a34SBarry Smith { 4203b3603a34SBarry Smith PetscErrorCode ierr; 42040b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 4205b3603a34SBarry Smith const PetscScalar *yy; 420658ff32f7SBarry Smith PetscInt dim; 4207b3603a34SBarry Smith 4208b3603a34SBarry Smith PetscFunctionBegin; 420958ff32f7SBarry Smith if (!step) { 4210a9f9c1f6SBarry Smith PetscDrawAxis axis; 4211a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 4212a9f9c1f6SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr); 42130910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 42140b039ecaSBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 42150b039ecaSBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 421658ff32f7SBarry Smith } 42170910c330SBarry Smith ierr = VecGetArrayRead(u,&yy);CHKERRQ(ierr); 4218e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 4219e3efe391SJed Brown { 4220e3efe391SJed Brown PetscReal *yreal; 4221e3efe391SJed Brown PetscInt i,n; 42220910c330SBarry Smith ierr = VecGetLocalSize(u,&n);CHKERRQ(ierr); 4223e3efe391SJed Brown ierr = PetscMalloc(n*sizeof(PetscReal),&yreal);CHKERRQ(ierr); 4224e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 42250b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 4226e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 4227e3efe391SJed Brown } 4228e3efe391SJed Brown #else 42290b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 4230e3efe391SJed Brown #endif 42310910c330SBarry Smith ierr = VecRestoreArrayRead(u,&yy);CHKERRQ(ierr); 42323fbbecb0SBarry Smith if (((ctx->howoften > 0) && (!(step % ctx->howoften)) && (step > -1)) || ((ctx->howoften == -1) && (step == -1))){ 42330b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 42343923b477SBarry Smith } 4235b3603a34SBarry Smith PetscFunctionReturn(0); 4236b3603a34SBarry Smith } 4237b3603a34SBarry Smith 4238b3603a34SBarry Smith #undef __FUNCT__ 42394f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError" 4240ef20d060SBarry Smith /*@C 42414f09c107SBarry Smith TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector 4242ef20d060SBarry Smith in a time based line graph 4243ef20d060SBarry Smith 4244ef20d060SBarry Smith Collective on TS 4245ef20d060SBarry Smith 4246ef20d060SBarry Smith Input Parameters: 4247ef20d060SBarry Smith + ts - the TS context 4248ef20d060SBarry Smith . step - current time-step 4249ef20d060SBarry Smith . ptime - current time 4250ef20d060SBarry Smith - lg - a line graph object 4251ef20d060SBarry Smith 4252ef20d060SBarry Smith Level: intermediate 4253ef20d060SBarry Smith 4254abd5a294SJed Brown Notes: 4255abd5a294SJed Brown Only for sequential solves. 4256abd5a294SJed Brown 4257abd5a294SJed Brown The user must provide the solution using TSSetSolutionFunction() to use this monitor. 4258abd5a294SJed Brown 4259abd5a294SJed Brown Options Database Keys: 42604f09c107SBarry Smith . -ts_monitor_lg_error - create a graphical monitor of error history 4261ef20d060SBarry Smith 4262ef20d060SBarry Smith .keywords: TS, vector, monitor, view 4263ef20d060SBarry Smith 4264abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 4265ef20d060SBarry Smith @*/ 42660910c330SBarry Smith PetscErrorCode TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 4267ef20d060SBarry Smith { 4268ef20d060SBarry Smith PetscErrorCode ierr; 42690b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 4270ef20d060SBarry Smith const PetscScalar *yy; 4271ef20d060SBarry Smith Vec y; 4272a9f9c1f6SBarry Smith PetscInt dim; 4273ef20d060SBarry Smith 4274ef20d060SBarry Smith PetscFunctionBegin; 4275a9f9c1f6SBarry Smith if (!step) { 4276a9f9c1f6SBarry Smith PetscDrawAxis axis; 4277a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 42781ae185eaSBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr); 42790910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 4280a9f9c1f6SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 4281a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4282a9f9c1f6SBarry Smith } 42830910c330SBarry Smith ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 4284ef20d060SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr); 42850910c330SBarry Smith ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr); 4286ef20d060SBarry Smith ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr); 4287e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 4288e3efe391SJed Brown { 4289e3efe391SJed Brown PetscReal *yreal; 4290e3efe391SJed Brown PetscInt i,n; 4291e3efe391SJed Brown ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr); 4292e3efe391SJed Brown ierr = PetscMalloc(n*sizeof(PetscReal),&yreal);CHKERRQ(ierr); 4293e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 42940b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 4295e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 4296e3efe391SJed Brown } 4297e3efe391SJed Brown #else 42980b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 4299e3efe391SJed Brown #endif 4300ef20d060SBarry Smith ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr); 4301ef20d060SBarry Smith ierr = VecDestroy(&y);CHKERRQ(ierr); 43023fbbecb0SBarry Smith if (((ctx->howoften > 0) && (!(step % ctx->howoften)) && (step > -1)) || ((ctx->howoften == -1) && (step == -1))){ 43030b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 43043923b477SBarry Smith } 4305ef20d060SBarry Smith PetscFunctionReturn(0); 4306ef20d060SBarry Smith } 4307ef20d060SBarry Smith 4308201da799SBarry Smith #undef __FUNCT__ 4309201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations" 4310201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 4311201da799SBarry Smith { 4312201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 4313201da799SBarry Smith PetscReal x = ptime,y; 4314201da799SBarry Smith PetscErrorCode ierr; 4315201da799SBarry Smith PetscInt its; 4316201da799SBarry Smith 4317201da799SBarry Smith PetscFunctionBegin; 4318201da799SBarry Smith if (!n) { 4319201da799SBarry Smith PetscDrawAxis axis; 4320201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 4321201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr); 4322201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4323201da799SBarry Smith ctx->snes_its = 0; 4324201da799SBarry Smith } 4325201da799SBarry Smith ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr); 4326201da799SBarry Smith y = its - ctx->snes_its; 4327201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 43283fbbecb0SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))){ 4329201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 4330201da799SBarry Smith } 4331201da799SBarry Smith ctx->snes_its = its; 4332201da799SBarry Smith PetscFunctionReturn(0); 4333201da799SBarry Smith } 4334201da799SBarry Smith 4335201da799SBarry Smith #undef __FUNCT__ 4336201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations" 4337201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 4338201da799SBarry Smith { 4339201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 4340201da799SBarry Smith PetscReal x = ptime,y; 4341201da799SBarry Smith PetscErrorCode ierr; 4342201da799SBarry Smith PetscInt its; 4343201da799SBarry Smith 4344201da799SBarry Smith PetscFunctionBegin; 4345201da799SBarry Smith if (!n) { 4346201da799SBarry Smith PetscDrawAxis axis; 4347201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 4348201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr); 4349201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4350201da799SBarry Smith ctx->ksp_its = 0; 4351201da799SBarry Smith } 4352201da799SBarry Smith ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr); 4353201da799SBarry Smith y = its - ctx->ksp_its; 4354201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 435599fdda47SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))){ 4356201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 4357201da799SBarry Smith } 4358201da799SBarry Smith ctx->ksp_its = its; 4359201da799SBarry Smith PetscFunctionReturn(0); 4360201da799SBarry Smith } 4361f9c1d6abSBarry Smith 4362f9c1d6abSBarry Smith #undef __FUNCT__ 4363f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability" 4364f9c1d6abSBarry Smith /*@ 4365f9c1d6abSBarry Smith TSComputeLinearStability - computes the linear stability function at a point 4366f9c1d6abSBarry Smith 4367f9c1d6abSBarry Smith Collective on TS and Vec 4368f9c1d6abSBarry Smith 4369f9c1d6abSBarry Smith Input Parameters: 4370f9c1d6abSBarry Smith + ts - the TS context 4371f9c1d6abSBarry Smith - xr,xi - real and imaginary part of input arguments 4372f9c1d6abSBarry Smith 4373f9c1d6abSBarry Smith Output Parameters: 4374f9c1d6abSBarry Smith . yr,yi - real and imaginary part of function value 4375f9c1d6abSBarry Smith 4376f9c1d6abSBarry Smith Level: developer 4377f9c1d6abSBarry Smith 4378f9c1d6abSBarry Smith .keywords: TS, compute 4379f9c1d6abSBarry Smith 4380f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction() 4381f9c1d6abSBarry Smith @*/ 4382f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi) 4383f9c1d6abSBarry Smith { 4384f9c1d6abSBarry Smith PetscErrorCode ierr; 4385f9c1d6abSBarry Smith 4386f9c1d6abSBarry Smith PetscFunctionBegin; 4387f9c1d6abSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4388f9c1d6abSBarry Smith if (!ts->ops->linearstability) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_SUP,"Linearized stability function not provided for this method"); 4389f9c1d6abSBarry Smith ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr); 4390f9c1d6abSBarry Smith PetscFunctionReturn(0); 4391f9c1d6abSBarry Smith } 4392