163dd3a1aSKris Buschelman 2c6db04a5SJed Brown #include <private/tsimpl.h> /*I "petscts.h" I*/ 3d763cef2SBarry Smith 4d5ba7fb7SMatthew Knepley /* Logging support */ 57087cfbeSBarry Smith PetscClassId TS_CLASSID; 6166c7f25SBarry Smith PetscLogEvent TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval; 7d405a339SMatthew Knepley 84a2ae208SSatish Balay #undef __FUNCT__ 9bdad233fSMatthew Knepley #define __FUNCT__ "TSSetTypeFromOptions" 10bdad233fSMatthew Knepley /* 11bdad233fSMatthew Knepley TSSetTypeFromOptions - Sets the type of ts from user options. 12bdad233fSMatthew Knepley 13bdad233fSMatthew Knepley Collective on TS 14bdad233fSMatthew Knepley 15bdad233fSMatthew Knepley Input Parameter: 16bdad233fSMatthew Knepley . ts - The ts 17bdad233fSMatthew Knepley 18bdad233fSMatthew Knepley Level: intermediate 19bdad233fSMatthew Knepley 20bdad233fSMatthew Knepley .keywords: TS, set, options, database, type 21bdad233fSMatthew Knepley .seealso: TSSetFromOptions(), TSSetType() 22bdad233fSMatthew Knepley */ 236849ba73SBarry Smith static PetscErrorCode TSSetTypeFromOptions(TS ts) 24bdad233fSMatthew Knepley { 25ace3abfcSBarry Smith PetscBool opt; 262fc52814SBarry Smith const char *defaultType; 27bdad233fSMatthew Knepley char typeName[256]; 28dfbe8321SBarry Smith PetscErrorCode ierr; 29bdad233fSMatthew Knepley 30bdad233fSMatthew Knepley PetscFunctionBegin; 317adad957SLisandro Dalcin if (((PetscObject)ts)->type_name) { 327adad957SLisandro Dalcin defaultType = ((PetscObject)ts)->type_name; 33bdad233fSMatthew Knepley } else { 349596e0b4SJed Brown defaultType = TSEULER; 35bdad233fSMatthew Knepley } 36bdad233fSMatthew Knepley 37cce0b1b2SLisandro Dalcin if (!TSRegisterAllCalled) {ierr = TSRegisterAll(PETSC_NULL);CHKERRQ(ierr);} 38bdad233fSMatthew Knepley ierr = PetscOptionsList("-ts_type", "TS method"," TSSetType", TSList, defaultType, typeName, 256, &opt);CHKERRQ(ierr); 39a7cc72afSBarry Smith if (opt) { 40bdad233fSMatthew Knepley ierr = TSSetType(ts, typeName);CHKERRQ(ierr); 41bdad233fSMatthew Knepley } else { 42bdad233fSMatthew Knepley ierr = TSSetType(ts, defaultType);CHKERRQ(ierr); 43bdad233fSMatthew Knepley } 44bdad233fSMatthew Knepley PetscFunctionReturn(0); 45bdad233fSMatthew Knepley } 46bdad233fSMatthew Knepley 47bdad233fSMatthew Knepley #undef __FUNCT__ 48bdad233fSMatthew Knepley #define __FUNCT__ "TSSetFromOptions" 49bdad233fSMatthew Knepley /*@ 50bdad233fSMatthew Knepley TSSetFromOptions - Sets various TS parameters from user options. 51bdad233fSMatthew Knepley 52bdad233fSMatthew Knepley Collective on TS 53bdad233fSMatthew Knepley 54bdad233fSMatthew Knepley Input Parameter: 55bdad233fSMatthew Knepley . ts - the TS context obtained from TSCreate() 56bdad233fSMatthew Knepley 57bdad233fSMatthew Knepley Options Database Keys: 584d91e141SJed Brown + -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSGL, TSSSP 59bdad233fSMatthew Knepley . -ts_max_steps maxsteps - maximum number of time-steps to take 60bdad233fSMatthew Knepley . -ts_max_time time - maximum time to compute to 61bdad233fSMatthew Knepley . -ts_dt dt - initial time step 62bdad233fSMatthew Knepley . -ts_monitor - print information at each timestep 63a6570f20SBarry Smith - -ts_monitor_draw - plot information at each timestep 64bdad233fSMatthew Knepley 65bdad233fSMatthew Knepley Level: beginner 66bdad233fSMatthew Knepley 67bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database 68bdad233fSMatthew Knepley 69a313700dSBarry Smith .seealso: TSGetType() 70bdad233fSMatthew Knepley @*/ 717087cfbeSBarry Smith PetscErrorCode TSSetFromOptions(TS ts) 72bdad233fSMatthew Knepley { 73bdad233fSMatthew Knepley PetscReal dt; 74ace3abfcSBarry Smith PetscBool opt,flg; 75dfbe8321SBarry Smith PetscErrorCode ierr; 76649052a6SBarry Smith PetscViewer monviewer; 77eabae89aSBarry Smith char monfilename[PETSC_MAX_PATH_LEN]; 78089b2837SJed Brown SNES snes; 79bdad233fSMatthew Knepley 80bdad233fSMatthew Knepley PetscFunctionBegin; 810700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 827adad957SLisandro Dalcin ierr = PetscOptionsBegin(((PetscObject)ts)->comm, ((PetscObject)ts)->prefix, "Time step options", "TS");CHKERRQ(ierr); 83bdad233fSMatthew Knepley 84bdad233fSMatthew Knepley /* Handle generic TS options */ 85bdad233fSMatthew Knepley ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,PETSC_NULL);CHKERRQ(ierr); 86bdad233fSMatthew Knepley ierr = PetscOptionsReal("-ts_max_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,PETSC_NULL);CHKERRQ(ierr); 87bdad233fSMatthew Knepley ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetInitialTime", ts->ptime, &ts->ptime, PETSC_NULL);CHKERRQ(ierr); 88bdad233fSMatthew Knepley ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetInitialTimeStep",ts->initial_time_step,&dt,&opt);CHKERRQ(ierr); 893daf2de8SJed Brown if (opt) {ierr = TSSetInitialTimeStep(ts,ts->ptime,dt);CHKERRQ(ierr);} 90193ac0bcSJed Brown ierr = PetscOptionsInt("-ts_max_snes_failures","Maximum number of nonlinear solve failures","",ts->max_snes_failures,&ts->max_snes_failures,PETSC_NULL);CHKERRQ(ierr); 91193ac0bcSJed Brown ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections","",ts->max_reject,&ts->max_reject,PETSC_NULL);CHKERRQ(ierr); 92193ac0bcSJed Brown ierr = PetscOptionsBool("-ts_error_if_step_failed","Error if no step succeeds","",ts->errorifstepfailed,&ts->errorifstepfailed,PETSC_NULL);CHKERRQ(ierr); 93bdad233fSMatthew Knepley 94bdad233fSMatthew Knepley /* Monitor options */ 95a6570f20SBarry Smith ierr = PetscOptionsString("-ts_monitor","Monitor timestep size","TSMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 96eabae89aSBarry Smith if (flg) { 97649052a6SBarry Smith ierr = PetscViewerASCIIOpen(((PetscObject)ts)->comm,monfilename,&monviewer);CHKERRQ(ierr); 98649052a6SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 99bdad233fSMatthew Knepley } 1005180491cSLisandro Dalcin ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 1015180491cSLisandro Dalcin if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);} 1025180491cSLisandro Dalcin 10390d69ab7SBarry Smith opt = PETSC_FALSE; 104acfcf0e5SJed Brown ierr = PetscOptionsBool("-ts_monitor_draw","Monitor timestep size graphically","TSMonitorLG",opt,&opt,PETSC_NULL);CHKERRQ(ierr); 105a7cc72afSBarry Smith if (opt) { 106a6570f20SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLG,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 107bdad233fSMatthew Knepley } 10890d69ab7SBarry Smith opt = PETSC_FALSE; 109acfcf0e5SJed Brown ierr = PetscOptionsBool("-ts_monitor_solution","Monitor solution graphically","TSMonitorSolution",opt,&opt,PETSC_NULL);CHKERRQ(ierr); 110a7cc72afSBarry Smith if (opt) { 111a6570f20SBarry Smith ierr = TSMonitorSet(ts,TSMonitorSolution,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 112bdad233fSMatthew Knepley } 113bdad233fSMatthew Knepley 114bdad233fSMatthew Knepley /* Handle TS type options */ 115bdad233fSMatthew Knepley ierr = TSSetTypeFromOptions(ts);CHKERRQ(ierr); 116bdad233fSMatthew Knepley 117bdad233fSMatthew Knepley /* Handle specific TS options */ 118abc0a331SBarry Smith if (ts->ops->setfromoptions) { 119bdad233fSMatthew Knepley ierr = (*ts->ops->setfromoptions)(ts);CHKERRQ(ierr); 120bdad233fSMatthew Knepley } 1215d973c19SBarry Smith 1225d973c19SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 1235d973c19SBarry Smith ierr = PetscObjectProcessOptionsHandlers((PetscObject)ts);CHKERRQ(ierr); 124bdad233fSMatthew Knepley ierr = PetscOptionsEnd();CHKERRQ(ierr); 125bdad233fSMatthew Knepley 126089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 127bdad233fSMatthew Knepley /* Handle subobject options */ 128089b2837SJed Brown if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);} 129089b2837SJed Brown ierr = SNESSetFromOptions(snes);CHKERRQ(ierr); 130bdad233fSMatthew Knepley PetscFunctionReturn(0); 131bdad233fSMatthew Knepley } 132bdad233fSMatthew Knepley 133bdad233fSMatthew Knepley #undef __FUNCT__ 134bdad233fSMatthew Knepley #define __FUNCT__ "TSViewFromOptions" 135bdad233fSMatthew Knepley /*@ 136bdad233fSMatthew Knepley TSViewFromOptions - This function visualizes the ts based upon user options. 137bdad233fSMatthew Knepley 138bdad233fSMatthew Knepley Collective on TS 139bdad233fSMatthew Knepley 140bdad233fSMatthew Knepley Input Parameter: 141bdad233fSMatthew Knepley . ts - The ts 142bdad233fSMatthew Knepley 143bdad233fSMatthew Knepley Level: intermediate 144bdad233fSMatthew Knepley 145bdad233fSMatthew Knepley .keywords: TS, view, options, database 146bdad233fSMatthew Knepley .seealso: TSSetFromOptions(), TSView() 147bdad233fSMatthew Knepley @*/ 1487087cfbeSBarry Smith PetscErrorCode TSViewFromOptions(TS ts,const char title[]) 149bdad233fSMatthew Knepley { 150bdad233fSMatthew Knepley PetscViewer viewer; 151bdad233fSMatthew Knepley PetscDraw draw; 152ace3abfcSBarry Smith PetscBool opt = PETSC_FALSE; 153e10c49a3SBarry Smith char fileName[PETSC_MAX_PATH_LEN]; 154dfbe8321SBarry Smith PetscErrorCode ierr; 155bdad233fSMatthew Knepley 156bdad233fSMatthew Knepley PetscFunctionBegin; 1577adad957SLisandro Dalcin ierr = PetscOptionsGetString(((PetscObject)ts)->prefix, "-ts_view", fileName, PETSC_MAX_PATH_LEN, &opt);CHKERRQ(ierr); 158eabae89aSBarry Smith if (opt && !PetscPreLoadingOn) { 1597adad957SLisandro Dalcin ierr = PetscViewerASCIIOpen(((PetscObject)ts)->comm,fileName,&viewer);CHKERRQ(ierr); 160bdad233fSMatthew Knepley ierr = TSView(ts, viewer);CHKERRQ(ierr); 1616bf464f9SBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 162bdad233fSMatthew Knepley } 1638e83347fSKai Germaschewski opt = PETSC_FALSE; 164acfcf0e5SJed Brown ierr = PetscOptionsGetBool(((PetscObject)ts)->prefix, "-ts_view_draw", &opt,PETSC_NULL);CHKERRQ(ierr); 165a7cc72afSBarry Smith if (opt) { 1667adad957SLisandro Dalcin ierr = PetscViewerDrawOpen(((PetscObject)ts)->comm, 0, 0, 0, 0, 300, 300, &viewer);CHKERRQ(ierr); 167bdad233fSMatthew Knepley ierr = PetscViewerDrawGetDraw(viewer, 0, &draw);CHKERRQ(ierr); 168a7cc72afSBarry Smith if (title) { 1691836bdbcSSatish Balay ierr = PetscDrawSetTitle(draw, (char *)title);CHKERRQ(ierr); 170bdad233fSMatthew Knepley } else { 171bdad233fSMatthew Knepley ierr = PetscObjectName((PetscObject)ts);CHKERRQ(ierr); 1727adad957SLisandro Dalcin ierr = PetscDrawSetTitle(draw, ((PetscObject)ts)->name);CHKERRQ(ierr); 173bdad233fSMatthew Knepley } 174bdad233fSMatthew Knepley ierr = TSView(ts, viewer);CHKERRQ(ierr); 175bdad233fSMatthew Knepley ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 176bdad233fSMatthew Knepley ierr = PetscDrawPause(draw);CHKERRQ(ierr); 1776bf464f9SBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 178bdad233fSMatthew Knepley } 179bdad233fSMatthew Knepley PetscFunctionReturn(0); 180bdad233fSMatthew Knepley } 181bdad233fSMatthew Knepley 182bdad233fSMatthew Knepley #undef __FUNCT__ 1834a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSJacobian" 184a7a1495cSBarry Smith /*@ 1858c385f81SBarry Smith TSComputeRHSJacobian - Computes the Jacobian matrix that has been 186a7a1495cSBarry Smith set with TSSetRHSJacobian(). 187a7a1495cSBarry Smith 188a7a1495cSBarry Smith Collective on TS and Vec 189a7a1495cSBarry Smith 190a7a1495cSBarry Smith Input Parameters: 191316643e7SJed Brown + ts - the TS context 192a7a1495cSBarry Smith . t - current timestep 193a7a1495cSBarry Smith - x - input vector 194a7a1495cSBarry Smith 195a7a1495cSBarry Smith Output Parameters: 196a7a1495cSBarry Smith + A - Jacobian matrix 197a7a1495cSBarry Smith . B - optional preconditioning matrix 198a7a1495cSBarry Smith - flag - flag indicating matrix structure 199a7a1495cSBarry Smith 200a7a1495cSBarry Smith Notes: 201a7a1495cSBarry Smith Most users should not need to explicitly call this routine, as it 202a7a1495cSBarry Smith is used internally within the nonlinear solvers. 203a7a1495cSBarry Smith 20494b7f48cSBarry Smith See KSPSetOperators() for important information about setting the 205a7a1495cSBarry Smith flag parameter. 206a7a1495cSBarry Smith 207a7a1495cSBarry Smith Level: developer 208a7a1495cSBarry Smith 209a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix 210a7a1495cSBarry Smith 21194b7f48cSBarry Smith .seealso: TSSetRHSJacobian(), KSPSetOperators() 212a7a1495cSBarry Smith @*/ 2137087cfbeSBarry Smith PetscErrorCode TSComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat *A,Mat *B,MatStructure *flg) 214a7a1495cSBarry Smith { 215dfbe8321SBarry Smith PetscErrorCode ierr; 2160e4ef248SJed Brown PetscInt Xstate; 217a7a1495cSBarry Smith 218a7a1495cSBarry Smith PetscFunctionBegin; 2190700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2200700a824SBarry Smith PetscValidHeaderSpecific(X,VEC_CLASSID,3); 221c9780b6fSBarry Smith PetscCheckSameComm(ts,1,X,3); 2220e4ef248SJed Brown ierr = PetscObjectStateQuery((PetscObject)X,&Xstate);CHKERRQ(ierr); 2230e4ef248SJed Brown if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == X && ts->rhsjacobian.Xstate == Xstate))) { 2240e4ef248SJed Brown *flg = ts->rhsjacobian.mstructure; 2250e4ef248SJed Brown PetscFunctionReturn(0); 226f8ede8e7SJed Brown } 227d90be118SSean Farley 2283b5f76d0SSean Farley if (!ts->userops->rhsjacobian && !ts->userops->ijacobian) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 229d90be118SSean Farley 2303b5f76d0SSean Farley if (ts->userops->rhsjacobian) { 231d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_JacobianEval,ts,X,*A,*B);CHKERRQ(ierr); 232a7a1495cSBarry Smith *flg = DIFFERENT_NONZERO_PATTERN; 233a7a1495cSBarry Smith PetscStackPush("TS user Jacobian function"); 2343b5f76d0SSean Farley ierr = (*ts->userops->rhsjacobian)(ts,t,X,A,B,flg,ts->jacP);CHKERRQ(ierr); 235a7a1495cSBarry Smith PetscStackPop; 236d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_JacobianEval,ts,X,*A,*B);CHKERRQ(ierr); 237a7a1495cSBarry Smith /* make sure user returned a correct Jacobian and preconditioner */ 2380700a824SBarry Smith PetscValidHeaderSpecific(*A,MAT_CLASSID,4); 2390700a824SBarry Smith PetscValidHeaderSpecific(*B,MAT_CLASSID,5); 240ef66eb69SBarry Smith } else { 241214bc6a2SJed Brown ierr = MatZeroEntries(*A);CHKERRQ(ierr); 242214bc6a2SJed Brown if (*A != *B) {ierr = MatZeroEntries(*B);CHKERRQ(ierr);} 243214bc6a2SJed Brown *flg = SAME_NONZERO_PATTERN; 244ef66eb69SBarry Smith } 2450e4ef248SJed Brown ts->rhsjacobian.time = t; 2460e4ef248SJed Brown ts->rhsjacobian.X = X; 2470e4ef248SJed Brown ierr = PetscObjectStateQuery((PetscObject)X,&ts->rhsjacobian.Xstate);CHKERRQ(ierr); 2480e4ef248SJed Brown ts->rhsjacobian.mstructure = *flg; 249a7a1495cSBarry Smith PetscFunctionReturn(0); 250a7a1495cSBarry Smith } 251a7a1495cSBarry Smith 2524a2ae208SSatish Balay #undef __FUNCT__ 2534a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction" 254316643e7SJed Brown /*@ 255d763cef2SBarry Smith TSComputeRHSFunction - Evaluates the right-hand-side function. 256d763cef2SBarry Smith 257316643e7SJed Brown Collective on TS and Vec 258316643e7SJed Brown 259316643e7SJed Brown Input Parameters: 260316643e7SJed Brown + ts - the TS context 261316643e7SJed Brown . t - current time 262316643e7SJed Brown - x - state vector 263316643e7SJed Brown 264316643e7SJed Brown Output Parameter: 265316643e7SJed Brown . y - right hand side 266316643e7SJed Brown 267316643e7SJed Brown Note: 268316643e7SJed Brown Most users should not need to explicitly call this routine, as it 269316643e7SJed Brown is used internally within the nonlinear solvers. 270316643e7SJed Brown 271316643e7SJed Brown Level: developer 272316643e7SJed Brown 273316643e7SJed Brown .keywords: TS, compute 274316643e7SJed Brown 275316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction() 276316643e7SJed Brown @*/ 277dfbe8321SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec x,Vec y) 278d763cef2SBarry Smith { 279dfbe8321SBarry Smith PetscErrorCode ierr; 280d763cef2SBarry Smith 281d763cef2SBarry Smith PetscFunctionBegin; 2820700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2830700a824SBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,3); 2840700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,4); 285d763cef2SBarry Smith 2863b5f76d0SSean Farley if (!ts->userops->rhsfunction && !ts->userops->ifunction) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 287d763cef2SBarry Smith 288d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_FunctionEval,ts,x,y,0);CHKERRQ(ierr); 2893b5f76d0SSean Farley if (ts->userops->rhsfunction) { 290d763cef2SBarry Smith PetscStackPush("TS user right-hand-side function"); 2913b5f76d0SSean Farley ierr = (*ts->userops->rhsfunction)(ts,t,x,y,ts->funP);CHKERRQ(ierr); 292d763cef2SBarry Smith PetscStackPop; 293214bc6a2SJed Brown } else { 294214bc6a2SJed Brown ierr = VecZeroEntries(y);CHKERRQ(ierr); 295b2cd27e8SJed Brown } 29644a41b28SSean Farley 297d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_FunctionEval,ts,x,y,0);CHKERRQ(ierr); 298d763cef2SBarry Smith PetscFunctionReturn(0); 299d763cef2SBarry Smith } 300d763cef2SBarry Smith 3014a2ae208SSatish Balay #undef __FUNCT__ 302214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private" 303214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs) 304214bc6a2SJed Brown { 305214bc6a2SJed Brown PetscErrorCode ierr; 306214bc6a2SJed Brown 307214bc6a2SJed Brown PetscFunctionBegin; 308214bc6a2SJed Brown if (!ts->Frhs) { 309214bc6a2SJed Brown ierr = VecDuplicate(ts->vec_sol,&ts->Frhs);CHKERRQ(ierr); 310214bc6a2SJed Brown } 311214bc6a2SJed Brown *Frhs = ts->Frhs; 312214bc6a2SJed Brown PetscFunctionReturn(0); 313214bc6a2SJed Brown } 314214bc6a2SJed Brown 315214bc6a2SJed Brown #undef __FUNCT__ 316214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private" 317214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs) 318214bc6a2SJed Brown { 319214bc6a2SJed Brown PetscErrorCode ierr; 320214bc6a2SJed Brown Mat A,B; 321214bc6a2SJed Brown 322214bc6a2SJed Brown PetscFunctionBegin; 323214bc6a2SJed Brown ierr = TSGetIJacobian(ts,&A,&B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 324214bc6a2SJed Brown if (Arhs) { 325214bc6a2SJed Brown if (!ts->Arhs) { 326214bc6a2SJed Brown ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr); 327214bc6a2SJed Brown } 328214bc6a2SJed Brown *Arhs = ts->Arhs; 329214bc6a2SJed Brown } 330214bc6a2SJed Brown if (Brhs) { 331214bc6a2SJed Brown if (!ts->Brhs) { 332214bc6a2SJed Brown ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr); 333214bc6a2SJed Brown } 334214bc6a2SJed Brown *Brhs = ts->Brhs; 335214bc6a2SJed Brown } 336214bc6a2SJed Brown PetscFunctionReturn(0); 337214bc6a2SJed Brown } 338214bc6a2SJed Brown 339214bc6a2SJed Brown #undef __FUNCT__ 340316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction" 341316643e7SJed Brown /*@ 342316643e7SJed Brown TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,X,Xdot)=0 343316643e7SJed Brown 344316643e7SJed Brown Collective on TS and Vec 345316643e7SJed Brown 346316643e7SJed Brown Input Parameters: 347316643e7SJed Brown + ts - the TS context 348316643e7SJed Brown . t - current time 349316643e7SJed Brown . X - state vector 350214bc6a2SJed Brown . Xdot - time derivative of state vector 351214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate 352316643e7SJed Brown 353316643e7SJed Brown Output Parameter: 354316643e7SJed Brown . Y - right hand side 355316643e7SJed Brown 356316643e7SJed Brown Note: 357316643e7SJed Brown Most users should not need to explicitly call this routine, as it 358316643e7SJed Brown is used internally within the nonlinear solvers. 359316643e7SJed Brown 360316643e7SJed Brown If the user did did not write their equations in implicit form, this 361316643e7SJed Brown function recasts them in implicit form. 362316643e7SJed Brown 363316643e7SJed Brown Level: developer 364316643e7SJed Brown 365316643e7SJed Brown .keywords: TS, compute 366316643e7SJed Brown 367316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction() 368316643e7SJed Brown @*/ 369214bc6a2SJed Brown PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec X,Vec Xdot,Vec Y,PetscBool imex) 370316643e7SJed Brown { 371316643e7SJed Brown PetscErrorCode ierr; 372316643e7SJed Brown 373316643e7SJed Brown PetscFunctionBegin; 3740700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3750700a824SBarry Smith PetscValidHeaderSpecific(X,VEC_CLASSID,3); 3760700a824SBarry Smith PetscValidHeaderSpecific(Xdot,VEC_CLASSID,4); 3770700a824SBarry Smith PetscValidHeaderSpecific(Y,VEC_CLASSID,5); 378316643e7SJed Brown 379d90be118SSean Farley if (!ts->userops->rhsfunction && !ts->userops->ifunction) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 380d90be118SSean Farley 381316643e7SJed Brown ierr = PetscLogEventBegin(TS_FunctionEval,ts,X,Xdot,Y);CHKERRQ(ierr); 3823b5f76d0SSean Farley if (ts->userops->ifunction) { 383316643e7SJed Brown PetscStackPush("TS user implicit function"); 3843b5f76d0SSean Farley ierr = (*ts->userops->ifunction)(ts,t,X,Xdot,Y,ts->funP);CHKERRQ(ierr); 385316643e7SJed Brown PetscStackPop; 386214bc6a2SJed Brown } 387214bc6a2SJed Brown if (imex) { 3883b5f76d0SSean Farley if (!ts->userops->ifunction) {ierr = VecCopy(Xdot,Y);CHKERRQ(ierr);} 389316643e7SJed Brown } else { 3903b5f76d0SSean Farley if (!ts->userops->ifunction) { 391089b2837SJed Brown ierr = TSComputeRHSFunction(ts,t,X,Y);CHKERRQ(ierr); 392ace68cafSJed Brown ierr = VecAYPX(Y,-1,Xdot);CHKERRQ(ierr); 393214bc6a2SJed Brown } else { 394214bc6a2SJed Brown Vec Frhs; 395214bc6a2SJed Brown ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 396214bc6a2SJed Brown ierr = TSComputeRHSFunction(ts,t,X,Frhs);CHKERRQ(ierr); 397214bc6a2SJed Brown ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr); 398316643e7SJed Brown } 3994a6899ffSJed Brown } 400316643e7SJed Brown ierr = PetscLogEventEnd(TS_FunctionEval,ts,X,Xdot,Y);CHKERRQ(ierr); 401316643e7SJed Brown PetscFunctionReturn(0); 402316643e7SJed Brown } 403316643e7SJed Brown 404316643e7SJed Brown #undef __FUNCT__ 405316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian" 406316643e7SJed Brown /*@ 407316643e7SJed Brown TSComputeIJacobian - Evaluates the Jacobian of the DAE 408316643e7SJed Brown 409316643e7SJed Brown Collective on TS and Vec 410316643e7SJed Brown 411316643e7SJed Brown Input 412316643e7SJed Brown Input Parameters: 413316643e7SJed Brown + ts - the TS context 414316643e7SJed Brown . t - current timestep 415316643e7SJed Brown . X - state vector 416316643e7SJed Brown . Xdot - time derivative of state vector 417214bc6a2SJed Brown . shift - shift to apply, see note below 418214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate 419316643e7SJed Brown 420316643e7SJed Brown Output Parameters: 421316643e7SJed Brown + A - Jacobian matrix 422316643e7SJed Brown . B - optional preconditioning matrix 423316643e7SJed Brown - flag - flag indicating matrix structure 424316643e7SJed Brown 425316643e7SJed Brown Notes: 426316643e7SJed Brown If F(t,X,Xdot)=0 is the DAE, the required Jacobian is 427316643e7SJed Brown 428316643e7SJed Brown dF/dX + shift*dF/dXdot 429316643e7SJed Brown 430316643e7SJed Brown Most users should not need to explicitly call this routine, as it 431316643e7SJed Brown is used internally within the nonlinear solvers. 432316643e7SJed Brown 433316643e7SJed Brown Level: developer 434316643e7SJed Brown 435316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix 436316643e7SJed Brown 437316643e7SJed Brown .seealso: TSSetIJacobian() 43863495f91SJed Brown @*/ 439214bc6a2SJed Brown PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec X,Vec Xdot,PetscReal shift,Mat *A,Mat *B,MatStructure *flg,PetscBool imex) 440316643e7SJed Brown { 4410026cea9SSean Farley PetscInt Xstate, Xdotstate; 442316643e7SJed Brown PetscErrorCode ierr; 443316643e7SJed Brown 444316643e7SJed Brown PetscFunctionBegin; 4450700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4460700a824SBarry Smith PetscValidHeaderSpecific(X,VEC_CLASSID,3); 4470700a824SBarry Smith PetscValidHeaderSpecific(Xdot,VEC_CLASSID,4); 448316643e7SJed Brown PetscValidPointer(A,6); 4490700a824SBarry Smith PetscValidHeaderSpecific(*A,MAT_CLASSID,6); 450316643e7SJed Brown PetscValidPointer(B,7); 4510700a824SBarry Smith PetscValidHeaderSpecific(*B,MAT_CLASSID,7); 452316643e7SJed Brown PetscValidPointer(flg,8); 4530026cea9SSean Farley ierr = PetscObjectStateQuery((PetscObject)X,&Xstate);CHKERRQ(ierr); 4540026cea9SSean Farley ierr = PetscObjectStateQuery((PetscObject)Xdot,&Xdotstate);CHKERRQ(ierr); 4550026cea9SSean Farley if (ts->ijacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->ijacobian.X == X && ts->ijacobian.Xstate == Xstate && ts->ijacobian.Xdot == Xdot && ts->ijacobian.Xdotstate == Xdotstate && ts->ijacobian.imex == imex))) { 4560026cea9SSean Farley *flg = ts->ijacobian.mstructure; 4570026cea9SSean Farley ierr = MatScale(*A, shift / ts->ijacobian.shift);CHKERRQ(ierr); 4580026cea9SSean Farley PetscFunctionReturn(0); 4590026cea9SSean Farley } 460316643e7SJed Brown 4613b5f76d0SSean Farley if (!ts->userops->rhsjacobian && !ts->userops->ijacobian) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 462316643e7SJed Brown 4634e684422SJed Brown *flg = SAME_NONZERO_PATTERN; /* In case we're solving a linear problem in which case it wouldn't get initialized below. */ 464316643e7SJed Brown ierr = PetscLogEventBegin(TS_JacobianEval,ts,X,*A,*B);CHKERRQ(ierr); 4653b5f76d0SSean Farley if (ts->userops->ijacobian) { 466316643e7SJed Brown PetscStackPush("TS user implicit Jacobian"); 4673b5f76d0SSean Farley ierr = (*ts->userops->ijacobian)(ts,t,X,Xdot,shift,A,B,flg,ts->jacP);CHKERRQ(ierr); 468316643e7SJed Brown PetscStackPop; 469214bc6a2SJed Brown /* make sure user returned a correct Jacobian and preconditioner */ 470214bc6a2SJed Brown PetscValidHeaderSpecific(*A,MAT_CLASSID,4); 471214bc6a2SJed Brown PetscValidHeaderSpecific(*B,MAT_CLASSID,5); 4724a6899ffSJed Brown } 473214bc6a2SJed Brown if (imex) { 4743b5f76d0SSean Farley if (!ts->userops->ijacobian) { /* system was written as Xdot = F(t,X) */ 475214bc6a2SJed Brown ierr = MatZeroEntries(*A);CHKERRQ(ierr); 476214bc6a2SJed Brown ierr = MatShift(*A,1.0);CHKERRQ(ierr); 477214bc6a2SJed Brown if (*A != *B) { 478214bc6a2SJed Brown ierr = MatZeroEntries(*B);CHKERRQ(ierr); 479214bc6a2SJed Brown ierr = MatShift(*B,shift);CHKERRQ(ierr); 480214bc6a2SJed Brown } 481214bc6a2SJed Brown *flg = SAME_PRECONDITIONER; 482214bc6a2SJed Brown } 483214bc6a2SJed Brown } else { 4843b5f76d0SSean Farley if (!ts->userops->ijacobian) { 485214bc6a2SJed Brown ierr = TSComputeRHSJacobian(ts,t,X,A,B,flg);CHKERRQ(ierr); 486214bc6a2SJed Brown ierr = MatScale(*A,-1);CHKERRQ(ierr); 487214bc6a2SJed Brown ierr = MatShift(*A,shift);CHKERRQ(ierr); 488316643e7SJed Brown if (*A != *B) { 489316643e7SJed Brown ierr = MatScale(*B,-1);CHKERRQ(ierr); 490316643e7SJed Brown ierr = MatShift(*B,shift);CHKERRQ(ierr); 491316643e7SJed Brown } 4923b5f76d0SSean Farley } else if (ts->userops->rhsjacobian) { 493214bc6a2SJed Brown Mat Arhs,Brhs; 494214bc6a2SJed Brown MatStructure axpy,flg2 = DIFFERENT_NONZERO_PATTERN; 495214bc6a2SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 496214bc6a2SJed Brown ierr = TSComputeRHSJacobian(ts,t,X,&Arhs,&Brhs,&flg2);CHKERRQ(ierr); 497214bc6a2SJed Brown axpy = (*flg == flg2) ? SAME_NONZERO_PATTERN : DIFFERENT_NONZERO_PATTERN; 498214bc6a2SJed Brown ierr = MatAXPY(*A,-1,Arhs,axpy);CHKERRQ(ierr); 499214bc6a2SJed Brown if (*A != *B) { 500214bc6a2SJed Brown ierr = MatAXPY(*B,-1,Brhs,axpy);CHKERRQ(ierr); 501214bc6a2SJed Brown } 502214bc6a2SJed Brown *flg = PetscMin(*flg,flg2); 503214bc6a2SJed Brown } 504316643e7SJed Brown } 5050026cea9SSean Farley 5060026cea9SSean Farley ts->ijacobian.time = t; 5070026cea9SSean Farley ts->ijacobian.X = X; 5080026cea9SSean Farley ts->ijacobian.Xdot = Xdot; 5090026cea9SSean Farley ierr = PetscObjectStateQuery((PetscObject)X,&ts->ijacobian.Xstate);CHKERRQ(ierr); 5100026cea9SSean Farley ierr = PetscObjectStateQuery((PetscObject)Xdot,&ts->ijacobian.Xdotstate);CHKERRQ(ierr); 5110026cea9SSean Farley ts->ijacobian.shift = shift; 5120026cea9SSean Farley ts->ijacobian.imex = imex; 5130026cea9SSean Farley ts->ijacobian.mstructure = *flg; 514316643e7SJed Brown ierr = PetscLogEventEnd(TS_JacobianEval,ts,X,*A,*B);CHKERRQ(ierr); 515316643e7SJed Brown PetscFunctionReturn(0); 516316643e7SJed Brown } 517316643e7SJed Brown 518316643e7SJed Brown #undef __FUNCT__ 5194a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction" 520d763cef2SBarry Smith /*@C 521d763cef2SBarry Smith TSSetRHSFunction - Sets the routine for evaluating the function, 522d763cef2SBarry Smith F(t,u), where U_t = F(t,u). 523d763cef2SBarry Smith 5243f9fe445SBarry Smith Logically Collective on TS 525d763cef2SBarry Smith 526d763cef2SBarry Smith Input Parameters: 527d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 528ca94891dSJed Brown . r - vector to put the computed right hand side (or PETSC_NULL to have it created) 529d763cef2SBarry Smith . f - routine for evaluating the right-hand-side function 530d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 531d763cef2SBarry Smith function evaluation routine (may be PETSC_NULL) 532d763cef2SBarry Smith 533d763cef2SBarry Smith Calling sequence of func: 53487828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Vec F,void *ctx); 535d763cef2SBarry Smith 536d763cef2SBarry Smith + t - current timestep 537d763cef2SBarry Smith . u - input vector 538d763cef2SBarry Smith . F - function vector 539d763cef2SBarry Smith - ctx - [optional] user-defined function context 540d763cef2SBarry Smith 541d763cef2SBarry Smith Important: 54276f2fa84SHong Zhang The user MUST call either this routine or TSSetMatrices(). 543d763cef2SBarry Smith 544d763cef2SBarry Smith Level: beginner 545d763cef2SBarry Smith 546d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 547d763cef2SBarry Smith 54876f2fa84SHong Zhang .seealso: TSSetMatrices() 549d763cef2SBarry Smith @*/ 550089b2837SJed Brown PetscErrorCode TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx) 551d763cef2SBarry Smith { 552089b2837SJed Brown PetscErrorCode ierr; 553089b2837SJed Brown SNES snes; 554d763cef2SBarry Smith 555089b2837SJed Brown PetscFunctionBegin; 5560700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 557ca94891dSJed Brown if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 5583b5f76d0SSean Farley if (f) ts->userops->rhsfunction = f; 5594e684422SJed Brown if (ctx) ts->funP = ctx; 560089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 561089b2837SJed Brown ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 562d763cef2SBarry Smith PetscFunctionReturn(0); 563d763cef2SBarry Smith } 564d763cef2SBarry Smith 5654a2ae208SSatish Balay #undef __FUNCT__ 5664a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian" 567d763cef2SBarry Smith /*@C 568d763cef2SBarry Smith TSSetRHSJacobian - Sets the function to compute the Jacobian of F, 569d763cef2SBarry Smith where U_t = F(U,t), as well as the location to store the matrix. 57076f2fa84SHong Zhang Use TSSetMatrices() for linear problems. 571d763cef2SBarry Smith 5723f9fe445SBarry Smith Logically Collective on TS 573d763cef2SBarry Smith 574d763cef2SBarry Smith Input Parameters: 575d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 576d763cef2SBarry Smith . A - Jacobian matrix 577d763cef2SBarry Smith . B - preconditioner matrix (usually same as A) 578d763cef2SBarry Smith . f - the Jacobian evaluation routine 579d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 580d763cef2SBarry Smith Jacobian evaluation routine (may be PETSC_NULL) 581d763cef2SBarry Smith 582d763cef2SBarry Smith Calling sequence of func: 58387828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Mat *A,Mat *B,MatStructure *flag,void *ctx); 584d763cef2SBarry Smith 585d763cef2SBarry Smith + t - current timestep 586d763cef2SBarry Smith . u - input vector 587d763cef2SBarry Smith . A - matrix A, where U_t = A(t)u 588d763cef2SBarry Smith . B - preconditioner matrix, usually the same as A 589d763cef2SBarry Smith . flag - flag indicating information about the preconditioner matrix 59094b7f48cSBarry Smith structure (same as flag in KSPSetOperators()) 591d763cef2SBarry Smith - ctx - [optional] user-defined context for matrix evaluation routine 592d763cef2SBarry Smith 593d763cef2SBarry Smith Notes: 59494b7f48cSBarry Smith See KSPSetOperators() for important information about setting the flag 595d763cef2SBarry Smith output parameter in the routine func(). Be sure to read this information! 596d763cef2SBarry Smith 597d763cef2SBarry Smith The routine func() takes Mat * as the matrix arguments rather than Mat. 598d763cef2SBarry Smith This allows the matrix evaluation routine to replace A and/or B with a 59956335db2SHong Zhang completely new matrix structure (not just different matrix elements) 600d763cef2SBarry Smith when appropriate, for instance, if the nonzero structure is changing 601d763cef2SBarry Smith throughout the global iterations. 602d763cef2SBarry Smith 603d763cef2SBarry Smith Level: beginner 604d763cef2SBarry Smith 605d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian 606d763cef2SBarry Smith 607d763cef2SBarry Smith .seealso: TSDefaultComputeJacobianColor(), 60876f2fa84SHong Zhang SNESDefaultComputeJacobianColor(), TSSetRHSFunction(), TSSetMatrices() 609d763cef2SBarry Smith 610d763cef2SBarry Smith @*/ 611089b2837SJed Brown PetscErrorCode TSSetRHSJacobian(TS ts,Mat A,Mat B,TSRHSJacobian f,void *ctx) 612d763cef2SBarry Smith { 613277b19d0SLisandro Dalcin PetscErrorCode ierr; 614089b2837SJed Brown SNES snes; 615277b19d0SLisandro Dalcin 616d763cef2SBarry Smith PetscFunctionBegin; 6170700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 618277b19d0SLisandro Dalcin if (A) PetscValidHeaderSpecific(A,MAT_CLASSID,2); 619277b19d0SLisandro Dalcin if (B) PetscValidHeaderSpecific(B,MAT_CLASSID,3); 620277b19d0SLisandro Dalcin if (A) PetscCheckSameComm(ts,1,A,2); 621277b19d0SLisandro Dalcin if (B) PetscCheckSameComm(ts,1,B,3); 622d763cef2SBarry Smith 6233b5f76d0SSean Farley if (f) ts->userops->rhsjacobian = f; 624277b19d0SLisandro Dalcin if (ctx) ts->jacP = ctx; 625089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 626dabe61deSJed Brown if (!ts->userops->ijacobian) { 627089b2837SJed Brown ierr = SNESSetJacobian(snes,A,B,SNESTSFormJacobian,ts);CHKERRQ(ierr); 6280e4ef248SJed Brown } 6290e4ef248SJed Brown if (A) { 6300e4ef248SJed Brown ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr); 6310e4ef248SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 6320e4ef248SJed Brown ts->Arhs = A; 6330e4ef248SJed Brown } 6340e4ef248SJed Brown if (B) { 6350e4ef248SJed Brown ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr); 6360e4ef248SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 6370e4ef248SJed Brown ts->Brhs = B; 6380e4ef248SJed Brown } 639d763cef2SBarry Smith PetscFunctionReturn(0); 640d763cef2SBarry Smith } 641d763cef2SBarry Smith 642316643e7SJed Brown 643316643e7SJed Brown #undef __FUNCT__ 644316643e7SJed Brown #define __FUNCT__ "TSSetIFunction" 645316643e7SJed Brown /*@C 646316643e7SJed Brown TSSetIFunction - Set the function to compute F(t,U,U_t) where F = 0 is the DAE to be solved. 647316643e7SJed Brown 6483f9fe445SBarry Smith Logically Collective on TS 649316643e7SJed Brown 650316643e7SJed Brown Input Parameters: 651316643e7SJed Brown + ts - the TS context obtained from TSCreate() 652ca94891dSJed Brown . r - vector to hold the residual (or PETSC_NULL to have it created internally) 653316643e7SJed Brown . f - the function evaluation routine 654316643e7SJed Brown - ctx - user-defined context for private data for the function evaluation routine (may be PETSC_NULL) 655316643e7SJed Brown 656316643e7SJed Brown Calling sequence of f: 657316643e7SJed Brown $ f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx); 658316643e7SJed Brown 659316643e7SJed Brown + t - time at step/stage being solved 660316643e7SJed Brown . u - state vector 661316643e7SJed Brown . u_t - time derivative of state vector 662316643e7SJed Brown . F - function vector 663316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 664316643e7SJed Brown 665316643e7SJed Brown Important: 666316643e7SJed Brown The user MUST call either this routine, TSSetRHSFunction(), or TSSetMatrices(). This routine must be used when not solving an ODE. 667316643e7SJed Brown 668316643e7SJed Brown Level: beginner 669316643e7SJed Brown 670316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian 671316643e7SJed Brown 672316643e7SJed Brown .seealso: TSSetMatrices(), TSSetRHSFunction(), TSSetIJacobian() 673316643e7SJed Brown @*/ 674089b2837SJed Brown PetscErrorCode TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx) 675316643e7SJed Brown { 676089b2837SJed Brown PetscErrorCode ierr; 677089b2837SJed Brown SNES snes; 678316643e7SJed Brown 679316643e7SJed Brown PetscFunctionBegin; 6800700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 681ca94891dSJed Brown if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2); 6823b5f76d0SSean Farley if (f) ts->userops->ifunction = f; 683089b2837SJed Brown if (ctx) ts->funP = ctx; 684089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 685089b2837SJed Brown ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr); 686089b2837SJed Brown PetscFunctionReturn(0); 687089b2837SJed Brown } 688089b2837SJed Brown 689089b2837SJed Brown #undef __FUNCT__ 690089b2837SJed Brown #define __FUNCT__ "TSGetIFunction" 691089b2837SJed Brown /*@C 692089b2837SJed Brown TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it. 693089b2837SJed Brown 694089b2837SJed Brown Not Collective 695089b2837SJed Brown 696089b2837SJed Brown Input Parameter: 697089b2837SJed Brown . ts - the TS context 698089b2837SJed Brown 699089b2837SJed Brown Output Parameter: 700089b2837SJed Brown + r - vector to hold residual (or PETSC_NULL) 701089b2837SJed Brown . func - the function to compute residual (or PETSC_NULL) 702089b2837SJed Brown - ctx - the function context (or PETSC_NULL) 703089b2837SJed Brown 704089b2837SJed Brown Level: advanced 705089b2837SJed Brown 706089b2837SJed Brown .keywords: TS, nonlinear, get, function 707089b2837SJed Brown 708089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction() 709089b2837SJed Brown @*/ 710089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx) 711089b2837SJed Brown { 712089b2837SJed Brown PetscErrorCode ierr; 713089b2837SJed Brown SNES snes; 714089b2837SJed Brown 715089b2837SJed Brown PetscFunctionBegin; 716089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 717089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 718089b2837SJed Brown ierr = SNESGetFunction(snes,r,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 7193b5f76d0SSean Farley if (func) *func = ts->userops->ifunction; 720089b2837SJed Brown if (ctx) *ctx = ts->funP; 721089b2837SJed Brown PetscFunctionReturn(0); 722089b2837SJed Brown } 723089b2837SJed Brown 724089b2837SJed Brown #undef __FUNCT__ 725089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction" 726089b2837SJed Brown /*@C 727089b2837SJed Brown TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it. 728089b2837SJed Brown 729089b2837SJed Brown Not Collective 730089b2837SJed Brown 731089b2837SJed Brown Input Parameter: 732089b2837SJed Brown . ts - the TS context 733089b2837SJed Brown 734089b2837SJed Brown Output Parameter: 735089b2837SJed Brown + r - vector to hold computed right hand side (or PETSC_NULL) 736089b2837SJed Brown . func - the function to compute right hand side (or PETSC_NULL) 737089b2837SJed Brown - ctx - the function context (or PETSC_NULL) 738089b2837SJed Brown 739089b2837SJed Brown Level: advanced 740089b2837SJed Brown 741089b2837SJed Brown .keywords: TS, nonlinear, get, function 742089b2837SJed Brown 743089b2837SJed Brown .seealso: TSSetRhsfunction(), SNESGetFunction() 744089b2837SJed Brown @*/ 745089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx) 746089b2837SJed Brown { 747089b2837SJed Brown PetscErrorCode ierr; 748089b2837SJed Brown SNES snes; 749089b2837SJed Brown 750089b2837SJed Brown PetscFunctionBegin; 751089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 752089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 753089b2837SJed Brown ierr = SNESGetFunction(snes,r,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 7543b5f76d0SSean Farley if (func) *func = ts->userops->rhsfunction; 755089b2837SJed Brown if (ctx) *ctx = ts->funP; 756316643e7SJed Brown PetscFunctionReturn(0); 757316643e7SJed Brown } 758316643e7SJed Brown 759316643e7SJed Brown #undef __FUNCT__ 760316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian" 761316643e7SJed Brown /*@C 762a4f0a591SBarry Smith TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function 763a4f0a591SBarry Smith you provided with TSSetIFunction(). 764316643e7SJed Brown 7653f9fe445SBarry Smith Logically Collective on TS 766316643e7SJed Brown 767316643e7SJed Brown Input Parameters: 768316643e7SJed Brown + ts - the TS context obtained from TSCreate() 769316643e7SJed Brown . A - Jacobian matrix 770316643e7SJed Brown . B - preconditioning matrix for A (may be same as A) 771316643e7SJed Brown . f - the Jacobian evaluation routine 772316643e7SJed Brown - ctx - user-defined context for private data for the Jacobian evaluation routine (may be PETSC_NULL) 773316643e7SJed Brown 774316643e7SJed Brown Calling sequence of f: 7751b4a444bSJed Brown $ f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat *A,Mat *B,MatStructure *flag,void *ctx); 776316643e7SJed Brown 777316643e7SJed Brown + t - time at step/stage being solved 7781b4a444bSJed Brown . U - state vector 7791b4a444bSJed Brown . U_t - time derivative of state vector 780316643e7SJed Brown . a - shift 7811b4a444bSJed Brown . A - Jacobian of G(U) = F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t 782316643e7SJed Brown . B - preconditioning matrix for A, may be same as A 783316643e7SJed Brown . flag - flag indicating information about the preconditioner matrix 784316643e7SJed Brown structure (same as flag in KSPSetOperators()) 785316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 786316643e7SJed Brown 787316643e7SJed Brown Notes: 788316643e7SJed Brown The matrices A and B are exactly the matrices that are used by SNES for the nonlinear solve. 789316643e7SJed Brown 790a4f0a591SBarry Smith The matrix dF/dU + a*dF/dU_t you provide turns out to be 791a4f0a591SBarry Smith the Jacobian of G(U) = F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved. 792a4f0a591SBarry Smith The time integrator internally approximates U_t by W+a*U where the positive "shift" 793a4f0a591SBarry Smith a and vector W depend on the integration method, step size, and past states. For example with 794a4f0a591SBarry Smith the backward Euler method a = 1/dt and W = -a*U(previous timestep) so 795a4f0a591SBarry Smith W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt 796a4f0a591SBarry Smith 797316643e7SJed Brown Level: beginner 798316643e7SJed Brown 799316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian 800316643e7SJed Brown 801316643e7SJed Brown .seealso: TSSetIFunction(), TSSetRHSJacobian() 802316643e7SJed Brown 803316643e7SJed Brown @*/ 8047087cfbeSBarry Smith PetscErrorCode TSSetIJacobian(TS ts,Mat A,Mat B,TSIJacobian f,void *ctx) 805316643e7SJed Brown { 806316643e7SJed Brown PetscErrorCode ierr; 807089b2837SJed Brown SNES snes; 808316643e7SJed Brown 809316643e7SJed Brown PetscFunctionBegin; 8100700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 8110700a824SBarry Smith if (A) PetscValidHeaderSpecific(A,MAT_CLASSID,2); 8120700a824SBarry Smith if (B) PetscValidHeaderSpecific(B,MAT_CLASSID,3); 813316643e7SJed Brown if (A) PetscCheckSameComm(ts,1,A,2); 814316643e7SJed Brown if (B) PetscCheckSameComm(ts,1,B,3); 8153b5f76d0SSean Farley if (f) ts->userops->ijacobian = f; 816316643e7SJed Brown if (ctx) ts->jacP = ctx; 817089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 818089b2837SJed Brown ierr = SNESSetJacobian(snes,A,B,SNESTSFormJacobian,ts);CHKERRQ(ierr); 819316643e7SJed Brown PetscFunctionReturn(0); 820316643e7SJed Brown } 821316643e7SJed Brown 8224a2ae208SSatish Balay #undef __FUNCT__ 8234a2ae208SSatish Balay #define __FUNCT__ "TSView" 8247e2c5f70SBarry Smith /*@C 825d763cef2SBarry Smith TSView - Prints the TS data structure. 826d763cef2SBarry Smith 8274c49b128SBarry Smith Collective on TS 828d763cef2SBarry Smith 829d763cef2SBarry Smith Input Parameters: 830d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 831d763cef2SBarry Smith - viewer - visualization context 832d763cef2SBarry Smith 833d763cef2SBarry Smith Options Database Key: 834d763cef2SBarry Smith . -ts_view - calls TSView() at end of TSStep() 835d763cef2SBarry Smith 836d763cef2SBarry Smith Notes: 837d763cef2SBarry Smith The available visualization contexts include 838b0a32e0cSBarry Smith + PETSC_VIEWER_STDOUT_SELF - standard output (default) 839b0a32e0cSBarry Smith - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 840d763cef2SBarry Smith output where only the first processor opens 841d763cef2SBarry Smith the file. All other processors send their 842d763cef2SBarry Smith data to the first processor to print. 843d763cef2SBarry Smith 844d763cef2SBarry Smith The user can open an alternative visualization context with 845b0a32e0cSBarry Smith PetscViewerASCIIOpen() - output to a specified file. 846d763cef2SBarry Smith 847d763cef2SBarry Smith Level: beginner 848d763cef2SBarry Smith 849d763cef2SBarry Smith .keywords: TS, timestep, view 850d763cef2SBarry Smith 851b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen() 852d763cef2SBarry Smith @*/ 8537087cfbeSBarry Smith PetscErrorCode TSView(TS ts,PetscViewer viewer) 854d763cef2SBarry Smith { 855dfbe8321SBarry Smith PetscErrorCode ierr; 856a313700dSBarry Smith const TSType type; 857089b2837SJed Brown PetscBool iascii,isstring,isundials; 858d763cef2SBarry Smith 859d763cef2SBarry Smith PetscFunctionBegin; 8600700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 8613050cee2SBarry Smith if (!viewer) { 8627adad957SLisandro Dalcin ierr = PetscViewerASCIIGetStdout(((PetscObject)ts)->comm,&viewer);CHKERRQ(ierr); 8633050cee2SBarry Smith } 8640700a824SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 865c9780b6fSBarry Smith PetscCheckSameComm(ts,1,viewer,2); 866fd16b177SBarry Smith 8672692d6eeSBarry Smith ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 8682692d6eeSBarry Smith ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 86932077d6dSBarry Smith if (iascii) { 870317d6ea6SBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer,"TS Object");CHKERRQ(ierr); 871000e7ae3SMatthew Knepley if (ts->ops->view) { 872b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 873000e7ae3SMatthew Knepley ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 874b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 875d763cef2SBarry Smith } 87677431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr); 877a83599f4SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum time=%G\n",ts->max_time);CHKERRQ(ierr); 878d763cef2SBarry Smith if (ts->problem_type == TS_NONLINEAR) { 87977431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solver iterations=%D\n",ts->nonlinear_its);CHKERRQ(ierr); 880193ac0bcSJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solve failures=%D\n",ts->max_snes_failures);CHKERRQ(ierr); 881d763cef2SBarry Smith } 88277431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",ts->linear_its);CHKERRQ(ierr); 883193ac0bcSJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr); 8840f5bd95cSBarry Smith } else if (isstring) { 885a313700dSBarry Smith ierr = TSGetType(ts,&type);CHKERRQ(ierr); 886b0a32e0cSBarry Smith ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr); 887d763cef2SBarry Smith } 888b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 889089b2837SJed Brown ierr = PetscTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr); 890089b2837SJed Brown if (!isundials && ts->snes) {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);} 891b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 892d763cef2SBarry Smith PetscFunctionReturn(0); 893d763cef2SBarry Smith } 894d763cef2SBarry Smith 895d763cef2SBarry Smith 8964a2ae208SSatish Balay #undef __FUNCT__ 8974a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext" 898b07ff414SBarry Smith /*@ 899d763cef2SBarry Smith TSSetApplicationContext - Sets an optional user-defined context for 900d763cef2SBarry Smith the timesteppers. 901d763cef2SBarry Smith 9023f9fe445SBarry Smith Logically Collective on TS 903d763cef2SBarry Smith 904d763cef2SBarry Smith Input Parameters: 905d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 906d763cef2SBarry Smith - usrP - optional user context 907d763cef2SBarry Smith 908d763cef2SBarry Smith Level: intermediate 909d763cef2SBarry Smith 910d763cef2SBarry Smith .keywords: TS, timestep, set, application, context 911d763cef2SBarry Smith 912d763cef2SBarry Smith .seealso: TSGetApplicationContext() 913d763cef2SBarry Smith @*/ 9147087cfbeSBarry Smith PetscErrorCode TSSetApplicationContext(TS ts,void *usrP) 915d763cef2SBarry Smith { 916d763cef2SBarry Smith PetscFunctionBegin; 9170700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 918d763cef2SBarry Smith ts->user = usrP; 919d763cef2SBarry Smith PetscFunctionReturn(0); 920d763cef2SBarry Smith } 921d763cef2SBarry Smith 9224a2ae208SSatish Balay #undef __FUNCT__ 9234a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext" 924b07ff414SBarry Smith /*@ 925d763cef2SBarry Smith TSGetApplicationContext - Gets the user-defined context for the 926d763cef2SBarry Smith timestepper. 927d763cef2SBarry Smith 928d763cef2SBarry Smith Not Collective 929d763cef2SBarry Smith 930d763cef2SBarry Smith Input Parameter: 931d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 932d763cef2SBarry Smith 933d763cef2SBarry Smith Output Parameter: 934d763cef2SBarry Smith . usrP - user context 935d763cef2SBarry Smith 936d763cef2SBarry Smith Level: intermediate 937d763cef2SBarry Smith 938d763cef2SBarry Smith .keywords: TS, timestep, get, application, context 939d763cef2SBarry Smith 940d763cef2SBarry Smith .seealso: TSSetApplicationContext() 941d763cef2SBarry Smith @*/ 942e71120c6SJed Brown PetscErrorCode TSGetApplicationContext(TS ts,void *usrP) 943d763cef2SBarry Smith { 944d763cef2SBarry Smith PetscFunctionBegin; 9450700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 946e71120c6SJed Brown *(void**)usrP = ts->user; 947d763cef2SBarry Smith PetscFunctionReturn(0); 948d763cef2SBarry Smith } 949d763cef2SBarry Smith 9504a2ae208SSatish Balay #undef __FUNCT__ 9514a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber" 952d763cef2SBarry Smith /*@ 953d763cef2SBarry Smith TSGetTimeStepNumber - Gets the current number of timesteps. 954d763cef2SBarry Smith 955d763cef2SBarry Smith Not Collective 956d763cef2SBarry Smith 957d763cef2SBarry Smith Input Parameter: 958d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 959d763cef2SBarry Smith 960d763cef2SBarry Smith Output Parameter: 961d763cef2SBarry Smith . iter - number steps so far 962d763cef2SBarry Smith 963d763cef2SBarry Smith Level: intermediate 964d763cef2SBarry Smith 965d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number 966d763cef2SBarry Smith @*/ 9677087cfbeSBarry Smith PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt* iter) 968d763cef2SBarry Smith { 969d763cef2SBarry Smith PetscFunctionBegin; 9700700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 9714482741eSBarry Smith PetscValidIntPointer(iter,2); 972d763cef2SBarry Smith *iter = ts->steps; 973d763cef2SBarry Smith PetscFunctionReturn(0); 974d763cef2SBarry Smith } 975d763cef2SBarry Smith 9764a2ae208SSatish Balay #undef __FUNCT__ 9774a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep" 978d763cef2SBarry Smith /*@ 979d763cef2SBarry Smith TSSetInitialTimeStep - Sets the initial timestep to be used, 980d763cef2SBarry Smith as well as the initial time. 981d763cef2SBarry Smith 9823f9fe445SBarry Smith Logically Collective on TS 983d763cef2SBarry Smith 984d763cef2SBarry Smith Input Parameters: 985d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 986d763cef2SBarry Smith . initial_time - the initial time 987d763cef2SBarry Smith - time_step - the size of the timestep 988d763cef2SBarry Smith 989d763cef2SBarry Smith Level: intermediate 990d763cef2SBarry Smith 991d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep() 992d763cef2SBarry Smith 993d763cef2SBarry Smith .keywords: TS, set, initial, timestep 994d763cef2SBarry Smith @*/ 9957087cfbeSBarry Smith PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step) 996d763cef2SBarry Smith { 997e144a568SJed Brown PetscErrorCode ierr; 998e144a568SJed Brown 999d763cef2SBarry Smith PetscFunctionBegin; 10000700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1001e144a568SJed Brown ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 1002d763cef2SBarry Smith ts->initial_time_step = time_step; 1003d763cef2SBarry Smith ts->ptime = initial_time; 1004d763cef2SBarry Smith PetscFunctionReturn(0); 1005d763cef2SBarry Smith } 1006d763cef2SBarry Smith 10074a2ae208SSatish Balay #undef __FUNCT__ 10084a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep" 1009d763cef2SBarry Smith /*@ 1010d763cef2SBarry Smith TSSetTimeStep - Allows one to reset the timestep at any time, 1011d763cef2SBarry Smith useful for simple pseudo-timestepping codes. 1012d763cef2SBarry Smith 10133f9fe445SBarry Smith Logically Collective on TS 1014d763cef2SBarry Smith 1015d763cef2SBarry Smith Input Parameters: 1016d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1017d763cef2SBarry Smith - time_step - the size of the timestep 1018d763cef2SBarry Smith 1019d763cef2SBarry Smith Level: intermediate 1020d763cef2SBarry Smith 1021d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1022d763cef2SBarry Smith 1023d763cef2SBarry Smith .keywords: TS, set, timestep 1024d763cef2SBarry Smith @*/ 10257087cfbeSBarry Smith PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step) 1026d763cef2SBarry Smith { 1027d763cef2SBarry Smith PetscFunctionBegin; 10280700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1029c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,time_step,2); 1030d763cef2SBarry Smith ts->time_step = time_step; 1031193ac0bcSJed Brown ts->next_time_step = time_step; 1032d763cef2SBarry Smith PetscFunctionReturn(0); 1033d763cef2SBarry Smith } 1034d763cef2SBarry Smith 10354a2ae208SSatish Balay #undef __FUNCT__ 10364a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep" 1037d763cef2SBarry Smith /*@ 1038d763cef2SBarry Smith TSGetTimeStep - Gets the current timestep size. 1039d763cef2SBarry Smith 1040d763cef2SBarry Smith Not Collective 1041d763cef2SBarry Smith 1042d763cef2SBarry Smith Input Parameter: 1043d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1044d763cef2SBarry Smith 1045d763cef2SBarry Smith Output Parameter: 1046d763cef2SBarry Smith . dt - the current timestep size 1047d763cef2SBarry Smith 1048d763cef2SBarry Smith Level: intermediate 1049d763cef2SBarry Smith 1050d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1051d763cef2SBarry Smith 1052d763cef2SBarry Smith .keywords: TS, get, timestep 1053d763cef2SBarry Smith @*/ 10547087cfbeSBarry Smith PetscErrorCode TSGetTimeStep(TS ts,PetscReal* dt) 1055d763cef2SBarry Smith { 1056d763cef2SBarry Smith PetscFunctionBegin; 10570700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 10584482741eSBarry Smith PetscValidDoublePointer(dt,2); 1059d763cef2SBarry Smith *dt = ts->time_step; 1060d763cef2SBarry Smith PetscFunctionReturn(0); 1061d763cef2SBarry Smith } 1062d763cef2SBarry Smith 10634a2ae208SSatish Balay #undef __FUNCT__ 10644a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution" 1065d8e5e3e6SSatish Balay /*@ 1066d763cef2SBarry Smith TSGetSolution - Returns the solution at the present timestep. It 1067d763cef2SBarry Smith is valid to call this routine inside the function that you are evaluating 1068d763cef2SBarry Smith in order to move to the new timestep. This vector not changed until 1069d763cef2SBarry Smith the solution at the next timestep has been calculated. 1070d763cef2SBarry Smith 1071d763cef2SBarry Smith Not Collective, but Vec returned is parallel if TS is parallel 1072d763cef2SBarry Smith 1073d763cef2SBarry Smith Input Parameter: 1074d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1075d763cef2SBarry Smith 1076d763cef2SBarry Smith Output Parameter: 1077d763cef2SBarry Smith . v - the vector containing the solution 1078d763cef2SBarry Smith 1079d763cef2SBarry Smith Level: intermediate 1080d763cef2SBarry Smith 1081d763cef2SBarry Smith .seealso: TSGetTimeStep() 1082d763cef2SBarry Smith 1083d763cef2SBarry Smith .keywords: TS, timestep, get, solution 1084d763cef2SBarry Smith @*/ 10857087cfbeSBarry Smith PetscErrorCode TSGetSolution(TS ts,Vec *v) 1086d763cef2SBarry Smith { 1087d763cef2SBarry Smith PetscFunctionBegin; 10880700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 10894482741eSBarry Smith PetscValidPointer(v,2); 10908737fe31SLisandro Dalcin *v = ts->vec_sol; 1091d763cef2SBarry Smith PetscFunctionReturn(0); 1092d763cef2SBarry Smith } 1093d763cef2SBarry Smith 1094bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */ 10954a2ae208SSatish Balay #undef __FUNCT__ 1096bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType" 1097d8e5e3e6SSatish Balay /*@ 1098bdad233fSMatthew Knepley TSSetProblemType - Sets the type of problem to be solved. 1099d763cef2SBarry Smith 1100bdad233fSMatthew Knepley Not collective 1101d763cef2SBarry Smith 1102bdad233fSMatthew Knepley Input Parameters: 1103bdad233fSMatthew Knepley + ts - The TS 1104bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 1105d763cef2SBarry Smith .vb 1106d763cef2SBarry Smith U_t = A U 1107d763cef2SBarry Smith U_t = A(t) U 1108d763cef2SBarry Smith U_t = F(t,U) 1109d763cef2SBarry Smith .ve 1110d763cef2SBarry Smith 1111d763cef2SBarry Smith Level: beginner 1112d763cef2SBarry Smith 1113bdad233fSMatthew Knepley .keywords: TS, problem type 1114bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 1115d763cef2SBarry Smith @*/ 11167087cfbeSBarry Smith PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 1117a7cc72afSBarry Smith { 11189e2a6581SJed Brown PetscErrorCode ierr; 11199e2a6581SJed Brown 1120d763cef2SBarry Smith PetscFunctionBegin; 11210700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1122bdad233fSMatthew Knepley ts->problem_type = type; 11239e2a6581SJed Brown if (type == TS_LINEAR) { 11249e2a6581SJed Brown SNES snes; 11259e2a6581SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 11269e2a6581SJed Brown ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr); 11279e2a6581SJed Brown } 1128d763cef2SBarry Smith PetscFunctionReturn(0); 1129d763cef2SBarry Smith } 1130d763cef2SBarry Smith 1131bdad233fSMatthew Knepley #undef __FUNCT__ 1132bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType" 1133bdad233fSMatthew Knepley /*@C 1134bdad233fSMatthew Knepley TSGetProblemType - Gets the type of problem to be solved. 1135bdad233fSMatthew Knepley 1136bdad233fSMatthew Knepley Not collective 1137bdad233fSMatthew Knepley 1138bdad233fSMatthew Knepley Input Parameter: 1139bdad233fSMatthew Knepley . ts - The TS 1140bdad233fSMatthew Knepley 1141bdad233fSMatthew Knepley Output Parameter: 1142bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 1143bdad233fSMatthew Knepley .vb 1144089b2837SJed Brown M U_t = A U 1145089b2837SJed Brown M(t) U_t = A(t) U 1146bdad233fSMatthew Knepley U_t = F(t,U) 1147bdad233fSMatthew Knepley .ve 1148bdad233fSMatthew Knepley 1149bdad233fSMatthew Knepley Level: beginner 1150bdad233fSMatthew Knepley 1151bdad233fSMatthew Knepley .keywords: TS, problem type 1152bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 1153bdad233fSMatthew Knepley @*/ 11547087cfbeSBarry Smith PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 1155a7cc72afSBarry Smith { 1156bdad233fSMatthew Knepley PetscFunctionBegin; 11570700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 11584482741eSBarry Smith PetscValidIntPointer(type,2); 1159bdad233fSMatthew Knepley *type = ts->problem_type; 1160bdad233fSMatthew Knepley PetscFunctionReturn(0); 1161bdad233fSMatthew Knepley } 1162d763cef2SBarry Smith 11634a2ae208SSatish Balay #undef __FUNCT__ 11644a2ae208SSatish Balay #define __FUNCT__ "TSSetUp" 1165d763cef2SBarry Smith /*@ 1166d763cef2SBarry Smith TSSetUp - Sets up the internal data structures for the later use 1167d763cef2SBarry Smith of a timestepper. 1168d763cef2SBarry Smith 1169d763cef2SBarry Smith Collective on TS 1170d763cef2SBarry Smith 1171d763cef2SBarry Smith Input Parameter: 1172d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1173d763cef2SBarry Smith 1174d763cef2SBarry Smith Notes: 1175d763cef2SBarry Smith For basic use of the TS solvers the user need not explicitly call 1176d763cef2SBarry Smith TSSetUp(), since these actions will automatically occur during 1177d763cef2SBarry Smith the call to TSStep(). However, if one wishes to control this 1178d763cef2SBarry Smith phase separately, TSSetUp() should be called after TSCreate() 1179d763cef2SBarry Smith and optional routines of the form TSSetXXX(), but before TSStep(). 1180d763cef2SBarry Smith 1181d763cef2SBarry Smith Level: advanced 1182d763cef2SBarry Smith 1183d763cef2SBarry Smith .keywords: TS, timestep, setup 1184d763cef2SBarry Smith 1185d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy() 1186d763cef2SBarry Smith @*/ 11877087cfbeSBarry Smith PetscErrorCode TSSetUp(TS ts) 1188d763cef2SBarry Smith { 1189dfbe8321SBarry Smith PetscErrorCode ierr; 1190d763cef2SBarry Smith 1191d763cef2SBarry Smith PetscFunctionBegin; 11920700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1193277b19d0SLisandro Dalcin if (ts->setupcalled) PetscFunctionReturn(0); 1194277b19d0SLisandro Dalcin 11957adad957SLisandro Dalcin if (!((PetscObject)ts)->type_name) { 11969596e0b4SJed Brown ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr); 1197d763cef2SBarry Smith } 1198277b19d0SLisandro Dalcin 1199277b19d0SLisandro Dalcin if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first"); 1200277b19d0SLisandro Dalcin 1201277b19d0SLisandro Dalcin if (ts->ops->setup) { 1202000e7ae3SMatthew Knepley ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr); 1203277b19d0SLisandro Dalcin } 1204277b19d0SLisandro Dalcin 1205277b19d0SLisandro Dalcin ts->setupcalled = PETSC_TRUE; 1206277b19d0SLisandro Dalcin PetscFunctionReturn(0); 1207277b19d0SLisandro Dalcin } 1208277b19d0SLisandro Dalcin 1209277b19d0SLisandro Dalcin #undef __FUNCT__ 1210277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset" 1211277b19d0SLisandro Dalcin /*@ 1212277b19d0SLisandro Dalcin TSReset - Resets a TS context and removes any allocated Vecs and Mats. 1213277b19d0SLisandro Dalcin 1214277b19d0SLisandro Dalcin Collective on TS 1215277b19d0SLisandro Dalcin 1216277b19d0SLisandro Dalcin Input Parameter: 1217277b19d0SLisandro Dalcin . ts - the TS context obtained from TSCreate() 1218277b19d0SLisandro Dalcin 1219277b19d0SLisandro Dalcin Level: beginner 1220277b19d0SLisandro Dalcin 1221277b19d0SLisandro Dalcin .keywords: TS, timestep, reset 1222277b19d0SLisandro Dalcin 1223277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy() 1224277b19d0SLisandro Dalcin @*/ 1225277b19d0SLisandro Dalcin PetscErrorCode TSReset(TS ts) 1226277b19d0SLisandro Dalcin { 1227277b19d0SLisandro Dalcin PetscErrorCode ierr; 1228277b19d0SLisandro Dalcin 1229277b19d0SLisandro Dalcin PetscFunctionBegin; 1230277b19d0SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1231277b19d0SLisandro Dalcin if (ts->ops->reset) { 1232277b19d0SLisandro Dalcin ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr); 1233277b19d0SLisandro Dalcin } 1234277b19d0SLisandro Dalcin if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);} 12354e684422SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 12364e684422SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1237214bc6a2SJed Brown ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr); 12386bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 1239277b19d0SLisandro Dalcin if (ts->work) {ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);} 1240277b19d0SLisandro Dalcin ts->setupcalled = PETSC_FALSE; 1241d763cef2SBarry Smith PetscFunctionReturn(0); 1242d763cef2SBarry Smith } 1243d763cef2SBarry Smith 12444a2ae208SSatish Balay #undef __FUNCT__ 12454a2ae208SSatish Balay #define __FUNCT__ "TSDestroy" 1246d8e5e3e6SSatish Balay /*@ 1247d763cef2SBarry Smith TSDestroy - Destroys the timestepper context that was created 1248d763cef2SBarry Smith with TSCreate(). 1249d763cef2SBarry Smith 1250d763cef2SBarry Smith Collective on TS 1251d763cef2SBarry Smith 1252d763cef2SBarry Smith Input Parameter: 1253d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1254d763cef2SBarry Smith 1255d763cef2SBarry Smith Level: beginner 1256d763cef2SBarry Smith 1257d763cef2SBarry Smith .keywords: TS, timestepper, destroy 1258d763cef2SBarry Smith 1259d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve() 1260d763cef2SBarry Smith @*/ 12616bf464f9SBarry Smith PetscErrorCode TSDestroy(TS *ts) 1262d763cef2SBarry Smith { 12636849ba73SBarry Smith PetscErrorCode ierr; 1264d763cef2SBarry Smith 1265d763cef2SBarry Smith PetscFunctionBegin; 12666bf464f9SBarry Smith if (!*ts) PetscFunctionReturn(0); 12676bf464f9SBarry Smith PetscValidHeaderSpecific((*ts),TS_CLASSID,1); 12686bf464f9SBarry Smith if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);} 1269d763cef2SBarry Smith 12706bf464f9SBarry Smith ierr = TSReset((*ts));CHKERRQ(ierr); 1271277b19d0SLisandro Dalcin 1272be0abb6dSBarry Smith /* if memory was published with AMS then destroy it */ 12736bf464f9SBarry Smith ierr = PetscObjectDepublish((*ts));CHKERRQ(ierr); 12746bf464f9SBarry Smith if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);} 12756d4c513bSLisandro Dalcin 12766bf464f9SBarry Smith ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr); 12776bf464f9SBarry Smith ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr); 12786bf464f9SBarry Smith ierr = TSMonitorCancel((*ts));CHKERRQ(ierr); 12796d4c513bSLisandro Dalcin 12803b5f76d0SSean Farley ierr = PetscFree((*ts)->userops); 12813b5f76d0SSean Farley 1282a79aaaedSSatish Balay ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr); 1283d763cef2SBarry Smith PetscFunctionReturn(0); 1284d763cef2SBarry Smith } 1285d763cef2SBarry Smith 12864a2ae208SSatish Balay #undef __FUNCT__ 12874a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES" 1288d8e5e3e6SSatish Balay /*@ 1289d763cef2SBarry Smith TSGetSNES - Returns the SNES (nonlinear solver) associated with 1290d763cef2SBarry Smith a TS (timestepper) context. Valid only for nonlinear problems. 1291d763cef2SBarry Smith 1292d763cef2SBarry Smith Not Collective, but SNES is parallel if TS is parallel 1293d763cef2SBarry Smith 1294d763cef2SBarry Smith Input Parameter: 1295d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1296d763cef2SBarry Smith 1297d763cef2SBarry Smith Output Parameter: 1298d763cef2SBarry Smith . snes - the nonlinear solver context 1299d763cef2SBarry Smith 1300d763cef2SBarry Smith Notes: 1301d763cef2SBarry Smith The user can then directly manipulate the SNES context to set various 1302d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 130394b7f48cSBarry Smith KSP, KSP, and PC contexts as well. 1304d763cef2SBarry Smith 1305d763cef2SBarry Smith TSGetSNES() does not work for integrators that do not use SNES; in 1306d763cef2SBarry Smith this case TSGetSNES() returns PETSC_NULL in snes. 1307d763cef2SBarry Smith 1308d763cef2SBarry Smith Level: beginner 1309d763cef2SBarry Smith 1310d763cef2SBarry Smith .keywords: timestep, get, SNES 1311d763cef2SBarry Smith @*/ 13127087cfbeSBarry Smith PetscErrorCode TSGetSNES(TS ts,SNES *snes) 1313d763cef2SBarry Smith { 1314d372ba47SLisandro Dalcin PetscErrorCode ierr; 1315d372ba47SLisandro Dalcin 1316d763cef2SBarry Smith PetscFunctionBegin; 13170700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 13184482741eSBarry Smith PetscValidPointer(snes,2); 1319d372ba47SLisandro Dalcin if (!ts->snes) { 1320d372ba47SLisandro Dalcin ierr = SNESCreate(((PetscObject)ts)->comm,&ts->snes);CHKERRQ(ierr); 1321d372ba47SLisandro Dalcin ierr = PetscLogObjectParent(ts,ts->snes);CHKERRQ(ierr); 1322d372ba47SLisandro Dalcin ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr); 13239e2a6581SJed Brown if (ts->problem_type == TS_LINEAR) { 13249e2a6581SJed Brown ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); 13259e2a6581SJed Brown } 1326d372ba47SLisandro Dalcin } 1327d763cef2SBarry Smith *snes = ts->snes; 1328d763cef2SBarry Smith PetscFunctionReturn(0); 1329d763cef2SBarry Smith } 1330d763cef2SBarry Smith 13314a2ae208SSatish Balay #undef __FUNCT__ 133294b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP" 1333d8e5e3e6SSatish Balay /*@ 133494b7f48cSBarry Smith TSGetKSP - Returns the KSP (linear solver) associated with 1335d763cef2SBarry Smith a TS (timestepper) context. 1336d763cef2SBarry Smith 133794b7f48cSBarry Smith Not Collective, but KSP is parallel if TS is parallel 1338d763cef2SBarry Smith 1339d763cef2SBarry Smith Input Parameter: 1340d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1341d763cef2SBarry Smith 1342d763cef2SBarry Smith Output Parameter: 134394b7f48cSBarry Smith . ksp - the nonlinear solver context 1344d763cef2SBarry Smith 1345d763cef2SBarry Smith Notes: 134694b7f48cSBarry Smith The user can then directly manipulate the KSP context to set various 1347d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 1348d763cef2SBarry Smith KSP and PC contexts as well. 1349d763cef2SBarry Smith 135094b7f48cSBarry Smith TSGetKSP() does not work for integrators that do not use KSP; 135194b7f48cSBarry Smith in this case TSGetKSP() returns PETSC_NULL in ksp. 1352d763cef2SBarry Smith 1353d763cef2SBarry Smith Level: beginner 1354d763cef2SBarry Smith 135594b7f48cSBarry Smith .keywords: timestep, get, KSP 1356d763cef2SBarry Smith @*/ 13577087cfbeSBarry Smith PetscErrorCode TSGetKSP(TS ts,KSP *ksp) 1358d763cef2SBarry Smith { 1359d372ba47SLisandro Dalcin PetscErrorCode ierr; 1360089b2837SJed Brown SNES snes; 1361d372ba47SLisandro Dalcin 1362d763cef2SBarry Smith PetscFunctionBegin; 13630700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 13644482741eSBarry Smith PetscValidPointer(ksp,2); 136517186662SBarry Smith if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first"); 1366e32f2f54SBarry Smith if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()"); 1367089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1368089b2837SJed Brown ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr); 1369d763cef2SBarry Smith PetscFunctionReturn(0); 1370d763cef2SBarry Smith } 1371d763cef2SBarry Smith 1372d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */ 1373d763cef2SBarry Smith 13744a2ae208SSatish Balay #undef __FUNCT__ 1375adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration" 1376adb62b0dSMatthew Knepley /*@ 1377adb62b0dSMatthew Knepley TSGetDuration - Gets the maximum number of timesteps to use and 1378adb62b0dSMatthew Knepley maximum time for iteration. 1379adb62b0dSMatthew Knepley 13803f9fe445SBarry Smith Not Collective 1381adb62b0dSMatthew Knepley 1382adb62b0dSMatthew Knepley Input Parameters: 1383adb62b0dSMatthew Knepley + ts - the TS context obtained from TSCreate() 1384adb62b0dSMatthew Knepley . maxsteps - maximum number of iterations to use, or PETSC_NULL 1385adb62b0dSMatthew Knepley - maxtime - final time to iterate to, or PETSC_NULL 1386adb62b0dSMatthew Knepley 1387adb62b0dSMatthew Knepley Level: intermediate 1388adb62b0dSMatthew Knepley 1389adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time 1390adb62b0dSMatthew Knepley @*/ 13917087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 1392adb62b0dSMatthew Knepley { 1393adb62b0dSMatthew Knepley PetscFunctionBegin; 13940700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1395abc0a331SBarry Smith if (maxsteps) { 13964482741eSBarry Smith PetscValidIntPointer(maxsteps,2); 1397adb62b0dSMatthew Knepley *maxsteps = ts->max_steps; 1398adb62b0dSMatthew Knepley } 1399abc0a331SBarry Smith if (maxtime ) { 14004482741eSBarry Smith PetscValidScalarPointer(maxtime,3); 1401adb62b0dSMatthew Knepley *maxtime = ts->max_time; 1402adb62b0dSMatthew Knepley } 1403adb62b0dSMatthew Knepley PetscFunctionReturn(0); 1404adb62b0dSMatthew Knepley } 1405adb62b0dSMatthew Knepley 1406adb62b0dSMatthew Knepley #undef __FUNCT__ 14074a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration" 1408d763cef2SBarry Smith /*@ 1409d763cef2SBarry Smith TSSetDuration - Sets the maximum number of timesteps to use and 1410d763cef2SBarry Smith maximum time for iteration. 1411d763cef2SBarry Smith 14123f9fe445SBarry Smith Logically Collective on TS 1413d763cef2SBarry Smith 1414d763cef2SBarry Smith Input Parameters: 1415d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1416d763cef2SBarry Smith . maxsteps - maximum number of iterations to use 1417d763cef2SBarry Smith - maxtime - final time to iterate to 1418d763cef2SBarry Smith 1419d763cef2SBarry Smith Options Database Keys: 1420d763cef2SBarry Smith . -ts_max_steps <maxsteps> - Sets maxsteps 1421d763cef2SBarry Smith . -ts_max_time <maxtime> - Sets maxtime 1422d763cef2SBarry Smith 1423d763cef2SBarry Smith Notes: 1424d763cef2SBarry Smith The default maximum number of iterations is 5000. Default time is 5.0 1425d763cef2SBarry Smith 1426d763cef2SBarry Smith Level: intermediate 1427d763cef2SBarry Smith 1428d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations 1429d763cef2SBarry Smith @*/ 14307087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime) 1431d763cef2SBarry Smith { 1432d763cef2SBarry Smith PetscFunctionBegin; 14330700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1434c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(ts,maxsteps,2); 1435c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,maxtime,2); 143639b7ec4bSSean Farley if (maxsteps >= 0) ts->max_steps = maxsteps; 143739b7ec4bSSean Farley if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime; 1438d763cef2SBarry Smith PetscFunctionReturn(0); 1439d763cef2SBarry Smith } 1440d763cef2SBarry Smith 14414a2ae208SSatish Balay #undef __FUNCT__ 14424a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution" 1443d763cef2SBarry Smith /*@ 1444d763cef2SBarry Smith TSSetSolution - Sets the initial solution vector 1445d763cef2SBarry Smith for use by the TS routines. 1446d763cef2SBarry Smith 14473f9fe445SBarry Smith Logically Collective on TS and Vec 1448d763cef2SBarry Smith 1449d763cef2SBarry Smith Input Parameters: 1450d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1451d763cef2SBarry Smith - x - the solution vector 1452d763cef2SBarry Smith 1453d763cef2SBarry Smith Level: beginner 1454d763cef2SBarry Smith 1455d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions 1456d763cef2SBarry Smith @*/ 14577087cfbeSBarry Smith PetscErrorCode TSSetSolution(TS ts,Vec x) 1458d763cef2SBarry Smith { 14598737fe31SLisandro Dalcin PetscErrorCode ierr; 14608737fe31SLisandro Dalcin 1461d763cef2SBarry Smith PetscFunctionBegin; 14620700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 14630700a824SBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,2); 14648737fe31SLisandro Dalcin ierr = PetscObjectReference((PetscObject)x);CHKERRQ(ierr); 14656bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 14668737fe31SLisandro Dalcin ts->vec_sol = x; 1467d763cef2SBarry Smith PetscFunctionReturn(0); 1468d763cef2SBarry Smith } 1469d763cef2SBarry Smith 1470e74ef692SMatthew Knepley #undef __FUNCT__ 1471e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep" 1472ac226902SBarry Smith /*@C 1473000e7ae3SMatthew Knepley TSSetPreStep - Sets the general-purpose function 14743f2090d5SJed Brown called once at the beginning of each time step. 1475000e7ae3SMatthew Knepley 14763f9fe445SBarry Smith Logically Collective on TS 1477000e7ae3SMatthew Knepley 1478000e7ae3SMatthew Knepley Input Parameters: 1479000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 1480000e7ae3SMatthew Knepley - func - The function 1481000e7ae3SMatthew Knepley 1482000e7ae3SMatthew Knepley Calling sequence of func: 1483000e7ae3SMatthew Knepley . func (TS ts); 1484000e7ae3SMatthew Knepley 1485000e7ae3SMatthew Knepley Level: intermediate 1486000e7ae3SMatthew Knepley 1487000e7ae3SMatthew Knepley .keywords: TS, timestep 1488000e7ae3SMatthew Knepley @*/ 14897087cfbeSBarry Smith PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS)) 1490000e7ae3SMatthew Knepley { 1491000e7ae3SMatthew Knepley PetscFunctionBegin; 14920700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1493000e7ae3SMatthew Knepley ts->ops->prestep = func; 1494000e7ae3SMatthew Knepley PetscFunctionReturn(0); 1495000e7ae3SMatthew Knepley } 1496000e7ae3SMatthew Knepley 1497e74ef692SMatthew Knepley #undef __FUNCT__ 14983f2090d5SJed Brown #define __FUNCT__ "TSPreStep" 14993f2090d5SJed Brown /*@C 15003f2090d5SJed Brown TSPreStep - Runs the user-defined pre-step function. 15013f2090d5SJed Brown 15023f2090d5SJed Brown Collective on TS 15033f2090d5SJed Brown 15043f2090d5SJed Brown Input Parameters: 15053f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 15063f2090d5SJed Brown 15073f2090d5SJed Brown Notes: 15083f2090d5SJed Brown TSPreStep() is typically used within time stepping implementations, 15093f2090d5SJed Brown so most users would not generally call this routine themselves. 15103f2090d5SJed Brown 15113f2090d5SJed Brown Level: developer 15123f2090d5SJed Brown 15133f2090d5SJed Brown .keywords: TS, timestep 15143f2090d5SJed Brown @*/ 15157087cfbeSBarry Smith PetscErrorCode TSPreStep(TS ts) 15163f2090d5SJed Brown { 15173f2090d5SJed Brown PetscErrorCode ierr; 15183f2090d5SJed Brown 15193f2090d5SJed Brown PetscFunctionBegin; 15200700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 152172ac3e02SJed Brown if (ts->ops->prestep) { 15223f2090d5SJed Brown PetscStackPush("TS PreStep function"); 15233f2090d5SJed Brown ierr = (*ts->ops->prestep)(ts);CHKERRQ(ierr); 15243f2090d5SJed Brown PetscStackPop; 1525312ce896SJed Brown } 15263f2090d5SJed Brown PetscFunctionReturn(0); 15273f2090d5SJed Brown } 15283f2090d5SJed Brown 15293f2090d5SJed Brown #undef __FUNCT__ 1530e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep" 1531ac226902SBarry Smith /*@C 1532000e7ae3SMatthew Knepley TSSetPostStep - Sets the general-purpose function 15333f2090d5SJed Brown called once at the end of each time step. 1534000e7ae3SMatthew Knepley 15353f9fe445SBarry Smith Logically Collective on TS 1536000e7ae3SMatthew Knepley 1537000e7ae3SMatthew Knepley Input Parameters: 1538000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 1539000e7ae3SMatthew Knepley - func - The function 1540000e7ae3SMatthew Knepley 1541000e7ae3SMatthew Knepley Calling sequence of func: 1542000e7ae3SMatthew Knepley . func (TS ts); 1543000e7ae3SMatthew Knepley 1544000e7ae3SMatthew Knepley Level: intermediate 1545000e7ae3SMatthew Knepley 1546000e7ae3SMatthew Knepley .keywords: TS, timestep 1547000e7ae3SMatthew Knepley @*/ 15487087cfbeSBarry Smith PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS)) 1549000e7ae3SMatthew Knepley { 1550000e7ae3SMatthew Knepley PetscFunctionBegin; 15510700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1552000e7ae3SMatthew Knepley ts->ops->poststep = func; 1553000e7ae3SMatthew Knepley PetscFunctionReturn(0); 1554000e7ae3SMatthew Knepley } 1555000e7ae3SMatthew Knepley 1556e74ef692SMatthew Knepley #undef __FUNCT__ 15573f2090d5SJed Brown #define __FUNCT__ "TSPostStep" 15583f2090d5SJed Brown /*@C 15593f2090d5SJed Brown TSPostStep - Runs the user-defined post-step function. 15603f2090d5SJed Brown 15613f2090d5SJed Brown Collective on TS 15623f2090d5SJed Brown 15633f2090d5SJed Brown Input Parameters: 15643f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 15653f2090d5SJed Brown 15663f2090d5SJed Brown Notes: 15673f2090d5SJed Brown TSPostStep() is typically used within time stepping implementations, 15683f2090d5SJed Brown so most users would not generally call this routine themselves. 15693f2090d5SJed Brown 15703f2090d5SJed Brown Level: developer 15713f2090d5SJed Brown 15723f2090d5SJed Brown .keywords: TS, timestep 15733f2090d5SJed Brown @*/ 15747087cfbeSBarry Smith PetscErrorCode TSPostStep(TS ts) 15753f2090d5SJed Brown { 15763f2090d5SJed Brown PetscErrorCode ierr; 15773f2090d5SJed Brown 15783f2090d5SJed Brown PetscFunctionBegin; 15790700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 158072ac3e02SJed Brown if (ts->ops->poststep) { 15813f2090d5SJed Brown PetscStackPush("TS PostStep function"); 15823f2090d5SJed Brown ierr = (*ts->ops->poststep)(ts);CHKERRQ(ierr); 15833f2090d5SJed Brown PetscStackPop; 158472ac3e02SJed Brown } 15853f2090d5SJed Brown PetscFunctionReturn(0); 15863f2090d5SJed Brown } 15873f2090d5SJed Brown 1588d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */ 1589d763cef2SBarry Smith 15904a2ae208SSatish Balay #undef __FUNCT__ 1591a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet" 1592d763cef2SBarry Smith /*@C 1593a6570f20SBarry Smith TSMonitorSet - Sets an ADDITIONAL function that is to be used at every 1594d763cef2SBarry Smith timestep to display the iteration's progress. 1595d763cef2SBarry Smith 15963f9fe445SBarry Smith Logically Collective on TS 1597d763cef2SBarry Smith 1598d763cef2SBarry Smith Input Parameters: 1599d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1600d763cef2SBarry Smith . func - monitoring routine 1601329f5518SBarry Smith . mctx - [optional] user-defined context for private data for the 1602b3006f0bSLois Curfman McInnes monitor routine (use PETSC_NULL if no context is desired) 1603b3006f0bSLois Curfman McInnes - monitordestroy - [optional] routine that frees monitor context 1604b3006f0bSLois Curfman McInnes (may be PETSC_NULL) 1605d763cef2SBarry Smith 1606d763cef2SBarry Smith Calling sequence of func: 1607a7cc72afSBarry Smith $ int func(TS ts,PetscInt steps,PetscReal time,Vec x,void *mctx) 1608d763cef2SBarry Smith 1609d763cef2SBarry Smith + ts - the TS context 1610d763cef2SBarry Smith . steps - iteration number 16111f06c33eSBarry Smith . time - current time 1612d763cef2SBarry Smith . x - current iterate 1613d763cef2SBarry Smith - mctx - [optional] monitoring context 1614d763cef2SBarry Smith 1615d763cef2SBarry Smith Notes: 1616d763cef2SBarry Smith This routine adds an additional monitor to the list of monitors that 1617d763cef2SBarry Smith already has been loaded. 1618d763cef2SBarry Smith 1619025f1a04SBarry Smith Fortran notes: Only a single monitor function can be set for each TS object 1620025f1a04SBarry Smith 1621d763cef2SBarry Smith Level: intermediate 1622d763cef2SBarry Smith 1623d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 1624d763cef2SBarry Smith 1625a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel() 1626d763cef2SBarry Smith @*/ 1627c2efdce3SBarry Smith PetscErrorCode TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**)) 1628d763cef2SBarry Smith { 1629d763cef2SBarry Smith PetscFunctionBegin; 16300700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 163117186662SBarry Smith if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 1632d763cef2SBarry Smith ts->monitor[ts->numbermonitors] = monitor; 1633329f5518SBarry Smith ts->mdestroy[ts->numbermonitors] = mdestroy; 1634d763cef2SBarry Smith ts->monitorcontext[ts->numbermonitors++] = (void*)mctx; 1635d763cef2SBarry Smith PetscFunctionReturn(0); 1636d763cef2SBarry Smith } 1637d763cef2SBarry Smith 16384a2ae208SSatish Balay #undef __FUNCT__ 1639a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel" 1640d763cef2SBarry Smith /*@C 1641a6570f20SBarry Smith TSMonitorCancel - Clears all the monitors that have been set on a time-step object. 1642d763cef2SBarry Smith 16433f9fe445SBarry Smith Logically Collective on TS 1644d763cef2SBarry Smith 1645d763cef2SBarry Smith Input Parameters: 1646d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1647d763cef2SBarry Smith 1648d763cef2SBarry Smith Notes: 1649d763cef2SBarry Smith There is no way to remove a single, specific monitor. 1650d763cef2SBarry Smith 1651d763cef2SBarry Smith Level: intermediate 1652d763cef2SBarry Smith 1653d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 1654d763cef2SBarry Smith 1655a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet() 1656d763cef2SBarry Smith @*/ 16577087cfbeSBarry Smith PetscErrorCode TSMonitorCancel(TS ts) 1658d763cef2SBarry Smith { 1659d952e501SBarry Smith PetscErrorCode ierr; 1660d952e501SBarry Smith PetscInt i; 1661d952e501SBarry Smith 1662d763cef2SBarry Smith PetscFunctionBegin; 16630700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1664d952e501SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 1665d952e501SBarry Smith if (ts->mdestroy[i]) { 16663c4aec1bSBarry Smith ierr = (*ts->mdestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr); 1667d952e501SBarry Smith } 1668d952e501SBarry Smith } 1669d763cef2SBarry Smith ts->numbermonitors = 0; 1670d763cef2SBarry Smith PetscFunctionReturn(0); 1671d763cef2SBarry Smith } 1672d763cef2SBarry Smith 16734a2ae208SSatish Balay #undef __FUNCT__ 1674a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault" 1675d8e5e3e6SSatish Balay /*@ 1676a6570f20SBarry Smith TSMonitorDefault - Sets the Default monitor 16775516499fSSatish Balay 16785516499fSSatish Balay Level: intermediate 167941251cbbSSatish Balay 16805516499fSSatish Balay .keywords: TS, set, monitor 16815516499fSSatish Balay 168241251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet() 168341251cbbSSatish Balay @*/ 1684649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy) 1685d763cef2SBarry Smith { 1686dfbe8321SBarry Smith PetscErrorCode ierr; 1687649052a6SBarry Smith PetscViewer viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(((PetscObject)ts)->comm); 1688d132466eSBarry Smith 1689d763cef2SBarry Smith PetscFunctionBegin; 1690649052a6SBarry Smith ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 1691649052a6SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %G time %G\n",step,ts->time_step,ptime);CHKERRQ(ierr); 1692649052a6SBarry Smith ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 1693d763cef2SBarry Smith PetscFunctionReturn(0); 1694d763cef2SBarry Smith } 1695d763cef2SBarry Smith 16964a2ae208SSatish Balay #undef __FUNCT__ 16974a2ae208SSatish Balay #define __FUNCT__ "TSStep" 1698d763cef2SBarry Smith /*@ 1699d763cef2SBarry Smith TSStep - Steps the requested number of timesteps. 1700d763cef2SBarry Smith 1701d763cef2SBarry Smith Collective on TS 1702d763cef2SBarry Smith 1703d763cef2SBarry Smith Input Parameter: 1704d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1705d763cef2SBarry Smith 1706d763cef2SBarry Smith Output Parameters: 1707d763cef2SBarry Smith + steps - number of iterations until termination 1708142b95e3SSatish Balay - ptime - time until termination 1709d763cef2SBarry Smith 1710d763cef2SBarry Smith Level: beginner 1711d763cef2SBarry Smith 1712d763cef2SBarry Smith .keywords: TS, timestep, solve 1713d763cef2SBarry Smith 1714d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSDestroy() 1715d763cef2SBarry Smith @*/ 1716193ac0bcSJed Brown PetscErrorCode TSStep(TS ts) 1717d763cef2SBarry Smith { 1718dfbe8321SBarry Smith PetscErrorCode ierr; 1719d763cef2SBarry Smith 1720d763cef2SBarry Smith PetscFunctionBegin; 17210700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1722277b19d0SLisandro Dalcin 1723d405a339SMatthew Knepley ierr = TSSetUp(ts);CHKERRQ(ierr); 1724d405a339SMatthew Knepley 1725d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_Step, ts, 0, 0, 0);CHKERRQ(ierr); 1726193ac0bcSJed Brown ierr = (*ts->ops->step)(ts);CHKERRQ(ierr); 1727d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_Step, ts, 0, 0, 0);CHKERRQ(ierr); 1728d763cef2SBarry Smith PetscFunctionReturn(0); 1729d763cef2SBarry Smith } 1730d763cef2SBarry Smith 17314a2ae208SSatish Balay #undef __FUNCT__ 17326a4d4014SLisandro Dalcin #define __FUNCT__ "TSSolve" 17336a4d4014SLisandro Dalcin /*@ 17346a4d4014SLisandro Dalcin TSSolve - Steps the requested number of timesteps. 17356a4d4014SLisandro Dalcin 17366a4d4014SLisandro Dalcin Collective on TS 17376a4d4014SLisandro Dalcin 17386a4d4014SLisandro Dalcin Input Parameter: 17396a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 17406a4d4014SLisandro Dalcin - x - the solution vector, or PETSC_NULL if it was set with TSSetSolution() 17416a4d4014SLisandro Dalcin 17426a4d4014SLisandro Dalcin Level: beginner 17436a4d4014SLisandro Dalcin 17446a4d4014SLisandro Dalcin .keywords: TS, timestep, solve 17456a4d4014SLisandro Dalcin 17466a4d4014SLisandro Dalcin .seealso: TSCreate(), TSSetSolution(), TSStep() 17476a4d4014SLisandro Dalcin @*/ 17487087cfbeSBarry Smith PetscErrorCode TSSolve(TS ts, Vec x) 17496a4d4014SLisandro Dalcin { 1750193ac0bcSJed Brown PetscInt i; 17516a4d4014SLisandro Dalcin PetscErrorCode ierr; 1752f22f69f0SBarry Smith 17536a4d4014SLisandro Dalcin PetscFunctionBegin; 17540700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1755193ac0bcSJed Brown PetscValidHeaderSpecific(x,VEC_CLASSID,2); 1756193ac0bcSJed Brown ierr = TSSetSolution(ts,x); CHKERRQ(ierr); 1757b5d403baSSean Farley ierr = TSSetUp(ts); CHKERRQ(ierr); 17586a4d4014SLisandro Dalcin /* reset time step and iteration counters */ 1759193ac0bcSJed Brown ts->steps = 0; 1760193ac0bcSJed Brown ts->linear_its = 0; 1761193ac0bcSJed Brown ts->nonlinear_its = 0; 1762193ac0bcSJed Brown ts->reason = TS_CONVERGED_ITERATING; 1763193ac0bcSJed Brown ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 1764193ac0bcSJed Brown 1765193ac0bcSJed Brown if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 1766193ac0bcSJed Brown ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr); 1767193ac0bcSJed Brown } else { 1768*e1a7a14fSJed Brown i = 0; 1769*e1a7a14fSJed Brown if (i >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 1770*e1a7a14fSJed Brown else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 17716a4d4014SLisandro Dalcin /* steps the requested number of timesteps. */ 1772*e1a7a14fSJed Brown while (!ts->reason) { 1773193ac0bcSJed Brown ierr = TSPreStep(ts);CHKERRQ(ierr); 1774193ac0bcSJed Brown ierr = TSStep(ts);CHKERRQ(ierr); 1775193ac0bcSJed Brown if (ts->reason < 0) { 1776193ac0bcSJed Brown if (ts->errorifstepfailed) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_NOT_CONVERGED,"TSStep has failed"); 17773daf2de8SJed Brown } else if (++i >= ts->max_steps) { 1778193ac0bcSJed Brown ts->reason = TS_CONVERGED_ITS; 1779193ac0bcSJed Brown } else if (ts->ptime >= ts->max_time) { 1780193ac0bcSJed Brown ts->reason = TS_CONVERGED_TIME; 1781193ac0bcSJed Brown } 1782193ac0bcSJed Brown ierr = TSPostStep(ts);CHKERRQ(ierr); 1783193ac0bcSJed Brown ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 1784193ac0bcSJed Brown } 1785193ac0bcSJed Brown } 1786193ac0bcSJed Brown if (!PetscPreLoadingOn) { 1787193ac0bcSJed Brown ierr = TSViewFromOptions(ts,((PetscObject)ts)->name);CHKERRQ(ierr); 1788193ac0bcSJed Brown } 17896a4d4014SLisandro Dalcin PetscFunctionReturn(0); 17906a4d4014SLisandro Dalcin } 17916a4d4014SLisandro Dalcin 17926a4d4014SLisandro Dalcin #undef __FUNCT__ 17934a2ae208SSatish Balay #define __FUNCT__ "TSMonitor" 1794d763cef2SBarry Smith /* 1795d763cef2SBarry Smith Runs the user provided monitor routines, if they exists. 1796d763cef2SBarry Smith */ 1797a7cc72afSBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec x) 1798d763cef2SBarry Smith { 17996849ba73SBarry Smith PetscErrorCode ierr; 1800a7cc72afSBarry Smith PetscInt i,n = ts->numbermonitors; 1801d763cef2SBarry Smith 1802d763cef2SBarry Smith PetscFunctionBegin; 1803d763cef2SBarry Smith for (i=0; i<n; i++) { 1804142b95e3SSatish Balay ierr = (*ts->monitor[i])(ts,step,ptime,x,ts->monitorcontext[i]);CHKERRQ(ierr); 1805d763cef2SBarry Smith } 1806d763cef2SBarry Smith PetscFunctionReturn(0); 1807d763cef2SBarry Smith } 1808d763cef2SBarry Smith 1809d763cef2SBarry Smith /* ------------------------------------------------------------------------*/ 1810d763cef2SBarry Smith 18114a2ae208SSatish Balay #undef __FUNCT__ 1812a6570f20SBarry Smith #define __FUNCT__ "TSMonitorLGCreate" 1813d763cef2SBarry Smith /*@C 1814a6570f20SBarry Smith TSMonitorLGCreate - Creates a line graph context for use with 1815d763cef2SBarry Smith TS to monitor convergence of preconditioned residual norms. 1816d763cef2SBarry Smith 1817d763cef2SBarry Smith Collective on TS 1818d763cef2SBarry Smith 1819d763cef2SBarry Smith Input Parameters: 1820d763cef2SBarry Smith + host - the X display to open, or null for the local machine 1821d763cef2SBarry Smith . label - the title to put in the title bar 18227c922b88SBarry Smith . x, y - the screen coordinates of the upper left coordinate of the window 1823d763cef2SBarry Smith - m, n - the screen width and height in pixels 1824d763cef2SBarry Smith 1825d763cef2SBarry Smith Output Parameter: 1826d763cef2SBarry Smith . draw - the drawing context 1827d763cef2SBarry Smith 1828d763cef2SBarry Smith Options Database Key: 1829a6570f20SBarry Smith . -ts_monitor_draw - automatically sets line graph monitor 1830d763cef2SBarry Smith 1831d763cef2SBarry Smith Notes: 1832a6570f20SBarry Smith Use TSMonitorLGDestroy() to destroy this line graph, not PetscDrawLGDestroy(). 1833d763cef2SBarry Smith 1834d763cef2SBarry Smith Level: intermediate 1835d763cef2SBarry Smith 18367c922b88SBarry Smith .keywords: TS, monitor, line graph, residual, seealso 1837d763cef2SBarry Smith 1838a6570f20SBarry Smith .seealso: TSMonitorLGDestroy(), TSMonitorSet() 18397c922b88SBarry Smith 1840d763cef2SBarry Smith @*/ 18417087cfbeSBarry Smith PetscErrorCode TSMonitorLGCreate(const char host[],const char label[],int x,int y,int m,int n,PetscDrawLG *draw) 1842d763cef2SBarry Smith { 1843b0a32e0cSBarry Smith PetscDraw win; 1844dfbe8321SBarry Smith PetscErrorCode ierr; 1845d763cef2SBarry Smith 1846d763cef2SBarry Smith PetscFunctionBegin; 1847b0a32e0cSBarry Smith ierr = PetscDrawCreate(PETSC_COMM_SELF,host,label,x,y,m,n,&win);CHKERRQ(ierr); 1848b0a32e0cSBarry Smith ierr = PetscDrawSetType(win,PETSC_DRAW_X);CHKERRQ(ierr); 1849b0a32e0cSBarry Smith ierr = PetscDrawLGCreate(win,1,draw);CHKERRQ(ierr); 1850b0a32e0cSBarry Smith ierr = PetscDrawLGIndicateDataPoints(*draw);CHKERRQ(ierr); 1851d763cef2SBarry Smith 185252e6d16bSBarry Smith ierr = PetscLogObjectParent(*draw,win);CHKERRQ(ierr); 1853d763cef2SBarry Smith PetscFunctionReturn(0); 1854d763cef2SBarry Smith } 1855d763cef2SBarry Smith 18564a2ae208SSatish Balay #undef __FUNCT__ 1857a6570f20SBarry Smith #define __FUNCT__ "TSMonitorLG" 1858a6570f20SBarry Smith PetscErrorCode TSMonitorLG(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 1859d763cef2SBarry Smith { 1860b0a32e0cSBarry Smith PetscDrawLG lg = (PetscDrawLG) monctx; 186187828ca2SBarry Smith PetscReal x,y = ptime; 1862dfbe8321SBarry Smith PetscErrorCode ierr; 1863d763cef2SBarry Smith 1864d763cef2SBarry Smith PetscFunctionBegin; 18657c922b88SBarry Smith if (!monctx) { 18667c922b88SBarry Smith MPI_Comm comm; 1867b0a32e0cSBarry Smith PetscViewer viewer; 18687c922b88SBarry Smith 18697c922b88SBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 1870b0a32e0cSBarry Smith viewer = PETSC_VIEWER_DRAW_(comm); 1871b0a32e0cSBarry Smith ierr = PetscViewerDrawGetDrawLG(viewer,0,&lg);CHKERRQ(ierr); 18727c922b88SBarry Smith } 18737c922b88SBarry Smith 1874b0a32e0cSBarry Smith if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);} 187587828ca2SBarry Smith x = (PetscReal)n; 1876b0a32e0cSBarry Smith ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr); 1877d763cef2SBarry Smith if (n < 20 || (n % 5)) { 1878b0a32e0cSBarry Smith ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr); 1879d763cef2SBarry Smith } 1880d763cef2SBarry Smith PetscFunctionReturn(0); 1881d763cef2SBarry Smith } 1882d763cef2SBarry Smith 18834a2ae208SSatish Balay #undef __FUNCT__ 1884a6570f20SBarry Smith #define __FUNCT__ "TSMonitorLGDestroy" 1885d763cef2SBarry Smith /*@C 1886a6570f20SBarry Smith TSMonitorLGDestroy - Destroys a line graph context that was created 1887a6570f20SBarry Smith with TSMonitorLGCreate(). 1888d763cef2SBarry Smith 1889b0a32e0cSBarry Smith Collective on PetscDrawLG 1890d763cef2SBarry Smith 1891d763cef2SBarry Smith Input Parameter: 1892d763cef2SBarry Smith . draw - the drawing context 1893d763cef2SBarry Smith 1894d763cef2SBarry Smith Level: intermediate 1895d763cef2SBarry Smith 1896d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy 1897d763cef2SBarry Smith 1898a6570f20SBarry Smith .seealso: TSMonitorLGCreate(), TSMonitorSet(), TSMonitorLG(); 1899d763cef2SBarry Smith @*/ 19006bf464f9SBarry Smith PetscErrorCode TSMonitorLGDestroy(PetscDrawLG *drawlg) 1901d763cef2SBarry Smith { 1902b0a32e0cSBarry Smith PetscDraw draw; 1903dfbe8321SBarry Smith PetscErrorCode ierr; 1904d763cef2SBarry Smith 1905d763cef2SBarry Smith PetscFunctionBegin; 19066bf464f9SBarry Smith ierr = PetscDrawLGGetDraw(*drawlg,&draw);CHKERRQ(ierr); 19076bf464f9SBarry Smith ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 1908b0a32e0cSBarry Smith ierr = PetscDrawLGDestroy(drawlg);CHKERRQ(ierr); 1909d763cef2SBarry Smith PetscFunctionReturn(0); 1910d763cef2SBarry Smith } 1911d763cef2SBarry Smith 19124a2ae208SSatish Balay #undef __FUNCT__ 19134a2ae208SSatish Balay #define __FUNCT__ "TSGetTime" 1914d763cef2SBarry Smith /*@ 1915d763cef2SBarry Smith TSGetTime - Gets the current time. 1916d763cef2SBarry Smith 1917d763cef2SBarry Smith Not Collective 1918d763cef2SBarry Smith 1919d763cef2SBarry Smith Input Parameter: 1920d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1921d763cef2SBarry Smith 1922d763cef2SBarry Smith Output Parameter: 1923d763cef2SBarry Smith . t - the current time 1924d763cef2SBarry Smith 1925d763cef2SBarry Smith Level: beginner 1926d763cef2SBarry Smith 1927d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1928d763cef2SBarry Smith 1929d763cef2SBarry Smith .keywords: TS, get, time 1930d763cef2SBarry Smith @*/ 19317087cfbeSBarry Smith PetscErrorCode TSGetTime(TS ts,PetscReal* t) 1932d763cef2SBarry Smith { 1933d763cef2SBarry Smith PetscFunctionBegin; 19340700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 19354482741eSBarry Smith PetscValidDoublePointer(t,2); 1936d763cef2SBarry Smith *t = ts->ptime; 1937d763cef2SBarry Smith PetscFunctionReturn(0); 1938d763cef2SBarry Smith } 1939d763cef2SBarry Smith 19404a2ae208SSatish Balay #undef __FUNCT__ 19416a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime" 19426a4d4014SLisandro Dalcin /*@ 19436a4d4014SLisandro Dalcin TSSetTime - Allows one to reset the time. 19446a4d4014SLisandro Dalcin 19453f9fe445SBarry Smith Logically Collective on TS 19466a4d4014SLisandro Dalcin 19476a4d4014SLisandro Dalcin Input Parameters: 19486a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 19496a4d4014SLisandro Dalcin - time - the time 19506a4d4014SLisandro Dalcin 19516a4d4014SLisandro Dalcin Level: intermediate 19526a4d4014SLisandro Dalcin 19536a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration() 19546a4d4014SLisandro Dalcin 19556a4d4014SLisandro Dalcin .keywords: TS, set, time 19566a4d4014SLisandro Dalcin @*/ 19577087cfbeSBarry Smith PetscErrorCode TSSetTime(TS ts, PetscReal t) 19586a4d4014SLisandro Dalcin { 19596a4d4014SLisandro Dalcin PetscFunctionBegin; 19600700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1961c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,t,2); 19626a4d4014SLisandro Dalcin ts->ptime = t; 19636a4d4014SLisandro Dalcin PetscFunctionReturn(0); 19646a4d4014SLisandro Dalcin } 19656a4d4014SLisandro Dalcin 19666a4d4014SLisandro Dalcin #undef __FUNCT__ 19674a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix" 1968d763cef2SBarry Smith /*@C 1969d763cef2SBarry Smith TSSetOptionsPrefix - Sets the prefix used for searching for all 1970d763cef2SBarry Smith TS options in the database. 1971d763cef2SBarry Smith 19723f9fe445SBarry Smith Logically Collective on TS 1973d763cef2SBarry Smith 1974d763cef2SBarry Smith Input Parameter: 1975d763cef2SBarry Smith + ts - The TS context 1976d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 1977d763cef2SBarry Smith 1978d763cef2SBarry Smith Notes: 1979d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 1980d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 1981d763cef2SBarry Smith hyphen. 1982d763cef2SBarry Smith 1983d763cef2SBarry Smith Level: advanced 1984d763cef2SBarry Smith 1985d763cef2SBarry Smith .keywords: TS, set, options, prefix, database 1986d763cef2SBarry Smith 1987d763cef2SBarry Smith .seealso: TSSetFromOptions() 1988d763cef2SBarry Smith 1989d763cef2SBarry Smith @*/ 19907087cfbeSBarry Smith PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[]) 1991d763cef2SBarry Smith { 1992dfbe8321SBarry Smith PetscErrorCode ierr; 1993089b2837SJed Brown SNES snes; 1994d763cef2SBarry Smith 1995d763cef2SBarry Smith PetscFunctionBegin; 19960700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1997d763cef2SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 1998089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1999089b2837SJed Brown ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr); 2000d763cef2SBarry Smith PetscFunctionReturn(0); 2001d763cef2SBarry Smith } 2002d763cef2SBarry Smith 2003d763cef2SBarry Smith 20044a2ae208SSatish Balay #undef __FUNCT__ 20054a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix" 2006d763cef2SBarry Smith /*@C 2007d763cef2SBarry Smith TSAppendOptionsPrefix - Appends to the prefix used for searching for all 2008d763cef2SBarry Smith TS options in the database. 2009d763cef2SBarry Smith 20103f9fe445SBarry Smith Logically Collective on TS 2011d763cef2SBarry Smith 2012d763cef2SBarry Smith Input Parameter: 2013d763cef2SBarry Smith + ts - The TS context 2014d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 2015d763cef2SBarry Smith 2016d763cef2SBarry Smith Notes: 2017d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 2018d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 2019d763cef2SBarry Smith hyphen. 2020d763cef2SBarry Smith 2021d763cef2SBarry Smith Level: advanced 2022d763cef2SBarry Smith 2023d763cef2SBarry Smith .keywords: TS, append, options, prefix, database 2024d763cef2SBarry Smith 2025d763cef2SBarry Smith .seealso: TSGetOptionsPrefix() 2026d763cef2SBarry Smith 2027d763cef2SBarry Smith @*/ 20287087cfbeSBarry Smith PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[]) 2029d763cef2SBarry Smith { 2030dfbe8321SBarry Smith PetscErrorCode ierr; 2031089b2837SJed Brown SNES snes; 2032d763cef2SBarry Smith 2033d763cef2SBarry Smith PetscFunctionBegin; 20340700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2035d763cef2SBarry Smith ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 2036089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2037089b2837SJed Brown ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr); 2038d763cef2SBarry Smith PetscFunctionReturn(0); 2039d763cef2SBarry Smith } 2040d763cef2SBarry Smith 20414a2ae208SSatish Balay #undef __FUNCT__ 20424a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix" 2043d763cef2SBarry Smith /*@C 2044d763cef2SBarry Smith TSGetOptionsPrefix - Sets the prefix used for searching for all 2045d763cef2SBarry Smith TS options in the database. 2046d763cef2SBarry Smith 2047d763cef2SBarry Smith Not Collective 2048d763cef2SBarry Smith 2049d763cef2SBarry Smith Input Parameter: 2050d763cef2SBarry Smith . ts - The TS context 2051d763cef2SBarry Smith 2052d763cef2SBarry Smith Output Parameter: 2053d763cef2SBarry Smith . prefix - A pointer to the prefix string used 2054d763cef2SBarry Smith 2055d763cef2SBarry Smith Notes: On the fortran side, the user should pass in a string 'prifix' of 2056d763cef2SBarry Smith sufficient length to hold the prefix. 2057d763cef2SBarry Smith 2058d763cef2SBarry Smith Level: intermediate 2059d763cef2SBarry Smith 2060d763cef2SBarry Smith .keywords: TS, get, options, prefix, database 2061d763cef2SBarry Smith 2062d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix() 2063d763cef2SBarry Smith @*/ 20647087cfbeSBarry Smith PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[]) 2065d763cef2SBarry Smith { 2066dfbe8321SBarry Smith PetscErrorCode ierr; 2067d763cef2SBarry Smith 2068d763cef2SBarry Smith PetscFunctionBegin; 20690700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 20704482741eSBarry Smith PetscValidPointer(prefix,2); 2071d763cef2SBarry Smith ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 2072d763cef2SBarry Smith PetscFunctionReturn(0); 2073d763cef2SBarry Smith } 2074d763cef2SBarry Smith 20754a2ae208SSatish Balay #undef __FUNCT__ 20764a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian" 2077d763cef2SBarry Smith /*@C 2078d763cef2SBarry Smith TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 2079d763cef2SBarry Smith 2080d763cef2SBarry Smith Not Collective, but parallel objects are returned if TS is parallel 2081d763cef2SBarry Smith 2082d763cef2SBarry Smith Input Parameter: 2083d763cef2SBarry Smith . ts - The TS context obtained from TSCreate() 2084d763cef2SBarry Smith 2085d763cef2SBarry Smith Output Parameters: 2086d763cef2SBarry Smith + J - The Jacobian J of F, where U_t = F(U,t) 2087d763cef2SBarry Smith . M - The preconditioner matrix, usually the same as J 2088089b2837SJed Brown . func - Function to compute the Jacobian of the RHS 2089d763cef2SBarry Smith - ctx - User-defined context for Jacobian evaluation routine 2090d763cef2SBarry Smith 2091d763cef2SBarry Smith Notes: You can pass in PETSC_NULL for any return argument you do not need. 2092d763cef2SBarry Smith 2093d763cef2SBarry Smith Level: intermediate 2094d763cef2SBarry Smith 209526d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 2096d763cef2SBarry Smith 2097d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian 2098d763cef2SBarry Smith @*/ 2099089b2837SJed Brown PetscErrorCode TSGetRHSJacobian(TS ts,Mat *J,Mat *M,TSRHSJacobian *func,void **ctx) 2100d763cef2SBarry Smith { 2101089b2837SJed Brown PetscErrorCode ierr; 2102089b2837SJed Brown SNES snes; 2103089b2837SJed Brown 2104d763cef2SBarry Smith PetscFunctionBegin; 2105089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2106089b2837SJed Brown ierr = SNESGetJacobian(snes,J,M,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 21073b5f76d0SSean Farley if (func) *func = ts->userops->rhsjacobian; 210826d46c62SHong Zhang if (ctx) *ctx = ts->jacP; 2109d763cef2SBarry Smith PetscFunctionReturn(0); 2110d763cef2SBarry Smith } 2111d763cef2SBarry Smith 21121713a123SBarry Smith #undef __FUNCT__ 21132eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian" 21142eca1d9cSJed Brown /*@C 21152eca1d9cSJed Brown TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 21162eca1d9cSJed Brown 21172eca1d9cSJed Brown Not Collective, but parallel objects are returned if TS is parallel 21182eca1d9cSJed Brown 21192eca1d9cSJed Brown Input Parameter: 21202eca1d9cSJed Brown . ts - The TS context obtained from TSCreate() 21212eca1d9cSJed Brown 21222eca1d9cSJed Brown Output Parameters: 21232eca1d9cSJed Brown + A - The Jacobian of F(t,U,U_t) 21242eca1d9cSJed Brown . B - The preconditioner matrix, often the same as A 21252eca1d9cSJed Brown . f - The function to compute the matrices 21262eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine 21272eca1d9cSJed Brown 21282eca1d9cSJed Brown Notes: You can pass in PETSC_NULL for any return argument you do not need. 21292eca1d9cSJed Brown 21302eca1d9cSJed Brown Level: advanced 21312eca1d9cSJed Brown 21322eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 21332eca1d9cSJed Brown 21342eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian 21352eca1d9cSJed Brown @*/ 21367087cfbeSBarry Smith PetscErrorCode TSGetIJacobian(TS ts,Mat *A,Mat *B,TSIJacobian *f,void **ctx) 21372eca1d9cSJed Brown { 2138089b2837SJed Brown PetscErrorCode ierr; 2139089b2837SJed Brown SNES snes; 2140089b2837SJed Brown 21412eca1d9cSJed Brown PetscFunctionBegin; 2142089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2143089b2837SJed Brown ierr = SNESGetJacobian(snes,A,B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 21443b5f76d0SSean Farley if (f) *f = ts->userops->ijacobian; 21452eca1d9cSJed Brown if (ctx) *ctx = ts->jacP; 21462eca1d9cSJed Brown PetscFunctionReturn(0); 21472eca1d9cSJed Brown } 21482eca1d9cSJed Brown 21492eca1d9cSJed Brown #undef __FUNCT__ 2150a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSolution" 21511713a123SBarry Smith /*@C 2152a6570f20SBarry Smith TSMonitorSolution - Monitors progress of the TS solvers by calling 21531713a123SBarry Smith VecView() for the solution at each timestep 21541713a123SBarry Smith 21551713a123SBarry Smith Collective on TS 21561713a123SBarry Smith 21571713a123SBarry Smith Input Parameters: 21581713a123SBarry Smith + ts - the TS context 21591713a123SBarry Smith . step - current time-step 2160142b95e3SSatish Balay . ptime - current time 21611713a123SBarry Smith - dummy - either a viewer or PETSC_NULL 21621713a123SBarry Smith 21631713a123SBarry Smith Level: intermediate 21641713a123SBarry Smith 21651713a123SBarry Smith .keywords: TS, vector, monitor, view 21661713a123SBarry Smith 2167a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 21681713a123SBarry Smith @*/ 21697087cfbeSBarry Smith PetscErrorCode TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec x,void *dummy) 21701713a123SBarry Smith { 2171dfbe8321SBarry Smith PetscErrorCode ierr; 21721713a123SBarry Smith PetscViewer viewer = (PetscViewer) dummy; 21731713a123SBarry Smith 21741713a123SBarry Smith PetscFunctionBegin; 2175a34d58ebSBarry Smith if (!dummy) { 21767adad957SLisandro Dalcin viewer = PETSC_VIEWER_DRAW_(((PetscObject)ts)->comm); 21771713a123SBarry Smith } 21781713a123SBarry Smith ierr = VecView(x,viewer);CHKERRQ(ierr); 21791713a123SBarry Smith PetscFunctionReturn(0); 21801713a123SBarry Smith } 21811713a123SBarry Smith 21821713a123SBarry Smith 21836c699258SBarry Smith #undef __FUNCT__ 21846c699258SBarry Smith #define __FUNCT__ "TSSetDM" 21856c699258SBarry Smith /*@ 21866c699258SBarry Smith TSSetDM - Sets the DM that may be used by some preconditioners 21876c699258SBarry Smith 21883f9fe445SBarry Smith Logically Collective on TS and DM 21896c699258SBarry Smith 21906c699258SBarry Smith Input Parameters: 21916c699258SBarry Smith + ts - the preconditioner context 21926c699258SBarry Smith - dm - the dm 21936c699258SBarry Smith 21946c699258SBarry Smith Level: intermediate 21956c699258SBarry Smith 21966c699258SBarry Smith 21976c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM() 21986c699258SBarry Smith @*/ 21997087cfbeSBarry Smith PetscErrorCode TSSetDM(TS ts,DM dm) 22006c699258SBarry Smith { 22016c699258SBarry Smith PetscErrorCode ierr; 2202089b2837SJed Brown SNES snes; 22036c699258SBarry Smith 22046c699258SBarry Smith PetscFunctionBegin; 22050700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 220670663e4aSLisandro Dalcin ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr); 22076bf464f9SBarry Smith ierr = DMDestroy(&ts->dm);CHKERRQ(ierr); 22086c699258SBarry Smith ts->dm = dm; 2209089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2210089b2837SJed Brown ierr = SNESSetDM(snes,dm);CHKERRQ(ierr); 22116c699258SBarry Smith PetscFunctionReturn(0); 22126c699258SBarry Smith } 22136c699258SBarry Smith 22146c699258SBarry Smith #undef __FUNCT__ 22156c699258SBarry Smith #define __FUNCT__ "TSGetDM" 22166c699258SBarry Smith /*@ 22176c699258SBarry Smith TSGetDM - Gets the DM that may be used by some preconditioners 22186c699258SBarry Smith 22193f9fe445SBarry Smith Not Collective 22206c699258SBarry Smith 22216c699258SBarry Smith Input Parameter: 22226c699258SBarry Smith . ts - the preconditioner context 22236c699258SBarry Smith 22246c699258SBarry Smith Output Parameter: 22256c699258SBarry Smith . dm - the dm 22266c699258SBarry Smith 22276c699258SBarry Smith Level: intermediate 22286c699258SBarry Smith 22296c699258SBarry Smith 22306c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM() 22316c699258SBarry Smith @*/ 22327087cfbeSBarry Smith PetscErrorCode TSGetDM(TS ts,DM *dm) 22336c699258SBarry Smith { 22346c699258SBarry Smith PetscFunctionBegin; 22350700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 22366c699258SBarry Smith *dm = ts->dm; 22376c699258SBarry Smith PetscFunctionReturn(0); 22386c699258SBarry Smith } 22391713a123SBarry Smith 22400f5c6efeSJed Brown #undef __FUNCT__ 22410f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction" 22420f5c6efeSJed Brown /*@ 22430f5c6efeSJed Brown SNESTSFormFunction - Function to evaluate nonlinear residual 22440f5c6efeSJed Brown 22453f9fe445SBarry Smith Logically Collective on SNES 22460f5c6efeSJed Brown 22470f5c6efeSJed Brown Input Parameter: 2248d42a1c89SJed Brown + snes - nonlinear solver 22490f5c6efeSJed Brown . X - the current state at which to evaluate the residual 2250d42a1c89SJed Brown - ctx - user context, must be a TS 22510f5c6efeSJed Brown 22520f5c6efeSJed Brown Output Parameter: 22530f5c6efeSJed Brown . F - the nonlinear residual 22540f5c6efeSJed Brown 22550f5c6efeSJed Brown Notes: 22560f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 22570f5c6efeSJed Brown It is most frequently passed to MatFDColoringSetFunction(). 22580f5c6efeSJed Brown 22590f5c6efeSJed Brown Level: advanced 22600f5c6efeSJed Brown 22610f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction() 22620f5c6efeSJed Brown @*/ 22637087cfbeSBarry Smith PetscErrorCode SNESTSFormFunction(SNES snes,Vec X,Vec F,void *ctx) 22640f5c6efeSJed Brown { 22650f5c6efeSJed Brown TS ts = (TS)ctx; 22660f5c6efeSJed Brown PetscErrorCode ierr; 22670f5c6efeSJed Brown 22680f5c6efeSJed Brown PetscFunctionBegin; 22690f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 22700f5c6efeSJed Brown PetscValidHeaderSpecific(X,VEC_CLASSID,2); 22710f5c6efeSJed Brown PetscValidHeaderSpecific(F,VEC_CLASSID,3); 22720f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,4); 22730f5c6efeSJed Brown ierr = (ts->ops->snesfunction)(snes,X,F,ts);CHKERRQ(ierr); 22740f5c6efeSJed Brown PetscFunctionReturn(0); 22750f5c6efeSJed Brown } 22760f5c6efeSJed Brown 22770f5c6efeSJed Brown #undef __FUNCT__ 22780f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian" 22790f5c6efeSJed Brown /*@ 22800f5c6efeSJed Brown SNESTSFormJacobian - Function to evaluate the Jacobian 22810f5c6efeSJed Brown 22820f5c6efeSJed Brown Collective on SNES 22830f5c6efeSJed Brown 22840f5c6efeSJed Brown Input Parameter: 22850f5c6efeSJed Brown + snes - nonlinear solver 22860f5c6efeSJed Brown . X - the current state at which to evaluate the residual 22870f5c6efeSJed Brown - ctx - user context, must be a TS 22880f5c6efeSJed Brown 22890f5c6efeSJed Brown Output Parameter: 22900f5c6efeSJed Brown + A - the Jacobian 22910f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A) 22920f5c6efeSJed Brown - flag - indicates any structure change in the matrix 22930f5c6efeSJed Brown 22940f5c6efeSJed Brown Notes: 22950f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 22960f5c6efeSJed Brown 22970f5c6efeSJed Brown Level: developer 22980f5c6efeSJed Brown 22990f5c6efeSJed Brown .seealso: SNESSetJacobian() 23000f5c6efeSJed Brown @*/ 23017087cfbeSBarry Smith PetscErrorCode SNESTSFormJacobian(SNES snes,Vec X,Mat *A,Mat *B,MatStructure *flag,void *ctx) 23020f5c6efeSJed Brown { 23030f5c6efeSJed Brown TS ts = (TS)ctx; 23040f5c6efeSJed Brown PetscErrorCode ierr; 23050f5c6efeSJed Brown 23060f5c6efeSJed Brown PetscFunctionBegin; 23070f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 23080f5c6efeSJed Brown PetscValidHeaderSpecific(X,VEC_CLASSID,2); 23090f5c6efeSJed Brown PetscValidPointer(A,3); 23100f5c6efeSJed Brown PetscValidHeaderSpecific(*A,MAT_CLASSID,3); 23110f5c6efeSJed Brown PetscValidPointer(B,4); 23120f5c6efeSJed Brown PetscValidHeaderSpecific(*B,MAT_CLASSID,4); 23130f5c6efeSJed Brown PetscValidPointer(flag,5); 23140f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,6); 23150f5c6efeSJed Brown ierr = (ts->ops->snesjacobian)(snes,X,A,B,flag,ts);CHKERRQ(ierr); 23160f5c6efeSJed Brown PetscFunctionReturn(0); 23170f5c6efeSJed Brown } 2318325fc9f4SBarry Smith 23190e4ef248SJed Brown #undef __FUNCT__ 23200e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear" 23210e4ef248SJed Brown /*@C 23220e4ef248SJed Brown TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only 23230e4ef248SJed Brown 23240e4ef248SJed Brown Collective on TS 23250e4ef248SJed Brown 23260e4ef248SJed Brown Input Arguments: 23270e4ef248SJed Brown + ts - time stepping context 23280e4ef248SJed Brown . t - time at which to evaluate 23290e4ef248SJed Brown . X - state at which to evaluate 23300e4ef248SJed Brown - ctx - context 23310e4ef248SJed Brown 23320e4ef248SJed Brown Output Arguments: 23330e4ef248SJed Brown . F - right hand side 23340e4ef248SJed Brown 23350e4ef248SJed Brown Level: intermediate 23360e4ef248SJed Brown 23370e4ef248SJed Brown Notes: 23380e4ef248SJed Brown This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems. 23390e4ef248SJed Brown The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian(). 23400e4ef248SJed Brown 23410e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 23420e4ef248SJed Brown @*/ 23430e4ef248SJed Brown PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec X,Vec F,void *ctx) 23440e4ef248SJed Brown { 23450e4ef248SJed Brown PetscErrorCode ierr; 23460e4ef248SJed Brown Mat Arhs,Brhs; 23470e4ef248SJed Brown MatStructure flg2; 23480e4ef248SJed Brown 23490e4ef248SJed Brown PetscFunctionBegin; 23500e4ef248SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 23510e4ef248SJed Brown ierr = TSComputeRHSJacobian(ts,t,X,&Arhs,&Brhs,&flg2);CHKERRQ(ierr); 23520e4ef248SJed Brown ierr = MatMult(Arhs,X,F);CHKERRQ(ierr); 23530e4ef248SJed Brown PetscFunctionReturn(0); 23540e4ef248SJed Brown } 23550e4ef248SJed Brown 23560e4ef248SJed Brown #undef __FUNCT__ 23570e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant" 23580e4ef248SJed Brown /*@C 23590e4ef248SJed Brown TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 23600e4ef248SJed Brown 23610e4ef248SJed Brown Collective on TS 23620e4ef248SJed Brown 23630e4ef248SJed Brown Input Arguments: 23640e4ef248SJed Brown + ts - time stepping context 23650e4ef248SJed Brown . t - time at which to evaluate 23660e4ef248SJed Brown . X - state at which to evaluate 23670e4ef248SJed Brown - ctx - context 23680e4ef248SJed Brown 23690e4ef248SJed Brown Output Arguments: 23700e4ef248SJed Brown + A - pointer to operator 23710e4ef248SJed Brown . B - pointer to preconditioning matrix 23720e4ef248SJed Brown - flg - matrix structure flag 23730e4ef248SJed Brown 23740e4ef248SJed Brown Level: intermediate 23750e4ef248SJed Brown 23760e4ef248SJed Brown Notes: 23770e4ef248SJed Brown This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems. 23780e4ef248SJed Brown 23790e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear() 23800e4ef248SJed Brown @*/ 23810e4ef248SJed Brown PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec X,Mat *A,Mat *B,MatStructure *flg,void *ctx) 23820e4ef248SJed Brown { 23830e4ef248SJed Brown 23840e4ef248SJed Brown PetscFunctionBegin; 23850e4ef248SJed Brown *flg = SAME_PRECONDITIONER; 23860e4ef248SJed Brown PetscFunctionReturn(0); 23870e4ef248SJed Brown } 23880e4ef248SJed Brown 23890026cea9SSean Farley #undef __FUNCT__ 23900026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear" 23910026cea9SSean Farley /*@C 23920026cea9SSean Farley TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 23930026cea9SSean Farley 23940026cea9SSean Farley Collective on TS 23950026cea9SSean Farley 23960026cea9SSean Farley Input Arguments: 23970026cea9SSean Farley + ts - time stepping context 23980026cea9SSean Farley . t - time at which to evaluate 23990026cea9SSean Farley . X - state at which to evaluate 24000026cea9SSean Farley . Xdot - time derivative of state vector 24010026cea9SSean Farley - ctx - context 24020026cea9SSean Farley 24030026cea9SSean Farley Output Arguments: 24040026cea9SSean Farley . F - left hand side 24050026cea9SSean Farley 24060026cea9SSean Farley Level: intermediate 24070026cea9SSean Farley 24080026cea9SSean Farley Notes: 24090026cea9SSean Farley The assumption here is that the left hand side is of the form A*Xdot (and not A*Xdot + B*X). For other cases, the 24100026cea9SSean Farley user is required to write their own TSComputeIFunction. 24110026cea9SSean Farley This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems. 24120026cea9SSean Farley The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian(). 24130026cea9SSean Farley 24140026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant() 24150026cea9SSean Farley @*/ 24160026cea9SSean Farley PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec X,Vec Xdot,Vec F,void *ctx) 24170026cea9SSean Farley { 24180026cea9SSean Farley PetscErrorCode ierr; 24190026cea9SSean Farley Mat A,B; 24200026cea9SSean Farley MatStructure flg2; 24210026cea9SSean Farley 24220026cea9SSean Farley PetscFunctionBegin; 24230026cea9SSean Farley ierr = TSGetIJacobian(ts,&A,&B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 24240026cea9SSean Farley ierr = TSComputeIJacobian(ts,t,X,Xdot,1.0,&A,&B,&flg2,PETSC_TRUE);CHKERRQ(ierr); 24250026cea9SSean Farley ierr = MatMult(A,Xdot,F);CHKERRQ(ierr); 24260026cea9SSean Farley PetscFunctionReturn(0); 24270026cea9SSean Farley } 24280026cea9SSean Farley 24290026cea9SSean Farley #undef __FUNCT__ 24300026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant" 24310026cea9SSean Farley /*@C 24320026cea9SSean Farley TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 24330026cea9SSean Farley 24340026cea9SSean Farley Collective on TS 24350026cea9SSean Farley 24360026cea9SSean Farley Input Arguments: 24370026cea9SSean Farley + ts - time stepping context 24380026cea9SSean Farley . t - time at which to evaluate 24390026cea9SSean Farley . X - state at which to evaluate 24400026cea9SSean Farley . Xdot - time derivative of state vector 24410026cea9SSean Farley . shift - shift to apply 24420026cea9SSean Farley - ctx - context 24430026cea9SSean Farley 24440026cea9SSean Farley Output Arguments: 24450026cea9SSean Farley + A - pointer to operator 24460026cea9SSean Farley . B - pointer to preconditioning matrix 24470026cea9SSean Farley - flg - matrix structure flag 24480026cea9SSean Farley 24490026cea9SSean Farley Level: intermediate 24500026cea9SSean Farley 24510026cea9SSean Farley Notes: 24520026cea9SSean Farley This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems. 24530026cea9SSean Farley 24540026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear() 24550026cea9SSean Farley @*/ 24560026cea9SSean Farley PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec X,Vec Xdot,PetscReal shift,Mat *A,Mat *B,MatStructure *flg,void *ctx) 24570026cea9SSean Farley { 24580026cea9SSean Farley 24590026cea9SSean Farley PetscFunctionBegin; 24600026cea9SSean Farley *flg = SAME_PRECONDITIONER; 24610026cea9SSean Farley PetscFunctionReturn(0); 24620026cea9SSean Farley } 24630026cea9SSean Farley 2464325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 2465c6db04a5SJed Brown #include <mex.h> 2466325fc9f4SBarry Smith 2467325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext; 2468325fc9f4SBarry Smith 2469325fc9f4SBarry Smith #undef __FUNCT__ 2470325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab" 2471325fc9f4SBarry Smith /* 2472325fc9f4SBarry Smith TSComputeFunction_Matlab - Calls the function that has been set with 2473325fc9f4SBarry Smith TSSetFunctionMatlab(). 2474325fc9f4SBarry Smith 2475325fc9f4SBarry Smith Collective on TS 2476325fc9f4SBarry Smith 2477325fc9f4SBarry Smith Input Parameters: 2478325fc9f4SBarry Smith + snes - the TS context 2479325fc9f4SBarry Smith - x - input vector 2480325fc9f4SBarry Smith 2481325fc9f4SBarry Smith Output Parameter: 2482325fc9f4SBarry Smith . y - function vector, as set by TSSetFunction() 2483325fc9f4SBarry Smith 2484325fc9f4SBarry Smith Notes: 2485325fc9f4SBarry Smith TSComputeFunction() is typically used within nonlinear solvers 2486325fc9f4SBarry Smith implementations, so most users would not generally call this routine 2487325fc9f4SBarry Smith themselves. 2488325fc9f4SBarry Smith 2489325fc9f4SBarry Smith Level: developer 2490325fc9f4SBarry Smith 2491325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 2492325fc9f4SBarry Smith 2493325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 2494325fc9f4SBarry Smith */ 24957087cfbeSBarry Smith PetscErrorCode TSComputeFunction_Matlab(TS snes,PetscReal time,Vec x,Vec xdot,Vec y, void *ctx) 2496325fc9f4SBarry Smith { 2497325fc9f4SBarry Smith PetscErrorCode ierr; 2498325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext *)ctx; 2499325fc9f4SBarry Smith int nlhs = 1,nrhs = 7; 2500325fc9f4SBarry Smith mxArray *plhs[1],*prhs[7]; 2501325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,ly = 0,ls = 0; 2502325fc9f4SBarry Smith 2503325fc9f4SBarry Smith PetscFunctionBegin; 2504325fc9f4SBarry Smith PetscValidHeaderSpecific(snes,TS_CLASSID,1); 2505325fc9f4SBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,3); 2506325fc9f4SBarry Smith PetscValidHeaderSpecific(xdot,VEC_CLASSID,4); 2507325fc9f4SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,5); 2508325fc9f4SBarry Smith PetscCheckSameComm(snes,1,x,3); 2509325fc9f4SBarry Smith PetscCheckSameComm(snes,1,y,5); 2510325fc9f4SBarry Smith 2511325fc9f4SBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 2512325fc9f4SBarry Smith ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr); 2513880f3077SBarry Smith ierr = PetscMemcpy(&lxdot,&xdot,sizeof(xdot));CHKERRQ(ierr); 2514325fc9f4SBarry Smith ierr = PetscMemcpy(&ly,&y,sizeof(x));CHKERRQ(ierr); 2515325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 2516325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar(time); 2517325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 2518325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 2519325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)ly); 2520325fc9f4SBarry Smith prhs[5] = mxCreateString(sctx->funcname); 2521325fc9f4SBarry Smith prhs[6] = sctx->ctx; 2522325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr); 2523325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 2524325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 2525325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 2526325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 2527325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 2528325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 2529325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 2530325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 2531325fc9f4SBarry Smith PetscFunctionReturn(0); 2532325fc9f4SBarry Smith } 2533325fc9f4SBarry Smith 2534325fc9f4SBarry Smith 2535325fc9f4SBarry Smith #undef __FUNCT__ 2536325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab" 2537325fc9f4SBarry Smith /* 2538325fc9f4SBarry Smith TSSetFunctionMatlab - Sets the function evaluation routine and function 2539325fc9f4SBarry Smith vector for use by the TS routines in solving ODEs 2540e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 2541325fc9f4SBarry Smith 2542325fc9f4SBarry Smith Logically Collective on TS 2543325fc9f4SBarry Smith 2544325fc9f4SBarry Smith Input Parameters: 2545325fc9f4SBarry Smith + ts - the TS context 2546325fc9f4SBarry Smith - func - function evaluation routine 2547325fc9f4SBarry Smith 2548325fc9f4SBarry Smith Calling sequence of func: 2549325fc9f4SBarry Smith $ func (TS ts,PetscReal time,Vec x,Vec xdot,Vec f,void *ctx); 2550325fc9f4SBarry Smith 2551325fc9f4SBarry Smith Level: beginner 2552325fc9f4SBarry Smith 2553325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 2554325fc9f4SBarry Smith 2555325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 2556325fc9f4SBarry Smith */ 25577087cfbeSBarry Smith PetscErrorCode TSSetFunctionMatlab(TS snes,const char *func,mxArray *ctx) 2558325fc9f4SBarry Smith { 2559325fc9f4SBarry Smith PetscErrorCode ierr; 2560325fc9f4SBarry Smith TSMatlabContext *sctx; 2561325fc9f4SBarry Smith 2562325fc9f4SBarry Smith PetscFunctionBegin; 2563325fc9f4SBarry Smith /* currently sctx is memory bleed */ 2564325fc9f4SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 2565325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 2566325fc9f4SBarry Smith /* 2567325fc9f4SBarry Smith This should work, but it doesn't 2568325fc9f4SBarry Smith sctx->ctx = ctx; 2569325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 2570325fc9f4SBarry Smith */ 2571325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 2572325fc9f4SBarry Smith ierr = TSSetIFunction(snes,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr); 2573325fc9f4SBarry Smith PetscFunctionReturn(0); 2574325fc9f4SBarry Smith } 2575325fc9f4SBarry Smith 2576325fc9f4SBarry Smith #undef __FUNCT__ 2577325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab" 2578325fc9f4SBarry Smith /* 2579325fc9f4SBarry Smith TSComputeJacobian_Matlab - Calls the function that has been set with 2580325fc9f4SBarry Smith TSSetJacobianMatlab(). 2581325fc9f4SBarry Smith 2582325fc9f4SBarry Smith Collective on TS 2583325fc9f4SBarry Smith 2584325fc9f4SBarry Smith Input Parameters: 2585325fc9f4SBarry Smith + snes - the TS context 2586325fc9f4SBarry Smith . x - input vector 2587325fc9f4SBarry Smith . A, B - the matrices 2588325fc9f4SBarry Smith - ctx - user context 2589325fc9f4SBarry Smith 2590325fc9f4SBarry Smith Output Parameter: 2591325fc9f4SBarry Smith . flag - structure of the matrix 2592325fc9f4SBarry Smith 2593325fc9f4SBarry Smith Level: developer 2594325fc9f4SBarry Smith 2595325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 2596325fc9f4SBarry Smith 2597325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 2598325fc9f4SBarry Smith @*/ 25997087cfbeSBarry Smith PetscErrorCode TSComputeJacobian_Matlab(TS snes,PetscReal time,Vec x,Vec xdot,PetscReal shift,Mat *A,Mat *B,MatStructure *flag, void *ctx) 2600325fc9f4SBarry Smith { 2601325fc9f4SBarry Smith PetscErrorCode ierr; 2602325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext *)ctx; 2603325fc9f4SBarry Smith int nlhs = 2,nrhs = 9; 2604325fc9f4SBarry Smith mxArray *plhs[2],*prhs[9]; 2605325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0; 2606325fc9f4SBarry Smith 2607325fc9f4SBarry Smith PetscFunctionBegin; 2608325fc9f4SBarry Smith PetscValidHeaderSpecific(snes,TS_CLASSID,1); 2609325fc9f4SBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,3); 2610325fc9f4SBarry Smith 2611325fc9f4SBarry Smith /* call Matlab function in ctx with arguments x and y */ 2612325fc9f4SBarry Smith 2613325fc9f4SBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 2614325fc9f4SBarry Smith ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr); 2615325fc9f4SBarry Smith ierr = PetscMemcpy(&lxdot,&xdot,sizeof(x));CHKERRQ(ierr); 2616325fc9f4SBarry Smith ierr = PetscMemcpy(&lA,A,sizeof(x));CHKERRQ(ierr); 2617325fc9f4SBarry Smith ierr = PetscMemcpy(&lB,B,sizeof(x));CHKERRQ(ierr); 2618325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 2619325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar((double)time); 2620325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 2621325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 2622325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)shift); 2623325fc9f4SBarry Smith prhs[5] = mxCreateDoubleScalar((double)lA); 2624325fc9f4SBarry Smith prhs[6] = mxCreateDoubleScalar((double)lB); 2625325fc9f4SBarry Smith prhs[7] = mxCreateString(sctx->funcname); 2626325fc9f4SBarry Smith prhs[8] = sctx->ctx; 2627325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr); 2628325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 2629325fc9f4SBarry Smith *flag = (MatStructure) mxGetScalar(plhs[1]);CHKERRQ(ierr); 2630325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 2631325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 2632325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 2633325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 2634325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 2635325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 2636325fc9f4SBarry Smith mxDestroyArray(prhs[6]); 2637325fc9f4SBarry Smith mxDestroyArray(prhs[7]); 2638325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 2639325fc9f4SBarry Smith mxDestroyArray(plhs[1]); 2640325fc9f4SBarry Smith PetscFunctionReturn(0); 2641325fc9f4SBarry Smith } 2642325fc9f4SBarry Smith 2643325fc9f4SBarry Smith 2644325fc9f4SBarry Smith #undef __FUNCT__ 2645325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab" 2646325fc9f4SBarry Smith /* 2647325fc9f4SBarry Smith TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 2648e3c5b3baSBarry 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 2649325fc9f4SBarry Smith 2650325fc9f4SBarry Smith Logically Collective on TS 2651325fc9f4SBarry Smith 2652325fc9f4SBarry Smith Input Parameters: 2653325fc9f4SBarry Smith + snes - the TS context 2654325fc9f4SBarry Smith . A,B - Jacobian matrices 2655325fc9f4SBarry Smith . func - function evaluation routine 2656325fc9f4SBarry Smith - ctx - user context 2657325fc9f4SBarry Smith 2658325fc9f4SBarry Smith Calling sequence of func: 2659325fc9f4SBarry Smith $ flag = func (TS snes,PetscReal time,Vec x,Vec xdot,Mat A,Mat B,void *ctx); 2660325fc9f4SBarry Smith 2661325fc9f4SBarry Smith 2662325fc9f4SBarry Smith Level: developer 2663325fc9f4SBarry Smith 2664325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 2665325fc9f4SBarry Smith 2666325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 2667325fc9f4SBarry Smith */ 26687087cfbeSBarry Smith PetscErrorCode TSSetJacobianMatlab(TS snes,Mat A,Mat B,const char *func,mxArray *ctx) 2669325fc9f4SBarry Smith { 2670325fc9f4SBarry Smith PetscErrorCode ierr; 2671325fc9f4SBarry Smith TSMatlabContext *sctx; 2672325fc9f4SBarry Smith 2673325fc9f4SBarry Smith PetscFunctionBegin; 2674325fc9f4SBarry Smith /* currently sctx is memory bleed */ 2675325fc9f4SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 2676325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 2677325fc9f4SBarry Smith /* 2678325fc9f4SBarry Smith This should work, but it doesn't 2679325fc9f4SBarry Smith sctx->ctx = ctx; 2680325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 2681325fc9f4SBarry Smith */ 2682325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 2683325fc9f4SBarry Smith ierr = TSSetIJacobian(snes,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 2684325fc9f4SBarry Smith PetscFunctionReturn(0); 2685325fc9f4SBarry Smith } 2686325fc9f4SBarry Smith 2687b5b1a830SBarry Smith #undef __FUNCT__ 2688b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab" 2689b5b1a830SBarry Smith /* 2690b5b1a830SBarry Smith TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab(). 2691b5b1a830SBarry Smith 2692b5b1a830SBarry Smith Collective on TS 2693b5b1a830SBarry Smith 2694b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 2695b5b1a830SBarry Smith @*/ 26967087cfbeSBarry Smith PetscErrorCode TSMonitor_Matlab(TS snes,PetscInt it, PetscReal time,Vec x, void *ctx) 2697b5b1a830SBarry Smith { 2698b5b1a830SBarry Smith PetscErrorCode ierr; 2699b5b1a830SBarry Smith TSMatlabContext *sctx = (TSMatlabContext *)ctx; 2700a530c242SBarry Smith int nlhs = 1,nrhs = 6; 2701b5b1a830SBarry Smith mxArray *plhs[1],*prhs[6]; 2702b5b1a830SBarry Smith long long int lx = 0,ls = 0; 2703b5b1a830SBarry Smith 2704b5b1a830SBarry Smith PetscFunctionBegin; 2705b5b1a830SBarry Smith PetscValidHeaderSpecific(snes,TS_CLASSID,1); 2706b5b1a830SBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,4); 2707b5b1a830SBarry Smith 2708b5b1a830SBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 2709b5b1a830SBarry Smith ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr); 2710b5b1a830SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 2711b5b1a830SBarry Smith prhs[1] = mxCreateDoubleScalar((double)it); 2712b5b1a830SBarry Smith prhs[2] = mxCreateDoubleScalar((double)time); 2713b5b1a830SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lx); 2714b5b1a830SBarry Smith prhs[4] = mxCreateString(sctx->funcname); 2715b5b1a830SBarry Smith prhs[5] = sctx->ctx; 2716b5b1a830SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr); 2717b5b1a830SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 2718b5b1a830SBarry Smith mxDestroyArray(prhs[0]); 2719b5b1a830SBarry Smith mxDestroyArray(prhs[1]); 2720b5b1a830SBarry Smith mxDestroyArray(prhs[2]); 2721b5b1a830SBarry Smith mxDestroyArray(prhs[3]); 2722b5b1a830SBarry Smith mxDestroyArray(prhs[4]); 2723b5b1a830SBarry Smith mxDestroyArray(plhs[0]); 2724b5b1a830SBarry Smith PetscFunctionReturn(0); 2725b5b1a830SBarry Smith } 2726b5b1a830SBarry Smith 2727b5b1a830SBarry Smith 2728b5b1a830SBarry Smith #undef __FUNCT__ 2729b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab" 2730b5b1a830SBarry Smith /* 2731b5b1a830SBarry Smith TSMonitorSetMatlab - Sets the monitor function from Matlab 2732b5b1a830SBarry Smith 2733b5b1a830SBarry Smith Level: developer 2734b5b1a830SBarry Smith 2735b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function 2736b5b1a830SBarry Smith 2737b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 2738b5b1a830SBarry Smith */ 27397087cfbeSBarry Smith PetscErrorCode TSMonitorSetMatlab(TS snes,const char *func,mxArray *ctx) 2740b5b1a830SBarry Smith { 2741b5b1a830SBarry Smith PetscErrorCode ierr; 2742b5b1a830SBarry Smith TSMatlabContext *sctx; 2743b5b1a830SBarry Smith 2744b5b1a830SBarry Smith PetscFunctionBegin; 2745b5b1a830SBarry Smith /* currently sctx is memory bleed */ 2746b5b1a830SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 2747b5b1a830SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 2748b5b1a830SBarry Smith /* 2749b5b1a830SBarry Smith This should work, but it doesn't 2750b5b1a830SBarry Smith sctx->ctx = ctx; 2751b5b1a830SBarry Smith mexMakeArrayPersistent(sctx->ctx); 2752b5b1a830SBarry Smith */ 2753b5b1a830SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 2754b5b1a830SBarry Smith ierr = TSMonitorSet(snes,TSMonitor_Matlab,sctx,PETSC_NULL);CHKERRQ(ierr); 2755b5b1a830SBarry Smith PetscFunctionReturn(0); 2756b5b1a830SBarry Smith } 2757b5b1a830SBarry Smith 2758325fc9f4SBarry Smith #endif 2759