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 603bca7d26SBarry Smith . -ts_final_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 { 73ace3abfcSBarry Smith PetscBool opt,flg; 74dfbe8321SBarry Smith PetscErrorCode ierr; 75649052a6SBarry Smith PetscViewer monviewer; 76eabae89aSBarry Smith char monfilename[PETSC_MAX_PATH_LEN]; 77089b2837SJed Brown SNES snes; 781c3436cfSJed Brown TSAdapt adapt; 79bdad233fSMatthew Knepley 80bdad233fSMatthew Knepley PetscFunctionBegin; 810700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 823194b578SJed Brown ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr); 83a43b19c4SJed Brown /* Handle TS type options */ 84a43b19c4SJed Brown ierr = TSSetTypeFromOptions(ts);CHKERRQ(ierr); 85bdad233fSMatthew Knepley 86bdad233fSMatthew Knepley /* Handle generic TS options */ 87bdad233fSMatthew Knepley ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,PETSC_NULL);CHKERRQ(ierr); 883bca7d26SBarry Smith ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,PETSC_NULL);CHKERRQ(ierr); 89d8cd7023SBarry Smith ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,PETSC_NULL);CHKERRQ(ierr); 90d8cd7023SBarry Smith ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&ts->time_step,PETSC_NULL);CHKERRQ(ierr); 91a43b19c4SJed Brown opt = ts->exact_final_time == PETSC_DECIDE ? PETSC_FALSE : (PetscBool)ts->exact_final_time; 92a43b19c4SJed Brown ierr = PetscOptionsBool("-ts_exact_final_time","Interpolate output to stop exactly at the final time","TSSetExactFinalTime",opt,&opt,&flg);CHKERRQ(ierr); 93461e00b3SSean Farley if (flg) {ierr = TSSetExactFinalTime(ts,opt);CHKERRQ(ierr);} 94193ac0bcSJed 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); 95193ac0bcSJed Brown ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections","",ts->max_reject,&ts->max_reject,PETSC_NULL);CHKERRQ(ierr); 96193ac0bcSJed Brown ierr = PetscOptionsBool("-ts_error_if_step_failed","Error if no step succeeds","",ts->errorifstepfailed,&ts->errorifstepfailed,PETSC_NULL);CHKERRQ(ierr); 971c3436cfSJed Brown ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,PETSC_NULL);CHKERRQ(ierr); 981c3436cfSJed Brown ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,PETSC_NULL);CHKERRQ(ierr); 99bdad233fSMatthew Knepley 100bdad233fSMatthew Knepley /* Monitor options */ 101a6570f20SBarry Smith ierr = PetscOptionsString("-ts_monitor","Monitor timestep size","TSMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 102eabae89aSBarry Smith if (flg) { 103649052a6SBarry Smith ierr = PetscViewerASCIIOpen(((PetscObject)ts)->comm,monfilename,&monviewer);CHKERRQ(ierr); 104649052a6SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 105bdad233fSMatthew Knepley } 1065180491cSLisandro Dalcin ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 1075180491cSLisandro Dalcin if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);} 1085180491cSLisandro Dalcin 10990d69ab7SBarry Smith opt = PETSC_FALSE; 110acfcf0e5SJed Brown ierr = PetscOptionsBool("-ts_monitor_draw","Monitor timestep size graphically","TSMonitorLG",opt,&opt,PETSC_NULL);CHKERRQ(ierr); 111a7cc72afSBarry Smith if (opt) { 112a6570f20SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLG,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 113bdad233fSMatthew Knepley } 11490d69ab7SBarry Smith opt = PETSC_FALSE; 115acfcf0e5SJed Brown ierr = PetscOptionsBool("-ts_monitor_solution","Monitor solution graphically","TSMonitorSolution",opt,&opt,PETSC_NULL);CHKERRQ(ierr); 116a7cc72afSBarry Smith if (opt) { 1176083293cSBarry Smith void *ctx; 1186083293cSBarry Smith ierr = TSMonitorSolutionCreate(ts,PETSC_NULL,&ctx);CHKERRQ(ierr); 1196083293cSBarry Smith ierr = TSMonitorSet(ts,TSMonitorSolution,ctx,TSMonitorSolutionDestroy);CHKERRQ(ierr); 120bdad233fSMatthew Knepley } 121fb1732b5SBarry Smith opt = PETSC_FALSE; 122fb1732b5SBarry Smith ierr = PetscOptionsString("-ts_monitor_solution_binary","Save each solution to a binary file","TSMonitorSolutionBinary",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 123fb1732b5SBarry Smith if (flg) { 124fb1732b5SBarry Smith PetscViewer ctx; 125fb1732b5SBarry Smith if (monfilename[0]) { 126fb1732b5SBarry Smith ierr = PetscViewerBinaryOpen(((PetscObject)ts)->comm,monfilename,FILE_MODE_WRITE,&ctx);CHKERRQ(ierr); 127fb1732b5SBarry Smith } else { 128fb1732b5SBarry Smith ctx = PETSC_VIEWER_BINARY_(((PetscObject)ts)->comm); 129fb1732b5SBarry Smith } 130fb1732b5SBarry Smith ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 131fb1732b5SBarry Smith } 132ed81e22dSJed Brown opt = PETSC_FALSE; 133ed81e22dSJed Brown ierr = PetscOptionsString("-ts_monitor_solution_vtk","Save each time step to a binary file, use filename-%%03D.vts","TSMonitorSolutionVTK",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 134ed81e22dSJed Brown if (flg) { 135ed81e22dSJed Brown const char *ptr,*ptr2; 136ed81e22dSJed Brown char *filetemplate; 137ed81e22dSJed Brown if (!monfilename[0]) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 138ed81e22dSJed Brown /* Do some cursory validation of the input. */ 139ed81e22dSJed Brown ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr); 140ed81e22dSJed Brown if (!ptr) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 141ed81e22dSJed Brown for (ptr++ ; ptr && *ptr; ptr++) { 142ed81e22dSJed Brown ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr); 143ed81e22dSJed Brown if (!ptr2 && (*ptr < '0' || '9' < *ptr)) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Invalid file template argument to -ts_monitor_solution_vtk, should look like filename-%%03D.vts"); 144ed81e22dSJed Brown if (ptr2) break; 145ed81e22dSJed Brown } 146ed81e22dSJed Brown ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr); 147ed81e22dSJed Brown ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr); 148ed81e22dSJed Brown } 149bdad233fSMatthew Knepley 1501c3436cfSJed Brown ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr); 1511c3436cfSJed Brown ierr = TSAdaptSetFromOptions(adapt);CHKERRQ(ierr); 1521c3436cfSJed Brown 153d52bd9f3SBarry Smith ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 154d52bd9f3SBarry Smith if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);} 155d52bd9f3SBarry Smith 156bdad233fSMatthew Knepley /* Handle specific TS options */ 157abc0a331SBarry Smith if (ts->ops->setfromoptions) { 158bdad233fSMatthew Knepley ierr = (*ts->ops->setfromoptions)(ts);CHKERRQ(ierr); 159bdad233fSMatthew Knepley } 1605d973c19SBarry Smith 1615d973c19SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 1625d973c19SBarry Smith ierr = PetscObjectProcessOptionsHandlers((PetscObject)ts);CHKERRQ(ierr); 163bdad233fSMatthew Knepley ierr = PetscOptionsEnd();CHKERRQ(ierr); 164bdad233fSMatthew Knepley PetscFunctionReturn(0); 165bdad233fSMatthew Knepley } 166bdad233fSMatthew Knepley 167bdad233fSMatthew Knepley #undef __FUNCT__ 168cdcf91faSSean Farley #undef __FUNCT__ 1694a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSJacobian" 170a7a1495cSBarry Smith /*@ 1718c385f81SBarry Smith TSComputeRHSJacobian - Computes the Jacobian matrix that has been 172a7a1495cSBarry Smith set with TSSetRHSJacobian(). 173a7a1495cSBarry Smith 174a7a1495cSBarry Smith Collective on TS and Vec 175a7a1495cSBarry Smith 176a7a1495cSBarry Smith Input Parameters: 177316643e7SJed Brown + ts - the TS context 178a7a1495cSBarry Smith . t - current timestep 179a7a1495cSBarry Smith - x - input vector 180a7a1495cSBarry Smith 181a7a1495cSBarry Smith Output Parameters: 182a7a1495cSBarry Smith + A - Jacobian matrix 183a7a1495cSBarry Smith . B - optional preconditioning matrix 184a7a1495cSBarry Smith - flag - flag indicating matrix structure 185a7a1495cSBarry Smith 186a7a1495cSBarry Smith Notes: 187a7a1495cSBarry Smith Most users should not need to explicitly call this routine, as it 188a7a1495cSBarry Smith is used internally within the nonlinear solvers. 189a7a1495cSBarry Smith 19094b7f48cSBarry Smith See KSPSetOperators() for important information about setting the 191a7a1495cSBarry Smith flag parameter. 192a7a1495cSBarry Smith 193a7a1495cSBarry Smith Level: developer 194a7a1495cSBarry Smith 195a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix 196a7a1495cSBarry Smith 19794b7f48cSBarry Smith .seealso: TSSetRHSJacobian(), KSPSetOperators() 198a7a1495cSBarry Smith @*/ 1997087cfbeSBarry Smith PetscErrorCode TSComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat *A,Mat *B,MatStructure *flg) 200a7a1495cSBarry Smith { 201dfbe8321SBarry Smith PetscErrorCode ierr; 2020e4ef248SJed Brown PetscInt Xstate; 203a7a1495cSBarry Smith 204a7a1495cSBarry Smith PetscFunctionBegin; 2050700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2060700a824SBarry Smith PetscValidHeaderSpecific(X,VEC_CLASSID,3); 207c9780b6fSBarry Smith PetscCheckSameComm(ts,1,X,3); 2080e4ef248SJed Brown ierr = PetscObjectStateQuery((PetscObject)X,&Xstate);CHKERRQ(ierr); 2090e4ef248SJed Brown if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == X && ts->rhsjacobian.Xstate == Xstate))) { 2100e4ef248SJed Brown *flg = ts->rhsjacobian.mstructure; 2110e4ef248SJed Brown PetscFunctionReturn(0); 212f8ede8e7SJed Brown } 213d90be118SSean Farley 2143b5f76d0SSean Farley if (!ts->userops->rhsjacobian && !ts->userops->ijacobian) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 215d90be118SSean Farley 2163b5f76d0SSean Farley if (ts->userops->rhsjacobian) { 217d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_JacobianEval,ts,X,*A,*B);CHKERRQ(ierr); 218a7a1495cSBarry Smith *flg = DIFFERENT_NONZERO_PATTERN; 219a7a1495cSBarry Smith PetscStackPush("TS user Jacobian function"); 2203b5f76d0SSean Farley ierr = (*ts->userops->rhsjacobian)(ts,t,X,A,B,flg,ts->jacP);CHKERRQ(ierr); 221a7a1495cSBarry Smith PetscStackPop; 222d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_JacobianEval,ts,X,*A,*B);CHKERRQ(ierr); 223a7a1495cSBarry Smith /* make sure user returned a correct Jacobian and preconditioner */ 2240700a824SBarry Smith PetscValidHeaderSpecific(*A,MAT_CLASSID,4); 2250700a824SBarry Smith PetscValidHeaderSpecific(*B,MAT_CLASSID,5); 226ef66eb69SBarry Smith } else { 227214bc6a2SJed Brown ierr = MatZeroEntries(*A);CHKERRQ(ierr); 228214bc6a2SJed Brown if (*A != *B) {ierr = MatZeroEntries(*B);CHKERRQ(ierr);} 229214bc6a2SJed Brown *flg = SAME_NONZERO_PATTERN; 230ef66eb69SBarry Smith } 2310e4ef248SJed Brown ts->rhsjacobian.time = t; 2320e4ef248SJed Brown ts->rhsjacobian.X = X; 2330e4ef248SJed Brown ierr = PetscObjectStateQuery((PetscObject)X,&ts->rhsjacobian.Xstate);CHKERRQ(ierr); 2340e4ef248SJed Brown ts->rhsjacobian.mstructure = *flg; 235a7a1495cSBarry Smith PetscFunctionReturn(0); 236a7a1495cSBarry Smith } 237a7a1495cSBarry Smith 2384a2ae208SSatish Balay #undef __FUNCT__ 2394a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction" 240316643e7SJed Brown /*@ 241d763cef2SBarry Smith TSComputeRHSFunction - Evaluates the right-hand-side function. 242d763cef2SBarry Smith 243316643e7SJed Brown Collective on TS and Vec 244316643e7SJed Brown 245316643e7SJed Brown Input Parameters: 246316643e7SJed Brown + ts - the TS context 247316643e7SJed Brown . t - current time 248316643e7SJed Brown - x - state vector 249316643e7SJed Brown 250316643e7SJed Brown Output Parameter: 251316643e7SJed Brown . y - right hand side 252316643e7SJed Brown 253316643e7SJed Brown Note: 254316643e7SJed Brown Most users should not need to explicitly call this routine, as it 255316643e7SJed Brown is used internally within the nonlinear solvers. 256316643e7SJed Brown 257316643e7SJed Brown Level: developer 258316643e7SJed Brown 259316643e7SJed Brown .keywords: TS, compute 260316643e7SJed Brown 261316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction() 262316643e7SJed Brown @*/ 263dfbe8321SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec x,Vec y) 264d763cef2SBarry Smith { 265dfbe8321SBarry Smith PetscErrorCode ierr; 266d763cef2SBarry Smith 267d763cef2SBarry Smith PetscFunctionBegin; 2680700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2690700a824SBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,3); 2700700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,4); 271d763cef2SBarry Smith 2723b5f76d0SSean Farley if (!ts->userops->rhsfunction && !ts->userops->ifunction) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 273d763cef2SBarry Smith 274d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_FunctionEval,ts,x,y,0);CHKERRQ(ierr); 2753b5f76d0SSean Farley if (ts->userops->rhsfunction) { 276d763cef2SBarry Smith PetscStackPush("TS user right-hand-side function"); 2773b5f76d0SSean Farley ierr = (*ts->userops->rhsfunction)(ts,t,x,y,ts->funP);CHKERRQ(ierr); 278d763cef2SBarry Smith PetscStackPop; 279214bc6a2SJed Brown } else { 280214bc6a2SJed Brown ierr = VecZeroEntries(y);CHKERRQ(ierr); 281b2cd27e8SJed Brown } 28244a41b28SSean Farley 283d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_FunctionEval,ts,x,y,0);CHKERRQ(ierr); 284d763cef2SBarry Smith PetscFunctionReturn(0); 285d763cef2SBarry Smith } 286d763cef2SBarry Smith 2874a2ae208SSatish Balay #undef __FUNCT__ 288214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private" 289214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs) 290214bc6a2SJed Brown { 2912dd45cf8SJed Brown Vec F; 292214bc6a2SJed Brown PetscErrorCode ierr; 293214bc6a2SJed Brown 294214bc6a2SJed Brown PetscFunctionBegin; 2950da9a4f0SJed Brown *Frhs = PETSC_NULL; 2962dd45cf8SJed Brown ierr = TSGetIFunction(ts,&F,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 297214bc6a2SJed Brown if (!ts->Frhs) { 2982dd45cf8SJed Brown ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr); 299214bc6a2SJed Brown } 300214bc6a2SJed Brown *Frhs = ts->Frhs; 301214bc6a2SJed Brown PetscFunctionReturn(0); 302214bc6a2SJed Brown } 303214bc6a2SJed Brown 304214bc6a2SJed Brown #undef __FUNCT__ 305214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private" 306214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs) 307214bc6a2SJed Brown { 308214bc6a2SJed Brown Mat A,B; 3092dd45cf8SJed Brown PetscErrorCode ierr; 310214bc6a2SJed Brown 311214bc6a2SJed Brown PetscFunctionBegin; 312214bc6a2SJed Brown ierr = TSGetIJacobian(ts,&A,&B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 313214bc6a2SJed Brown if (Arhs) { 314214bc6a2SJed Brown if (!ts->Arhs) { 315214bc6a2SJed Brown ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr); 316214bc6a2SJed Brown } 317214bc6a2SJed Brown *Arhs = ts->Arhs; 318214bc6a2SJed Brown } 319214bc6a2SJed Brown if (Brhs) { 320214bc6a2SJed Brown if (!ts->Brhs) { 321214bc6a2SJed Brown ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr); 322214bc6a2SJed Brown } 323214bc6a2SJed Brown *Brhs = ts->Brhs; 324214bc6a2SJed Brown } 325214bc6a2SJed Brown PetscFunctionReturn(0); 326214bc6a2SJed Brown } 327214bc6a2SJed Brown 328214bc6a2SJed Brown #undef __FUNCT__ 329316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction" 330316643e7SJed Brown /*@ 331316643e7SJed Brown TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,X,Xdot)=0 332316643e7SJed Brown 333316643e7SJed Brown Collective on TS and Vec 334316643e7SJed Brown 335316643e7SJed Brown Input Parameters: 336316643e7SJed Brown + ts - the TS context 337316643e7SJed Brown . t - current time 338316643e7SJed Brown . X - state vector 339214bc6a2SJed Brown . Xdot - time derivative of state vector 340214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate 341316643e7SJed Brown 342316643e7SJed Brown Output Parameter: 343316643e7SJed Brown . Y - right hand side 344316643e7SJed Brown 345316643e7SJed Brown Note: 346316643e7SJed Brown Most users should not need to explicitly call this routine, as it 347316643e7SJed Brown is used internally within the nonlinear solvers. 348316643e7SJed Brown 349316643e7SJed Brown If the user did did not write their equations in implicit form, this 350316643e7SJed Brown function recasts them in implicit form. 351316643e7SJed Brown 352316643e7SJed Brown Level: developer 353316643e7SJed Brown 354316643e7SJed Brown .keywords: TS, compute 355316643e7SJed Brown 356316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction() 357316643e7SJed Brown @*/ 358214bc6a2SJed Brown PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec X,Vec Xdot,Vec Y,PetscBool imex) 359316643e7SJed Brown { 360316643e7SJed Brown PetscErrorCode ierr; 361316643e7SJed Brown 362316643e7SJed Brown PetscFunctionBegin; 3630700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3640700a824SBarry Smith PetscValidHeaderSpecific(X,VEC_CLASSID,3); 3650700a824SBarry Smith PetscValidHeaderSpecific(Xdot,VEC_CLASSID,4); 3660700a824SBarry Smith PetscValidHeaderSpecific(Y,VEC_CLASSID,5); 367316643e7SJed Brown 368d90be118SSean Farley if (!ts->userops->rhsfunction && !ts->userops->ifunction) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 369d90be118SSean Farley 370316643e7SJed Brown ierr = PetscLogEventBegin(TS_FunctionEval,ts,X,Xdot,Y);CHKERRQ(ierr); 3713b5f76d0SSean Farley if (ts->userops->ifunction) { 372316643e7SJed Brown PetscStackPush("TS user implicit function"); 3733b5f76d0SSean Farley ierr = (*ts->userops->ifunction)(ts,t,X,Xdot,Y,ts->funP);CHKERRQ(ierr); 374316643e7SJed Brown PetscStackPop; 375214bc6a2SJed Brown } 376214bc6a2SJed Brown if (imex) { 3773b5f76d0SSean Farley if (!ts->userops->ifunction) { 3782dd45cf8SJed Brown ierr = VecCopy(Xdot,Y);CHKERRQ(ierr); 3792dd45cf8SJed Brown } 3802dd45cf8SJed Brown } else if (ts->userops->rhsfunction) { 3812dd45cf8SJed Brown if (ts->userops->ifunction) { 382214bc6a2SJed Brown Vec Frhs; 383214bc6a2SJed Brown ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 384214bc6a2SJed Brown ierr = TSComputeRHSFunction(ts,t,X,Frhs);CHKERRQ(ierr); 385214bc6a2SJed Brown ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr); 3862dd45cf8SJed Brown } else { 3872dd45cf8SJed Brown ierr = TSComputeRHSFunction(ts,t,X,Y);CHKERRQ(ierr); 3882dd45cf8SJed Brown ierr = VecAYPX(Y,-1,Xdot);CHKERRQ(ierr); 389316643e7SJed Brown } 3904a6899ffSJed Brown } 391316643e7SJed Brown ierr = PetscLogEventEnd(TS_FunctionEval,ts,X,Xdot,Y);CHKERRQ(ierr); 392316643e7SJed Brown PetscFunctionReturn(0); 393316643e7SJed Brown } 394316643e7SJed Brown 395316643e7SJed Brown #undef __FUNCT__ 396316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian" 397316643e7SJed Brown /*@ 398316643e7SJed Brown TSComputeIJacobian - Evaluates the Jacobian of the DAE 399316643e7SJed Brown 400316643e7SJed Brown Collective on TS and Vec 401316643e7SJed Brown 402316643e7SJed Brown Input 403316643e7SJed Brown Input Parameters: 404316643e7SJed Brown + ts - the TS context 405316643e7SJed Brown . t - current timestep 406316643e7SJed Brown . X - state vector 407316643e7SJed Brown . Xdot - time derivative of state vector 408214bc6a2SJed Brown . shift - shift to apply, see note below 409214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate 410316643e7SJed Brown 411316643e7SJed Brown Output Parameters: 412316643e7SJed Brown + A - Jacobian matrix 413316643e7SJed Brown . B - optional preconditioning matrix 414316643e7SJed Brown - flag - flag indicating matrix structure 415316643e7SJed Brown 416316643e7SJed Brown Notes: 417316643e7SJed Brown If F(t,X,Xdot)=0 is the DAE, the required Jacobian is 418316643e7SJed Brown 419316643e7SJed Brown dF/dX + shift*dF/dXdot 420316643e7SJed Brown 421316643e7SJed Brown Most users should not need to explicitly call this routine, as it 422316643e7SJed Brown is used internally within the nonlinear solvers. 423316643e7SJed Brown 424316643e7SJed Brown Level: developer 425316643e7SJed Brown 426316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix 427316643e7SJed Brown 428316643e7SJed Brown .seealso: TSSetIJacobian() 42963495f91SJed Brown @*/ 430214bc6a2SJed Brown PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec X,Vec Xdot,PetscReal shift,Mat *A,Mat *B,MatStructure *flg,PetscBool imex) 431316643e7SJed Brown { 4320026cea9SSean Farley PetscInt Xstate, Xdotstate; 433316643e7SJed Brown PetscErrorCode ierr; 434316643e7SJed Brown 435316643e7SJed Brown PetscFunctionBegin; 4360700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4370700a824SBarry Smith PetscValidHeaderSpecific(X,VEC_CLASSID,3); 4380700a824SBarry Smith PetscValidHeaderSpecific(Xdot,VEC_CLASSID,4); 439316643e7SJed Brown PetscValidPointer(A,6); 4400700a824SBarry Smith PetscValidHeaderSpecific(*A,MAT_CLASSID,6); 441316643e7SJed Brown PetscValidPointer(B,7); 4420700a824SBarry Smith PetscValidHeaderSpecific(*B,MAT_CLASSID,7); 443316643e7SJed Brown PetscValidPointer(flg,8); 4440026cea9SSean Farley ierr = PetscObjectStateQuery((PetscObject)X,&Xstate);CHKERRQ(ierr); 4450026cea9SSean Farley ierr = PetscObjectStateQuery((PetscObject)Xdot,&Xdotstate);CHKERRQ(ierr); 4460026cea9SSean 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))) { 4470026cea9SSean Farley *flg = ts->ijacobian.mstructure; 4480026cea9SSean Farley ierr = MatScale(*A, shift / ts->ijacobian.shift);CHKERRQ(ierr); 4490026cea9SSean Farley PetscFunctionReturn(0); 4500026cea9SSean Farley } 451316643e7SJed Brown 4523b5f76d0SSean Farley if (!ts->userops->rhsjacobian && !ts->userops->ijacobian) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 453316643e7SJed Brown 4544e684422SJed Brown *flg = SAME_NONZERO_PATTERN; /* In case we're solving a linear problem in which case it wouldn't get initialized below. */ 455316643e7SJed Brown ierr = PetscLogEventBegin(TS_JacobianEval,ts,X,*A,*B);CHKERRQ(ierr); 4563b5f76d0SSean Farley if (ts->userops->ijacobian) { 4572dd45cf8SJed Brown *flg = DIFFERENT_NONZERO_PATTERN; 458316643e7SJed Brown PetscStackPush("TS user implicit Jacobian"); 4593b5f76d0SSean Farley ierr = (*ts->userops->ijacobian)(ts,t,X,Xdot,shift,A,B,flg,ts->jacP);CHKERRQ(ierr); 460316643e7SJed Brown PetscStackPop; 461214bc6a2SJed Brown /* make sure user returned a correct Jacobian and preconditioner */ 462214bc6a2SJed Brown PetscValidHeaderSpecific(*A,MAT_CLASSID,4); 463214bc6a2SJed Brown PetscValidHeaderSpecific(*B,MAT_CLASSID,5); 4644a6899ffSJed Brown } 465214bc6a2SJed Brown if (imex) { 4663b5f76d0SSean Farley if (!ts->userops->ijacobian) { /* system was written as Xdot = F(t,X) */ 467214bc6a2SJed Brown ierr = MatZeroEntries(*A);CHKERRQ(ierr); 4682dd45cf8SJed Brown ierr = MatShift(*A,shift);CHKERRQ(ierr); 469214bc6a2SJed Brown if (*A != *B) { 470214bc6a2SJed Brown ierr = MatZeroEntries(*B);CHKERRQ(ierr); 471214bc6a2SJed Brown ierr = MatShift(*B,shift);CHKERRQ(ierr); 472214bc6a2SJed Brown } 473214bc6a2SJed Brown *flg = SAME_PRECONDITIONER; 474214bc6a2SJed Brown } 475214bc6a2SJed Brown } else { 4763b5f76d0SSean Farley if (!ts->userops->ijacobian) { 477214bc6a2SJed Brown ierr = TSComputeRHSJacobian(ts,t,X,A,B,flg);CHKERRQ(ierr); 478214bc6a2SJed Brown ierr = MatScale(*A,-1);CHKERRQ(ierr); 479214bc6a2SJed Brown ierr = MatShift(*A,shift);CHKERRQ(ierr); 480316643e7SJed Brown if (*A != *B) { 481316643e7SJed Brown ierr = MatScale(*B,-1);CHKERRQ(ierr); 482316643e7SJed Brown ierr = MatShift(*B,shift);CHKERRQ(ierr); 483316643e7SJed Brown } 4843b5f76d0SSean Farley } else if (ts->userops->rhsjacobian) { 485214bc6a2SJed Brown Mat Arhs,Brhs; 486214bc6a2SJed Brown MatStructure axpy,flg2 = DIFFERENT_NONZERO_PATTERN; 487214bc6a2SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 488214bc6a2SJed Brown ierr = TSComputeRHSJacobian(ts,t,X,&Arhs,&Brhs,&flg2);CHKERRQ(ierr); 489214bc6a2SJed Brown axpy = (*flg == flg2) ? SAME_NONZERO_PATTERN : DIFFERENT_NONZERO_PATTERN; 490214bc6a2SJed Brown ierr = MatAXPY(*A,-1,Arhs,axpy);CHKERRQ(ierr); 491214bc6a2SJed Brown if (*A != *B) { 492214bc6a2SJed Brown ierr = MatAXPY(*B,-1,Brhs,axpy);CHKERRQ(ierr); 493214bc6a2SJed Brown } 494214bc6a2SJed Brown *flg = PetscMin(*flg,flg2); 495214bc6a2SJed Brown } 496316643e7SJed Brown } 4970026cea9SSean Farley 4980026cea9SSean Farley ts->ijacobian.time = t; 4990026cea9SSean Farley ts->ijacobian.X = X; 5000026cea9SSean Farley ts->ijacobian.Xdot = Xdot; 5010026cea9SSean Farley ierr = PetscObjectStateQuery((PetscObject)X,&ts->ijacobian.Xstate);CHKERRQ(ierr); 5020026cea9SSean Farley ierr = PetscObjectStateQuery((PetscObject)Xdot,&ts->ijacobian.Xdotstate);CHKERRQ(ierr); 5030026cea9SSean Farley ts->ijacobian.shift = shift; 5040026cea9SSean Farley ts->ijacobian.imex = imex; 5050026cea9SSean Farley ts->ijacobian.mstructure = *flg; 506316643e7SJed Brown ierr = PetscLogEventEnd(TS_JacobianEval,ts,X,*A,*B);CHKERRQ(ierr); 507316643e7SJed Brown PetscFunctionReturn(0); 508316643e7SJed Brown } 509316643e7SJed Brown 510316643e7SJed Brown #undef __FUNCT__ 5114a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction" 512d763cef2SBarry Smith /*@C 513d763cef2SBarry Smith TSSetRHSFunction - Sets the routine for evaluating the function, 514d763cef2SBarry Smith F(t,u), where U_t = F(t,u). 515d763cef2SBarry Smith 5163f9fe445SBarry Smith Logically Collective on TS 517d763cef2SBarry Smith 518d763cef2SBarry Smith Input Parameters: 519d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 520ca94891dSJed Brown . r - vector to put the computed right hand side (or PETSC_NULL to have it created) 521d763cef2SBarry Smith . f - routine for evaluating the right-hand-side function 522d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 523d763cef2SBarry Smith function evaluation routine (may be PETSC_NULL) 524d763cef2SBarry Smith 525d763cef2SBarry Smith Calling sequence of func: 52687828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Vec F,void *ctx); 527d763cef2SBarry Smith 528d763cef2SBarry Smith + t - current timestep 529d763cef2SBarry Smith . u - input vector 530d763cef2SBarry Smith . F - function vector 531d763cef2SBarry Smith - ctx - [optional] user-defined function context 532d763cef2SBarry Smith 533d763cef2SBarry Smith Level: beginner 534d763cef2SBarry Smith 535d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 536d763cef2SBarry Smith 537d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian() 538d763cef2SBarry Smith @*/ 539089b2837SJed Brown PetscErrorCode TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx) 540d763cef2SBarry Smith { 541089b2837SJed Brown PetscErrorCode ierr; 542089b2837SJed Brown SNES snes; 543*e856ceecSJed Brown Vec ralloc = PETSC_NULL; 544d763cef2SBarry Smith 545089b2837SJed Brown PetscFunctionBegin; 5460700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 547ca94891dSJed Brown if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 5483b5f76d0SSean Farley if (f) ts->userops->rhsfunction = f; 5494e684422SJed Brown if (ctx) ts->funP = ctx; 550089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 551*e856ceecSJed Brown if (!r && !ts->dm && ts->vec_sol) { 552*e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 553*e856ceecSJed Brown r = ralloc; 554*e856ceecSJed Brown } 555089b2837SJed Brown ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 556*e856ceecSJed Brown ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 557d763cef2SBarry Smith PetscFunctionReturn(0); 558d763cef2SBarry Smith } 559d763cef2SBarry Smith 5604a2ae208SSatish Balay #undef __FUNCT__ 5614a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian" 562d763cef2SBarry Smith /*@C 563d763cef2SBarry Smith TSSetRHSJacobian - Sets the function to compute the Jacobian of F, 564d763cef2SBarry Smith where U_t = F(U,t), as well as the location to store the matrix. 565d763cef2SBarry Smith 5663f9fe445SBarry Smith Logically Collective on TS 567d763cef2SBarry Smith 568d763cef2SBarry Smith Input Parameters: 569d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 570d763cef2SBarry Smith . A - Jacobian matrix 571d763cef2SBarry Smith . B - preconditioner matrix (usually same as A) 572d763cef2SBarry Smith . f - the Jacobian evaluation routine 573d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 574d763cef2SBarry Smith Jacobian evaluation routine (may be PETSC_NULL) 575d763cef2SBarry Smith 576d763cef2SBarry Smith Calling sequence of func: 57787828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Mat *A,Mat *B,MatStructure *flag,void *ctx); 578d763cef2SBarry Smith 579d763cef2SBarry Smith + t - current timestep 580d763cef2SBarry Smith . u - input vector 581d763cef2SBarry Smith . A - matrix A, where U_t = A(t)u 582d763cef2SBarry Smith . B - preconditioner matrix, usually the same as A 583d763cef2SBarry Smith . flag - flag indicating information about the preconditioner matrix 58494b7f48cSBarry Smith structure (same as flag in KSPSetOperators()) 585d763cef2SBarry Smith - ctx - [optional] user-defined context for matrix evaluation routine 586d763cef2SBarry Smith 587d763cef2SBarry Smith Notes: 58894b7f48cSBarry Smith See KSPSetOperators() for important information about setting the flag 589d763cef2SBarry Smith output parameter in the routine func(). Be sure to read this information! 590d763cef2SBarry Smith 591d763cef2SBarry Smith The routine func() takes Mat * as the matrix arguments rather than Mat. 592d763cef2SBarry Smith This allows the matrix evaluation routine to replace A and/or B with a 59356335db2SHong Zhang completely new matrix structure (not just different matrix elements) 594d763cef2SBarry Smith when appropriate, for instance, if the nonzero structure is changing 595d763cef2SBarry Smith throughout the global iterations. 596d763cef2SBarry Smith 597d763cef2SBarry Smith Level: beginner 598d763cef2SBarry Smith 599d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian 600d763cef2SBarry Smith 601ab637aeaSJed Brown .seealso: SNESDefaultComputeJacobianColor(), TSSetRHSFunction() 602d763cef2SBarry Smith 603d763cef2SBarry Smith @*/ 604089b2837SJed Brown PetscErrorCode TSSetRHSJacobian(TS ts,Mat A,Mat B,TSRHSJacobian f,void *ctx) 605d763cef2SBarry Smith { 606277b19d0SLisandro Dalcin PetscErrorCode ierr; 607089b2837SJed Brown SNES snes; 608277b19d0SLisandro Dalcin 609d763cef2SBarry Smith PetscFunctionBegin; 6100700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 611277b19d0SLisandro Dalcin if (A) PetscValidHeaderSpecific(A,MAT_CLASSID,2); 612277b19d0SLisandro Dalcin if (B) PetscValidHeaderSpecific(B,MAT_CLASSID,3); 613277b19d0SLisandro Dalcin if (A) PetscCheckSameComm(ts,1,A,2); 614277b19d0SLisandro Dalcin if (B) PetscCheckSameComm(ts,1,B,3); 615d763cef2SBarry Smith 6163b5f76d0SSean Farley if (f) ts->userops->rhsjacobian = f; 617277b19d0SLisandro Dalcin if (ctx) ts->jacP = ctx; 618089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 619dabe61deSJed Brown if (!ts->userops->ijacobian) { 620089b2837SJed Brown ierr = SNESSetJacobian(snes,A,B,SNESTSFormJacobian,ts);CHKERRQ(ierr); 6210e4ef248SJed Brown } 6220e4ef248SJed Brown if (A) { 6230e4ef248SJed Brown ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr); 6240e4ef248SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 6250e4ef248SJed Brown ts->Arhs = A; 6260e4ef248SJed Brown } 6270e4ef248SJed Brown if (B) { 6280e4ef248SJed Brown ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr); 6290e4ef248SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 6300e4ef248SJed Brown ts->Brhs = B; 6310e4ef248SJed Brown } 632d763cef2SBarry Smith PetscFunctionReturn(0); 633d763cef2SBarry Smith } 634d763cef2SBarry Smith 635316643e7SJed Brown 636316643e7SJed Brown #undef __FUNCT__ 637316643e7SJed Brown #define __FUNCT__ "TSSetIFunction" 638316643e7SJed Brown /*@C 639316643e7SJed Brown TSSetIFunction - Set the function to compute F(t,U,U_t) where F = 0 is the DAE to be solved. 640316643e7SJed Brown 6413f9fe445SBarry Smith Logically Collective on TS 642316643e7SJed Brown 643316643e7SJed Brown Input Parameters: 644316643e7SJed Brown + ts - the TS context obtained from TSCreate() 645ca94891dSJed Brown . r - vector to hold the residual (or PETSC_NULL to have it created internally) 646316643e7SJed Brown . f - the function evaluation routine 647316643e7SJed Brown - ctx - user-defined context for private data for the function evaluation routine (may be PETSC_NULL) 648316643e7SJed Brown 649316643e7SJed Brown Calling sequence of f: 650316643e7SJed Brown $ f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx); 651316643e7SJed Brown 652316643e7SJed Brown + t - time at step/stage being solved 653316643e7SJed Brown . u - state vector 654316643e7SJed Brown . u_t - time derivative of state vector 655316643e7SJed Brown . F - function vector 656316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 657316643e7SJed Brown 658316643e7SJed Brown Important: 659d6cbdb99SBarry Smith The user MUST call either this routine, TSSetRHSFunction(). This routine must be used when not solving an ODE, for example a DAE. 660316643e7SJed Brown 661316643e7SJed Brown Level: beginner 662316643e7SJed Brown 663316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian 664316643e7SJed Brown 665d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian() 666316643e7SJed Brown @*/ 667089b2837SJed Brown PetscErrorCode TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx) 668316643e7SJed Brown { 669089b2837SJed Brown PetscErrorCode ierr; 670089b2837SJed Brown SNES snes; 671*e856ceecSJed Brown Vec resalloc = PETSC_NULL; 672316643e7SJed Brown 673316643e7SJed Brown PetscFunctionBegin; 6740700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 675ca94891dSJed Brown if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2); 6763b5f76d0SSean Farley if (f) ts->userops->ifunction = f; 677089b2837SJed Brown if (ctx) ts->funP = ctx; 678089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 679*e856ceecSJed Brown if (!res && !ts->dm && ts->vec_sol) { 680*e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr); 681*e856ceecSJed Brown res = resalloc; 682*e856ceecSJed Brown } 683089b2837SJed Brown ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr); 684*e856ceecSJed Brown ierr = VecDestroy(&resalloc);CHKERRQ(ierr); 685089b2837SJed Brown PetscFunctionReturn(0); 686089b2837SJed Brown } 687089b2837SJed Brown 688089b2837SJed Brown #undef __FUNCT__ 689089b2837SJed Brown #define __FUNCT__ "TSGetIFunction" 690089b2837SJed Brown /*@C 691089b2837SJed Brown TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it. 692089b2837SJed Brown 693089b2837SJed Brown Not Collective 694089b2837SJed Brown 695089b2837SJed Brown Input Parameter: 696089b2837SJed Brown . ts - the TS context 697089b2837SJed Brown 698089b2837SJed Brown Output Parameter: 699089b2837SJed Brown + r - vector to hold residual (or PETSC_NULL) 700089b2837SJed Brown . func - the function to compute residual (or PETSC_NULL) 701089b2837SJed Brown - ctx - the function context (or PETSC_NULL) 702089b2837SJed Brown 703089b2837SJed Brown Level: advanced 704089b2837SJed Brown 705089b2837SJed Brown .keywords: TS, nonlinear, get, function 706089b2837SJed Brown 707089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction() 708089b2837SJed Brown @*/ 709089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx) 710089b2837SJed Brown { 711089b2837SJed Brown PetscErrorCode ierr; 712089b2837SJed Brown SNES snes; 713089b2837SJed Brown 714089b2837SJed Brown PetscFunctionBegin; 715089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 716089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 717089b2837SJed Brown ierr = SNESGetFunction(snes,r,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 7183b5f76d0SSean Farley if (func) *func = ts->userops->ifunction; 719089b2837SJed Brown if (ctx) *ctx = ts->funP; 720089b2837SJed Brown PetscFunctionReturn(0); 721089b2837SJed Brown } 722089b2837SJed Brown 723089b2837SJed Brown #undef __FUNCT__ 724089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction" 725089b2837SJed Brown /*@C 726089b2837SJed Brown TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it. 727089b2837SJed Brown 728089b2837SJed Brown Not Collective 729089b2837SJed Brown 730089b2837SJed Brown Input Parameter: 731089b2837SJed Brown . ts - the TS context 732089b2837SJed Brown 733089b2837SJed Brown Output Parameter: 734089b2837SJed Brown + r - vector to hold computed right hand side (or PETSC_NULL) 735089b2837SJed Brown . func - the function to compute right hand side (or PETSC_NULL) 736089b2837SJed Brown - ctx - the function context (or PETSC_NULL) 737089b2837SJed Brown 738089b2837SJed Brown Level: advanced 739089b2837SJed Brown 740089b2837SJed Brown .keywords: TS, nonlinear, get, function 741089b2837SJed Brown 742089b2837SJed Brown .seealso: TSSetRhsfunction(), SNESGetFunction() 743089b2837SJed Brown @*/ 744089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx) 745089b2837SJed Brown { 746089b2837SJed Brown PetscErrorCode ierr; 747089b2837SJed Brown SNES snes; 748089b2837SJed Brown 749089b2837SJed Brown PetscFunctionBegin; 750089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 751089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 752089b2837SJed Brown ierr = SNESGetFunction(snes,r,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 7533b5f76d0SSean Farley if (func) *func = ts->userops->rhsfunction; 754089b2837SJed Brown if (ctx) *ctx = ts->funP; 755316643e7SJed Brown PetscFunctionReturn(0); 756316643e7SJed Brown } 757316643e7SJed Brown 758316643e7SJed Brown #undef __FUNCT__ 759316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian" 760316643e7SJed Brown /*@C 761a4f0a591SBarry Smith TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function 762a4f0a591SBarry Smith you provided with TSSetIFunction(). 763316643e7SJed Brown 7643f9fe445SBarry Smith Logically Collective on TS 765316643e7SJed Brown 766316643e7SJed Brown Input Parameters: 767316643e7SJed Brown + ts - the TS context obtained from TSCreate() 768316643e7SJed Brown . A - Jacobian matrix 769316643e7SJed Brown . B - preconditioning matrix for A (may be same as A) 770316643e7SJed Brown . f - the Jacobian evaluation routine 771316643e7SJed Brown - ctx - user-defined context for private data for the Jacobian evaluation routine (may be PETSC_NULL) 772316643e7SJed Brown 773316643e7SJed Brown Calling sequence of f: 7741b4a444bSJed Brown $ f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat *A,Mat *B,MatStructure *flag,void *ctx); 775316643e7SJed Brown 776316643e7SJed Brown + t - time at step/stage being solved 7771b4a444bSJed Brown . U - state vector 7781b4a444bSJed Brown . U_t - time derivative of state vector 779316643e7SJed Brown . a - shift 7801b4a444bSJed Brown . A - Jacobian of G(U) = F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t 781316643e7SJed Brown . B - preconditioning matrix for A, may be same as A 782316643e7SJed Brown . flag - flag indicating information about the preconditioner matrix 783316643e7SJed Brown structure (same as flag in KSPSetOperators()) 784316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 785316643e7SJed Brown 786316643e7SJed Brown Notes: 787316643e7SJed Brown The matrices A and B are exactly the matrices that are used by SNES for the nonlinear solve. 788316643e7SJed Brown 789a4f0a591SBarry Smith The matrix dF/dU + a*dF/dU_t you provide turns out to be 790a4f0a591SBarry 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. 791a4f0a591SBarry Smith The time integrator internally approximates U_t by W+a*U where the positive "shift" 792a4f0a591SBarry Smith a and vector W depend on the integration method, step size, and past states. For example with 793a4f0a591SBarry Smith the backward Euler method a = 1/dt and W = -a*U(previous timestep) so 794a4f0a591SBarry Smith W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt 795a4f0a591SBarry Smith 796316643e7SJed Brown Level: beginner 797316643e7SJed Brown 798316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian 799316643e7SJed Brown 800ab637aeaSJed Brown .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESDefaultComputeJacobianColor(), SNESDefaultComputeJacobian() 801316643e7SJed Brown 802316643e7SJed Brown @*/ 8037087cfbeSBarry Smith PetscErrorCode TSSetIJacobian(TS ts,Mat A,Mat B,TSIJacobian f,void *ctx) 804316643e7SJed Brown { 805316643e7SJed Brown PetscErrorCode ierr; 806089b2837SJed Brown SNES snes; 807316643e7SJed Brown 808316643e7SJed Brown PetscFunctionBegin; 8090700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 8100700a824SBarry Smith if (A) PetscValidHeaderSpecific(A,MAT_CLASSID,2); 8110700a824SBarry Smith if (B) PetscValidHeaderSpecific(B,MAT_CLASSID,3); 812316643e7SJed Brown if (A) PetscCheckSameComm(ts,1,A,2); 813316643e7SJed Brown if (B) PetscCheckSameComm(ts,1,B,3); 8143b5f76d0SSean Farley if (f) ts->userops->ijacobian = f; 815316643e7SJed Brown if (ctx) ts->jacP = ctx; 816089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 817089b2837SJed Brown ierr = SNESSetJacobian(snes,A,B,SNESTSFormJacobian,ts);CHKERRQ(ierr); 818316643e7SJed Brown PetscFunctionReturn(0); 819316643e7SJed Brown } 820316643e7SJed Brown 8214a2ae208SSatish Balay #undef __FUNCT__ 8224a2ae208SSatish Balay #define __FUNCT__ "TSView" 8237e2c5f70SBarry Smith /*@C 824d763cef2SBarry Smith TSView - Prints the TS data structure. 825d763cef2SBarry Smith 8264c49b128SBarry Smith Collective on TS 827d763cef2SBarry Smith 828d763cef2SBarry Smith Input Parameters: 829d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 830d763cef2SBarry Smith - viewer - visualization context 831d763cef2SBarry Smith 832d763cef2SBarry Smith Options Database Key: 833d763cef2SBarry Smith . -ts_view - calls TSView() at end of TSStep() 834d763cef2SBarry Smith 835d763cef2SBarry Smith Notes: 836d763cef2SBarry Smith The available visualization contexts include 837b0a32e0cSBarry Smith + PETSC_VIEWER_STDOUT_SELF - standard output (default) 838b0a32e0cSBarry Smith - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 839d763cef2SBarry Smith output where only the first processor opens 840d763cef2SBarry Smith the file. All other processors send their 841d763cef2SBarry Smith data to the first processor to print. 842d763cef2SBarry Smith 843d763cef2SBarry Smith The user can open an alternative visualization context with 844b0a32e0cSBarry Smith PetscViewerASCIIOpen() - output to a specified file. 845d763cef2SBarry Smith 846d763cef2SBarry Smith Level: beginner 847d763cef2SBarry Smith 848d763cef2SBarry Smith .keywords: TS, timestep, view 849d763cef2SBarry Smith 850b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen() 851d763cef2SBarry Smith @*/ 8527087cfbeSBarry Smith PetscErrorCode TSView(TS ts,PetscViewer viewer) 853d763cef2SBarry Smith { 854dfbe8321SBarry Smith PetscErrorCode ierr; 855a313700dSBarry Smith const TSType type; 856089b2837SJed Brown PetscBool iascii,isstring,isundials; 857d763cef2SBarry Smith 858d763cef2SBarry Smith PetscFunctionBegin; 8590700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 8603050cee2SBarry Smith if (!viewer) { 8617adad957SLisandro Dalcin ierr = PetscViewerASCIIGetStdout(((PetscObject)ts)->comm,&viewer);CHKERRQ(ierr); 8623050cee2SBarry Smith } 8630700a824SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 864c9780b6fSBarry Smith PetscCheckSameComm(ts,1,viewer,2); 865fd16b177SBarry Smith 8662692d6eeSBarry Smith ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 8672692d6eeSBarry Smith ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 86832077d6dSBarry Smith if (iascii) { 869317d6ea6SBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer,"TS Object");CHKERRQ(ierr); 87077431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr); 871a83599f4SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum time=%G\n",ts->max_time);CHKERRQ(ierr); 872d763cef2SBarry Smith if (ts->problem_type == TS_NONLINEAR) { 87377431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solver iterations=%D\n",ts->nonlinear_its);CHKERRQ(ierr); 874c610991cSLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr); 875d763cef2SBarry Smith } 87677431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",ts->linear_its);CHKERRQ(ierr); 877193ac0bcSJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr); 878d52bd9f3SBarry Smith if (ts->ops->view) { 879d52bd9f3SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 880d52bd9f3SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 881d52bd9f3SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 882d52bd9f3SBarry Smith } 8830f5bd95cSBarry Smith } else if (isstring) { 884a313700dSBarry Smith ierr = TSGetType(ts,&type);CHKERRQ(ierr); 885b0a32e0cSBarry Smith ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr); 886d763cef2SBarry Smith } 887b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 888089b2837SJed Brown ierr = PetscTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr); 889b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 890d763cef2SBarry Smith PetscFunctionReturn(0); 891d763cef2SBarry Smith } 892d763cef2SBarry Smith 893d763cef2SBarry Smith 8944a2ae208SSatish Balay #undef __FUNCT__ 8954a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext" 896b07ff414SBarry Smith /*@ 897d763cef2SBarry Smith TSSetApplicationContext - Sets an optional user-defined context for 898d763cef2SBarry Smith the timesteppers. 899d763cef2SBarry Smith 9003f9fe445SBarry Smith Logically Collective on TS 901d763cef2SBarry Smith 902d763cef2SBarry Smith Input Parameters: 903d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 904d763cef2SBarry Smith - usrP - optional user context 905d763cef2SBarry Smith 906d763cef2SBarry Smith Level: intermediate 907d763cef2SBarry Smith 908d763cef2SBarry Smith .keywords: TS, timestep, set, application, context 909d763cef2SBarry Smith 910d763cef2SBarry Smith .seealso: TSGetApplicationContext() 911d763cef2SBarry Smith @*/ 9127087cfbeSBarry Smith PetscErrorCode TSSetApplicationContext(TS ts,void *usrP) 913d763cef2SBarry Smith { 914d763cef2SBarry Smith PetscFunctionBegin; 9150700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 916d763cef2SBarry Smith ts->user = usrP; 917d763cef2SBarry Smith PetscFunctionReturn(0); 918d763cef2SBarry Smith } 919d763cef2SBarry Smith 9204a2ae208SSatish Balay #undef __FUNCT__ 9214a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext" 922b07ff414SBarry Smith /*@ 923d763cef2SBarry Smith TSGetApplicationContext - Gets the user-defined context for the 924d763cef2SBarry Smith timestepper. 925d763cef2SBarry Smith 926d763cef2SBarry Smith Not Collective 927d763cef2SBarry Smith 928d763cef2SBarry Smith Input Parameter: 929d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 930d763cef2SBarry Smith 931d763cef2SBarry Smith Output Parameter: 932d763cef2SBarry Smith . usrP - user context 933d763cef2SBarry Smith 934d763cef2SBarry Smith Level: intermediate 935d763cef2SBarry Smith 936d763cef2SBarry Smith .keywords: TS, timestep, get, application, context 937d763cef2SBarry Smith 938d763cef2SBarry Smith .seealso: TSSetApplicationContext() 939d763cef2SBarry Smith @*/ 940e71120c6SJed Brown PetscErrorCode TSGetApplicationContext(TS ts,void *usrP) 941d763cef2SBarry Smith { 942d763cef2SBarry Smith PetscFunctionBegin; 9430700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 944e71120c6SJed Brown *(void**)usrP = ts->user; 945d763cef2SBarry Smith PetscFunctionReturn(0); 946d763cef2SBarry Smith } 947d763cef2SBarry Smith 9484a2ae208SSatish Balay #undef __FUNCT__ 9494a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber" 950d763cef2SBarry Smith /*@ 951d763cef2SBarry Smith TSGetTimeStepNumber - Gets the current number of timesteps. 952d763cef2SBarry Smith 953d763cef2SBarry Smith Not Collective 954d763cef2SBarry Smith 955d763cef2SBarry Smith Input Parameter: 956d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 957d763cef2SBarry Smith 958d763cef2SBarry Smith Output Parameter: 959d763cef2SBarry Smith . iter - number steps so far 960d763cef2SBarry Smith 961d763cef2SBarry Smith Level: intermediate 962d763cef2SBarry Smith 963d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number 964d763cef2SBarry Smith @*/ 9657087cfbeSBarry Smith PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt* iter) 966d763cef2SBarry Smith { 967d763cef2SBarry Smith PetscFunctionBegin; 9680700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 9694482741eSBarry Smith PetscValidIntPointer(iter,2); 970d763cef2SBarry Smith *iter = ts->steps; 971d763cef2SBarry Smith PetscFunctionReturn(0); 972d763cef2SBarry Smith } 973d763cef2SBarry Smith 9744a2ae208SSatish Balay #undef __FUNCT__ 9754a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep" 976d763cef2SBarry Smith /*@ 977d763cef2SBarry Smith TSSetInitialTimeStep - Sets the initial timestep to be used, 978d763cef2SBarry Smith as well as the initial time. 979d763cef2SBarry Smith 9803f9fe445SBarry Smith Logically Collective on TS 981d763cef2SBarry Smith 982d763cef2SBarry Smith Input Parameters: 983d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 984d763cef2SBarry Smith . initial_time - the initial time 985d763cef2SBarry Smith - time_step - the size of the timestep 986d763cef2SBarry Smith 987d763cef2SBarry Smith Level: intermediate 988d763cef2SBarry Smith 989d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep() 990d763cef2SBarry Smith 991d763cef2SBarry Smith .keywords: TS, set, initial, timestep 992d763cef2SBarry Smith @*/ 9937087cfbeSBarry Smith PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step) 994d763cef2SBarry Smith { 995e144a568SJed Brown PetscErrorCode ierr; 996e144a568SJed Brown 997d763cef2SBarry Smith PetscFunctionBegin; 9980700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 999e144a568SJed Brown ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 1000d8cd7023SBarry Smith ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr); 1001d763cef2SBarry Smith PetscFunctionReturn(0); 1002d763cef2SBarry Smith } 1003d763cef2SBarry Smith 10044a2ae208SSatish Balay #undef __FUNCT__ 10054a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep" 1006d763cef2SBarry Smith /*@ 1007d763cef2SBarry Smith TSSetTimeStep - Allows one to reset the timestep at any time, 1008d763cef2SBarry Smith useful for simple pseudo-timestepping codes. 1009d763cef2SBarry Smith 10103f9fe445SBarry Smith Logically Collective on TS 1011d763cef2SBarry Smith 1012d763cef2SBarry Smith Input Parameters: 1013d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1014d763cef2SBarry Smith - time_step - the size of the timestep 1015d763cef2SBarry Smith 1016d763cef2SBarry Smith Level: intermediate 1017d763cef2SBarry Smith 1018d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1019d763cef2SBarry Smith 1020d763cef2SBarry Smith .keywords: TS, set, timestep 1021d763cef2SBarry Smith @*/ 10227087cfbeSBarry Smith PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step) 1023d763cef2SBarry Smith { 1024d763cef2SBarry Smith PetscFunctionBegin; 10250700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1026c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,time_step,2); 1027d763cef2SBarry Smith ts->time_step = time_step; 1028d763cef2SBarry Smith PetscFunctionReturn(0); 1029d763cef2SBarry Smith } 1030d763cef2SBarry Smith 10314a2ae208SSatish Balay #undef __FUNCT__ 1032a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime" 1033a43b19c4SJed Brown /*@ 1034a43b19c4SJed Brown TSSetExactFinalTime - Determines whether to interpolate solution to the 1035a43b19c4SJed Brown exact final time requested by the user or just returns it at the final time 1036a43b19c4SJed Brown it computed. 1037a43b19c4SJed Brown 1038a43b19c4SJed Brown Logically Collective on TS 1039a43b19c4SJed Brown 1040a43b19c4SJed Brown Input Parameter: 1041a43b19c4SJed Brown + ts - the time-step context 1042a43b19c4SJed Brown - ft - PETSC_TRUE if interpolates, else PETSC_FALSE 1043a43b19c4SJed Brown 1044a43b19c4SJed Brown Level: beginner 1045a43b19c4SJed Brown 1046a43b19c4SJed Brown .seealso: TSSetDuration() 1047a43b19c4SJed Brown @*/ 1048a43b19c4SJed Brown PetscErrorCode TSSetExactFinalTime(TS ts,PetscBool flg) 1049a43b19c4SJed Brown { 1050a43b19c4SJed Brown 1051a43b19c4SJed Brown PetscFunctionBegin; 1052a43b19c4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1053d8cd7023SBarry Smith PetscValidLogicalCollectiveBool(ts,flg,2); 1054a43b19c4SJed Brown ts->exact_final_time = flg; 1055a43b19c4SJed Brown PetscFunctionReturn(0); 1056a43b19c4SJed Brown } 1057a43b19c4SJed Brown 1058a43b19c4SJed Brown #undef __FUNCT__ 10594a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep" 1060d763cef2SBarry Smith /*@ 1061d763cef2SBarry Smith TSGetTimeStep - Gets the current timestep size. 1062d763cef2SBarry Smith 1063d763cef2SBarry Smith Not Collective 1064d763cef2SBarry Smith 1065d763cef2SBarry Smith Input Parameter: 1066d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1067d763cef2SBarry Smith 1068d763cef2SBarry Smith Output Parameter: 1069d763cef2SBarry Smith . dt - the current timestep size 1070d763cef2SBarry Smith 1071d763cef2SBarry Smith Level: intermediate 1072d763cef2SBarry Smith 1073d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1074d763cef2SBarry Smith 1075d763cef2SBarry Smith .keywords: TS, get, timestep 1076d763cef2SBarry Smith @*/ 10777087cfbeSBarry Smith PetscErrorCode TSGetTimeStep(TS ts,PetscReal* dt) 1078d763cef2SBarry Smith { 1079d763cef2SBarry Smith PetscFunctionBegin; 10800700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 10814482741eSBarry Smith PetscValidDoublePointer(dt,2); 1082d763cef2SBarry Smith *dt = ts->time_step; 1083d763cef2SBarry Smith PetscFunctionReturn(0); 1084d763cef2SBarry Smith } 1085d763cef2SBarry Smith 10864a2ae208SSatish Balay #undef __FUNCT__ 10874a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution" 1088d8e5e3e6SSatish Balay /*@ 1089d763cef2SBarry Smith TSGetSolution - Returns the solution at the present timestep. It 1090d763cef2SBarry Smith is valid to call this routine inside the function that you are evaluating 1091d763cef2SBarry Smith in order to move to the new timestep. This vector not changed until 1092d763cef2SBarry Smith the solution at the next timestep has been calculated. 1093d763cef2SBarry Smith 1094d763cef2SBarry Smith Not Collective, but Vec returned is parallel if TS is parallel 1095d763cef2SBarry Smith 1096d763cef2SBarry Smith Input Parameter: 1097d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1098d763cef2SBarry Smith 1099d763cef2SBarry Smith Output Parameter: 1100d763cef2SBarry Smith . v - the vector containing the solution 1101d763cef2SBarry Smith 1102d763cef2SBarry Smith Level: intermediate 1103d763cef2SBarry Smith 1104d763cef2SBarry Smith .seealso: TSGetTimeStep() 1105d763cef2SBarry Smith 1106d763cef2SBarry Smith .keywords: TS, timestep, get, solution 1107d763cef2SBarry Smith @*/ 11087087cfbeSBarry Smith PetscErrorCode TSGetSolution(TS ts,Vec *v) 1109d763cef2SBarry Smith { 1110d763cef2SBarry Smith PetscFunctionBegin; 11110700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 11124482741eSBarry Smith PetscValidPointer(v,2); 11138737fe31SLisandro Dalcin *v = ts->vec_sol; 1114d763cef2SBarry Smith PetscFunctionReturn(0); 1115d763cef2SBarry Smith } 1116d763cef2SBarry Smith 1117bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */ 11184a2ae208SSatish Balay #undef __FUNCT__ 1119bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType" 1120d8e5e3e6SSatish Balay /*@ 1121bdad233fSMatthew Knepley TSSetProblemType - Sets the type of problem to be solved. 1122d763cef2SBarry Smith 1123bdad233fSMatthew Knepley Not collective 1124d763cef2SBarry Smith 1125bdad233fSMatthew Knepley Input Parameters: 1126bdad233fSMatthew Knepley + ts - The TS 1127bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 1128d763cef2SBarry Smith .vb 1129d763cef2SBarry Smith U_t = A U 1130d763cef2SBarry Smith U_t = A(t) U 1131d763cef2SBarry Smith U_t = F(t,U) 1132d763cef2SBarry Smith .ve 1133d763cef2SBarry Smith 1134d763cef2SBarry Smith Level: beginner 1135d763cef2SBarry Smith 1136bdad233fSMatthew Knepley .keywords: TS, problem type 1137bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 1138d763cef2SBarry Smith @*/ 11397087cfbeSBarry Smith PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 1140a7cc72afSBarry Smith { 11419e2a6581SJed Brown PetscErrorCode ierr; 11429e2a6581SJed Brown 1143d763cef2SBarry Smith PetscFunctionBegin; 11440700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1145bdad233fSMatthew Knepley ts->problem_type = type; 11469e2a6581SJed Brown if (type == TS_LINEAR) { 11479e2a6581SJed Brown SNES snes; 11489e2a6581SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 11499e2a6581SJed Brown ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr); 11509e2a6581SJed Brown } 1151d763cef2SBarry Smith PetscFunctionReturn(0); 1152d763cef2SBarry Smith } 1153d763cef2SBarry Smith 1154bdad233fSMatthew Knepley #undef __FUNCT__ 1155bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType" 1156bdad233fSMatthew Knepley /*@C 1157bdad233fSMatthew Knepley TSGetProblemType - Gets the type of problem to be solved. 1158bdad233fSMatthew Knepley 1159bdad233fSMatthew Knepley Not collective 1160bdad233fSMatthew Knepley 1161bdad233fSMatthew Knepley Input Parameter: 1162bdad233fSMatthew Knepley . ts - The TS 1163bdad233fSMatthew Knepley 1164bdad233fSMatthew Knepley Output Parameter: 1165bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 1166bdad233fSMatthew Knepley .vb 1167089b2837SJed Brown M U_t = A U 1168089b2837SJed Brown M(t) U_t = A(t) U 1169bdad233fSMatthew Knepley U_t = F(t,U) 1170bdad233fSMatthew Knepley .ve 1171bdad233fSMatthew Knepley 1172bdad233fSMatthew Knepley Level: beginner 1173bdad233fSMatthew Knepley 1174bdad233fSMatthew Knepley .keywords: TS, problem type 1175bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 1176bdad233fSMatthew Knepley @*/ 11777087cfbeSBarry Smith PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 1178a7cc72afSBarry Smith { 1179bdad233fSMatthew Knepley PetscFunctionBegin; 11800700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 11814482741eSBarry Smith PetscValidIntPointer(type,2); 1182bdad233fSMatthew Knepley *type = ts->problem_type; 1183bdad233fSMatthew Knepley PetscFunctionReturn(0); 1184bdad233fSMatthew Knepley } 1185d763cef2SBarry Smith 11864a2ae208SSatish Balay #undef __FUNCT__ 11874a2ae208SSatish Balay #define __FUNCT__ "TSSetUp" 1188d763cef2SBarry Smith /*@ 1189d763cef2SBarry Smith TSSetUp - Sets up the internal data structures for the later use 1190d763cef2SBarry Smith of a timestepper. 1191d763cef2SBarry Smith 1192d763cef2SBarry Smith Collective on TS 1193d763cef2SBarry Smith 1194d763cef2SBarry Smith Input Parameter: 1195d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1196d763cef2SBarry Smith 1197d763cef2SBarry Smith Notes: 1198d763cef2SBarry Smith For basic use of the TS solvers the user need not explicitly call 1199d763cef2SBarry Smith TSSetUp(), since these actions will automatically occur during 1200d763cef2SBarry Smith the call to TSStep(). However, if one wishes to control this 1201d763cef2SBarry Smith phase separately, TSSetUp() should be called after TSCreate() 1202d763cef2SBarry Smith and optional routines of the form TSSetXXX(), but before TSStep(). 1203d763cef2SBarry Smith 1204d763cef2SBarry Smith Level: advanced 1205d763cef2SBarry Smith 1206d763cef2SBarry Smith .keywords: TS, timestep, setup 1207d763cef2SBarry Smith 1208d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy() 1209d763cef2SBarry Smith @*/ 12107087cfbeSBarry Smith PetscErrorCode TSSetUp(TS ts) 1211d763cef2SBarry Smith { 1212dfbe8321SBarry Smith PetscErrorCode ierr; 1213d763cef2SBarry Smith 1214d763cef2SBarry Smith PetscFunctionBegin; 12150700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1216277b19d0SLisandro Dalcin if (ts->setupcalled) PetscFunctionReturn(0); 1217277b19d0SLisandro Dalcin 12187adad957SLisandro Dalcin if (!((PetscObject)ts)->type_name) { 12199596e0b4SJed Brown ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr); 1220d763cef2SBarry Smith } 1221a43b19c4SJed Brown if (ts->exact_final_time == PETSC_DECIDE) ts->exact_final_time = PETSC_FALSE; 1222277b19d0SLisandro Dalcin 1223277b19d0SLisandro Dalcin if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first"); 1224277b19d0SLisandro Dalcin 12251c3436cfSJed Brown ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 12261c3436cfSJed Brown 1227277b19d0SLisandro Dalcin if (ts->ops->setup) { 1228000e7ae3SMatthew Knepley ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr); 1229277b19d0SLisandro Dalcin } 1230277b19d0SLisandro Dalcin 1231277b19d0SLisandro Dalcin ts->setupcalled = PETSC_TRUE; 1232277b19d0SLisandro Dalcin PetscFunctionReturn(0); 1233277b19d0SLisandro Dalcin } 1234277b19d0SLisandro Dalcin 1235277b19d0SLisandro Dalcin #undef __FUNCT__ 1236277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset" 1237277b19d0SLisandro Dalcin /*@ 1238277b19d0SLisandro Dalcin TSReset - Resets a TS context and removes any allocated Vecs and Mats. 1239277b19d0SLisandro Dalcin 1240277b19d0SLisandro Dalcin Collective on TS 1241277b19d0SLisandro Dalcin 1242277b19d0SLisandro Dalcin Input Parameter: 1243277b19d0SLisandro Dalcin . ts - the TS context obtained from TSCreate() 1244277b19d0SLisandro Dalcin 1245277b19d0SLisandro Dalcin Level: beginner 1246277b19d0SLisandro Dalcin 1247277b19d0SLisandro Dalcin .keywords: TS, timestep, reset 1248277b19d0SLisandro Dalcin 1249277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy() 1250277b19d0SLisandro Dalcin @*/ 1251277b19d0SLisandro Dalcin PetscErrorCode TSReset(TS ts) 1252277b19d0SLisandro Dalcin { 1253277b19d0SLisandro Dalcin PetscErrorCode ierr; 1254277b19d0SLisandro Dalcin 1255277b19d0SLisandro Dalcin PetscFunctionBegin; 1256277b19d0SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1257277b19d0SLisandro Dalcin if (ts->ops->reset) { 1258277b19d0SLisandro Dalcin ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr); 1259277b19d0SLisandro Dalcin } 1260277b19d0SLisandro Dalcin if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);} 12614e684422SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 12624e684422SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1263214bc6a2SJed Brown ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr); 12646bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 126538637c2eSJed Brown ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr); 1266277b19d0SLisandro Dalcin ts->setupcalled = PETSC_FALSE; 1267d763cef2SBarry Smith PetscFunctionReturn(0); 1268d763cef2SBarry Smith } 1269d763cef2SBarry Smith 12704a2ae208SSatish Balay #undef __FUNCT__ 12714a2ae208SSatish Balay #define __FUNCT__ "TSDestroy" 1272d8e5e3e6SSatish Balay /*@ 1273d763cef2SBarry Smith TSDestroy - Destroys the timestepper context that was created 1274d763cef2SBarry Smith with TSCreate(). 1275d763cef2SBarry Smith 1276d763cef2SBarry Smith Collective on TS 1277d763cef2SBarry Smith 1278d763cef2SBarry Smith Input Parameter: 1279d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1280d763cef2SBarry Smith 1281d763cef2SBarry Smith Level: beginner 1282d763cef2SBarry Smith 1283d763cef2SBarry Smith .keywords: TS, timestepper, destroy 1284d763cef2SBarry Smith 1285d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve() 1286d763cef2SBarry Smith @*/ 12876bf464f9SBarry Smith PetscErrorCode TSDestroy(TS *ts) 1288d763cef2SBarry Smith { 12896849ba73SBarry Smith PetscErrorCode ierr; 1290d763cef2SBarry Smith 1291d763cef2SBarry Smith PetscFunctionBegin; 12926bf464f9SBarry Smith if (!*ts) PetscFunctionReturn(0); 12936bf464f9SBarry Smith PetscValidHeaderSpecific((*ts),TS_CLASSID,1); 12946bf464f9SBarry Smith if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);} 1295d763cef2SBarry Smith 12966bf464f9SBarry Smith ierr = TSReset((*ts));CHKERRQ(ierr); 1297277b19d0SLisandro Dalcin 1298be0abb6dSBarry Smith /* if memory was published with AMS then destroy it */ 12996bf464f9SBarry Smith ierr = PetscObjectDepublish((*ts));CHKERRQ(ierr); 13006bf464f9SBarry Smith if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);} 13016d4c513bSLisandro Dalcin 130284df9cb4SJed Brown ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr); 13036bf464f9SBarry Smith ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr); 13046bf464f9SBarry Smith ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr); 13056bf464f9SBarry Smith ierr = TSMonitorCancel((*ts));CHKERRQ(ierr); 13066d4c513bSLisandro Dalcin 13073b5f76d0SSean Farley ierr = PetscFree((*ts)->userops); 13083b5f76d0SSean Farley 1309a79aaaedSSatish Balay ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr); 1310d763cef2SBarry Smith PetscFunctionReturn(0); 1311d763cef2SBarry Smith } 1312d763cef2SBarry Smith 13134a2ae208SSatish Balay #undef __FUNCT__ 13144a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES" 1315d8e5e3e6SSatish Balay /*@ 1316d763cef2SBarry Smith TSGetSNES - Returns the SNES (nonlinear solver) associated with 1317d763cef2SBarry Smith a TS (timestepper) context. Valid only for nonlinear problems. 1318d763cef2SBarry Smith 1319d763cef2SBarry Smith Not Collective, but SNES is parallel if TS is parallel 1320d763cef2SBarry Smith 1321d763cef2SBarry Smith Input Parameter: 1322d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1323d763cef2SBarry Smith 1324d763cef2SBarry Smith Output Parameter: 1325d763cef2SBarry Smith . snes - the nonlinear solver context 1326d763cef2SBarry Smith 1327d763cef2SBarry Smith Notes: 1328d763cef2SBarry Smith The user can then directly manipulate the SNES context to set various 1329d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 133094b7f48cSBarry Smith KSP, KSP, and PC contexts as well. 1331d763cef2SBarry Smith 1332d763cef2SBarry Smith TSGetSNES() does not work for integrators that do not use SNES; in 1333d763cef2SBarry Smith this case TSGetSNES() returns PETSC_NULL in snes. 1334d763cef2SBarry Smith 1335d763cef2SBarry Smith Level: beginner 1336d763cef2SBarry Smith 1337d763cef2SBarry Smith .keywords: timestep, get, SNES 1338d763cef2SBarry Smith @*/ 13397087cfbeSBarry Smith PetscErrorCode TSGetSNES(TS ts,SNES *snes) 1340d763cef2SBarry Smith { 1341d372ba47SLisandro Dalcin PetscErrorCode ierr; 1342d372ba47SLisandro Dalcin 1343d763cef2SBarry Smith PetscFunctionBegin; 13440700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 13454482741eSBarry Smith PetscValidPointer(snes,2); 1346d372ba47SLisandro Dalcin if (!ts->snes) { 1347d372ba47SLisandro Dalcin ierr = SNESCreate(((PetscObject)ts)->comm,&ts->snes);CHKERRQ(ierr); 1348d372ba47SLisandro Dalcin ierr = PetscLogObjectParent(ts,ts->snes);CHKERRQ(ierr); 1349d372ba47SLisandro Dalcin ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr); 13509e2a6581SJed Brown if (ts->problem_type == TS_LINEAR) { 13519e2a6581SJed Brown ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); 13529e2a6581SJed Brown } 1353d372ba47SLisandro Dalcin } 1354d763cef2SBarry Smith *snes = ts->snes; 1355d763cef2SBarry Smith PetscFunctionReturn(0); 1356d763cef2SBarry Smith } 1357d763cef2SBarry Smith 13584a2ae208SSatish Balay #undef __FUNCT__ 135994b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP" 1360d8e5e3e6SSatish Balay /*@ 136194b7f48cSBarry Smith TSGetKSP - Returns the KSP (linear solver) associated with 1362d763cef2SBarry Smith a TS (timestepper) context. 1363d763cef2SBarry Smith 136494b7f48cSBarry Smith Not Collective, but KSP is parallel if TS is parallel 1365d763cef2SBarry Smith 1366d763cef2SBarry Smith Input Parameter: 1367d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1368d763cef2SBarry Smith 1369d763cef2SBarry Smith Output Parameter: 137094b7f48cSBarry Smith . ksp - the nonlinear solver context 1371d763cef2SBarry Smith 1372d763cef2SBarry Smith Notes: 137394b7f48cSBarry Smith The user can then directly manipulate the KSP context to set various 1374d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 1375d763cef2SBarry Smith KSP and PC contexts as well. 1376d763cef2SBarry Smith 137794b7f48cSBarry Smith TSGetKSP() does not work for integrators that do not use KSP; 137894b7f48cSBarry Smith in this case TSGetKSP() returns PETSC_NULL in ksp. 1379d763cef2SBarry Smith 1380d763cef2SBarry Smith Level: beginner 1381d763cef2SBarry Smith 138294b7f48cSBarry Smith .keywords: timestep, get, KSP 1383d763cef2SBarry Smith @*/ 13847087cfbeSBarry Smith PetscErrorCode TSGetKSP(TS ts,KSP *ksp) 1385d763cef2SBarry Smith { 1386d372ba47SLisandro Dalcin PetscErrorCode ierr; 1387089b2837SJed Brown SNES snes; 1388d372ba47SLisandro Dalcin 1389d763cef2SBarry Smith PetscFunctionBegin; 13900700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 13914482741eSBarry Smith PetscValidPointer(ksp,2); 139217186662SBarry Smith if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first"); 1393e32f2f54SBarry Smith if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()"); 1394089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1395089b2837SJed Brown ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr); 1396d763cef2SBarry Smith PetscFunctionReturn(0); 1397d763cef2SBarry Smith } 1398d763cef2SBarry Smith 1399d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */ 1400d763cef2SBarry Smith 14014a2ae208SSatish Balay #undef __FUNCT__ 1402adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration" 1403adb62b0dSMatthew Knepley /*@ 1404adb62b0dSMatthew Knepley TSGetDuration - Gets the maximum number of timesteps to use and 1405adb62b0dSMatthew Knepley maximum time for iteration. 1406adb62b0dSMatthew Knepley 14073f9fe445SBarry Smith Not Collective 1408adb62b0dSMatthew Knepley 1409adb62b0dSMatthew Knepley Input Parameters: 1410adb62b0dSMatthew Knepley + ts - the TS context obtained from TSCreate() 1411adb62b0dSMatthew Knepley . maxsteps - maximum number of iterations to use, or PETSC_NULL 1412adb62b0dSMatthew Knepley - maxtime - final time to iterate to, or PETSC_NULL 1413adb62b0dSMatthew Knepley 1414adb62b0dSMatthew Knepley Level: intermediate 1415adb62b0dSMatthew Knepley 1416adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time 1417adb62b0dSMatthew Knepley @*/ 14187087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 1419adb62b0dSMatthew Knepley { 1420adb62b0dSMatthew Knepley PetscFunctionBegin; 14210700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1422abc0a331SBarry Smith if (maxsteps) { 14234482741eSBarry Smith PetscValidIntPointer(maxsteps,2); 1424adb62b0dSMatthew Knepley *maxsteps = ts->max_steps; 1425adb62b0dSMatthew Knepley } 1426abc0a331SBarry Smith if (maxtime) { 14274482741eSBarry Smith PetscValidScalarPointer(maxtime,3); 1428adb62b0dSMatthew Knepley *maxtime = ts->max_time; 1429adb62b0dSMatthew Knepley } 1430adb62b0dSMatthew Knepley PetscFunctionReturn(0); 1431adb62b0dSMatthew Knepley } 1432adb62b0dSMatthew Knepley 1433adb62b0dSMatthew Knepley #undef __FUNCT__ 14344a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration" 1435d763cef2SBarry Smith /*@ 1436d763cef2SBarry Smith TSSetDuration - Sets the maximum number of timesteps to use and 1437d763cef2SBarry Smith maximum time for iteration. 1438d763cef2SBarry Smith 14393f9fe445SBarry Smith Logically Collective on TS 1440d763cef2SBarry Smith 1441d763cef2SBarry Smith Input Parameters: 1442d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1443d763cef2SBarry Smith . maxsteps - maximum number of iterations to use 1444d763cef2SBarry Smith - maxtime - final time to iterate to 1445d763cef2SBarry Smith 1446d763cef2SBarry Smith Options Database Keys: 1447d763cef2SBarry Smith . -ts_max_steps <maxsteps> - Sets maxsteps 14483bca7d26SBarry Smith . -ts_final_time <maxtime> - Sets maxtime 1449d763cef2SBarry Smith 1450d763cef2SBarry Smith Notes: 1451d763cef2SBarry Smith The default maximum number of iterations is 5000. Default time is 5.0 1452d763cef2SBarry Smith 1453d763cef2SBarry Smith Level: intermediate 1454d763cef2SBarry Smith 1455d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations 1456a43b19c4SJed Brown 1457a43b19c4SJed Brown .seealso: TSSetExactFinalTime() 1458d763cef2SBarry Smith @*/ 14597087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime) 1460d763cef2SBarry Smith { 1461d763cef2SBarry Smith PetscFunctionBegin; 14620700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1463c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(ts,maxsteps,2); 1464c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,maxtime,2); 146539b7ec4bSSean Farley if (maxsteps >= 0) ts->max_steps = maxsteps; 146639b7ec4bSSean Farley if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime; 1467d763cef2SBarry Smith PetscFunctionReturn(0); 1468d763cef2SBarry Smith } 1469d763cef2SBarry Smith 14704a2ae208SSatish Balay #undef __FUNCT__ 14714a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution" 1472d763cef2SBarry Smith /*@ 1473d763cef2SBarry Smith TSSetSolution - Sets the initial solution vector 1474d763cef2SBarry Smith for use by the TS routines. 1475d763cef2SBarry Smith 14763f9fe445SBarry Smith Logically Collective on TS and Vec 1477d763cef2SBarry Smith 1478d763cef2SBarry Smith Input Parameters: 1479d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1480d763cef2SBarry Smith - x - the solution vector 1481d763cef2SBarry Smith 1482d763cef2SBarry Smith Level: beginner 1483d763cef2SBarry Smith 1484d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions 1485d763cef2SBarry Smith @*/ 14867087cfbeSBarry Smith PetscErrorCode TSSetSolution(TS ts,Vec x) 1487d763cef2SBarry Smith { 14888737fe31SLisandro Dalcin PetscErrorCode ierr; 14898737fe31SLisandro Dalcin 1490d763cef2SBarry Smith PetscFunctionBegin; 14910700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 14920700a824SBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,2); 14938737fe31SLisandro Dalcin ierr = PetscObjectReference((PetscObject)x);CHKERRQ(ierr); 14946bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 14958737fe31SLisandro Dalcin ts->vec_sol = x; 1496d763cef2SBarry Smith PetscFunctionReturn(0); 1497d763cef2SBarry Smith } 1498d763cef2SBarry Smith 1499e74ef692SMatthew Knepley #undef __FUNCT__ 1500e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep" 1501ac226902SBarry Smith /*@C 1502000e7ae3SMatthew Knepley TSSetPreStep - Sets the general-purpose function 15033f2090d5SJed Brown called once at the beginning of each time step. 1504000e7ae3SMatthew Knepley 15053f9fe445SBarry Smith Logically Collective on TS 1506000e7ae3SMatthew Knepley 1507000e7ae3SMatthew Knepley Input Parameters: 1508000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 1509000e7ae3SMatthew Knepley - func - The function 1510000e7ae3SMatthew Knepley 1511000e7ae3SMatthew Knepley Calling sequence of func: 1512000e7ae3SMatthew Knepley . func (TS ts); 1513000e7ae3SMatthew Knepley 1514000e7ae3SMatthew Knepley Level: intermediate 1515000e7ae3SMatthew Knepley 1516000e7ae3SMatthew Knepley .keywords: TS, timestep 1517000e7ae3SMatthew Knepley @*/ 15187087cfbeSBarry Smith PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS)) 1519000e7ae3SMatthew Knepley { 1520000e7ae3SMatthew Knepley PetscFunctionBegin; 15210700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1522000e7ae3SMatthew Knepley ts->ops->prestep = func; 1523000e7ae3SMatthew Knepley PetscFunctionReturn(0); 1524000e7ae3SMatthew Knepley } 1525000e7ae3SMatthew Knepley 1526e74ef692SMatthew Knepley #undef __FUNCT__ 15273f2090d5SJed Brown #define __FUNCT__ "TSPreStep" 152809ee8438SJed Brown /*@ 15293f2090d5SJed Brown TSPreStep - Runs the user-defined pre-step function. 15303f2090d5SJed Brown 15313f2090d5SJed Brown Collective on TS 15323f2090d5SJed Brown 15333f2090d5SJed Brown Input Parameters: 15343f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 15353f2090d5SJed Brown 15363f2090d5SJed Brown Notes: 15373f2090d5SJed Brown TSPreStep() is typically used within time stepping implementations, 15383f2090d5SJed Brown so most users would not generally call this routine themselves. 15393f2090d5SJed Brown 15403f2090d5SJed Brown Level: developer 15413f2090d5SJed Brown 15423f2090d5SJed Brown .keywords: TS, timestep 15433f2090d5SJed Brown @*/ 15447087cfbeSBarry Smith PetscErrorCode TSPreStep(TS ts) 15453f2090d5SJed Brown { 15463f2090d5SJed Brown PetscErrorCode ierr; 15473f2090d5SJed Brown 15483f2090d5SJed Brown PetscFunctionBegin; 15490700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 155072ac3e02SJed Brown if (ts->ops->prestep) { 15513f2090d5SJed Brown PetscStackPush("TS PreStep function"); 15523f2090d5SJed Brown ierr = (*ts->ops->prestep)(ts);CHKERRQ(ierr); 15533f2090d5SJed Brown PetscStackPop; 1554312ce896SJed Brown } 15553f2090d5SJed Brown PetscFunctionReturn(0); 15563f2090d5SJed Brown } 15573f2090d5SJed Brown 15583f2090d5SJed Brown #undef __FUNCT__ 1559e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep" 1560ac226902SBarry Smith /*@C 1561000e7ae3SMatthew Knepley TSSetPostStep - Sets the general-purpose function 15623f2090d5SJed Brown called once at the end of each time step. 1563000e7ae3SMatthew Knepley 15643f9fe445SBarry Smith Logically Collective on TS 1565000e7ae3SMatthew Knepley 1566000e7ae3SMatthew Knepley Input Parameters: 1567000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 1568000e7ae3SMatthew Knepley - func - The function 1569000e7ae3SMatthew Knepley 1570000e7ae3SMatthew Knepley Calling sequence of func: 1571000e7ae3SMatthew Knepley . func (TS ts); 1572000e7ae3SMatthew Knepley 1573000e7ae3SMatthew Knepley Level: intermediate 1574000e7ae3SMatthew Knepley 1575000e7ae3SMatthew Knepley .keywords: TS, timestep 1576000e7ae3SMatthew Knepley @*/ 15777087cfbeSBarry Smith PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS)) 1578000e7ae3SMatthew Knepley { 1579000e7ae3SMatthew Knepley PetscFunctionBegin; 15800700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1581000e7ae3SMatthew Knepley ts->ops->poststep = func; 1582000e7ae3SMatthew Knepley PetscFunctionReturn(0); 1583000e7ae3SMatthew Knepley } 1584000e7ae3SMatthew Knepley 1585e74ef692SMatthew Knepley #undef __FUNCT__ 15863f2090d5SJed Brown #define __FUNCT__ "TSPostStep" 158709ee8438SJed Brown /*@ 15883f2090d5SJed Brown TSPostStep - Runs the user-defined post-step function. 15893f2090d5SJed Brown 15903f2090d5SJed Brown Collective on TS 15913f2090d5SJed Brown 15923f2090d5SJed Brown Input Parameters: 15933f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 15943f2090d5SJed Brown 15953f2090d5SJed Brown Notes: 15963f2090d5SJed Brown TSPostStep() is typically used within time stepping implementations, 15973f2090d5SJed Brown so most users would not generally call this routine themselves. 15983f2090d5SJed Brown 15993f2090d5SJed Brown Level: developer 16003f2090d5SJed Brown 16013f2090d5SJed Brown .keywords: TS, timestep 16023f2090d5SJed Brown @*/ 16037087cfbeSBarry Smith PetscErrorCode TSPostStep(TS ts) 16043f2090d5SJed Brown { 16053f2090d5SJed Brown PetscErrorCode ierr; 16063f2090d5SJed Brown 16073f2090d5SJed Brown PetscFunctionBegin; 16080700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 160972ac3e02SJed Brown if (ts->ops->poststep) { 16103f2090d5SJed Brown PetscStackPush("TS PostStep function"); 16113f2090d5SJed Brown ierr = (*ts->ops->poststep)(ts);CHKERRQ(ierr); 16123f2090d5SJed Brown PetscStackPop; 161372ac3e02SJed Brown } 16143f2090d5SJed Brown PetscFunctionReturn(0); 16153f2090d5SJed Brown } 16163f2090d5SJed Brown 1617d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */ 1618d763cef2SBarry Smith 16194a2ae208SSatish Balay #undef __FUNCT__ 1620a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet" 1621d763cef2SBarry Smith /*@C 1622a6570f20SBarry Smith TSMonitorSet - Sets an ADDITIONAL function that is to be used at every 1623d763cef2SBarry Smith timestep to display the iteration's progress. 1624d763cef2SBarry Smith 16253f9fe445SBarry Smith Logically Collective on TS 1626d763cef2SBarry Smith 1627d763cef2SBarry Smith Input Parameters: 1628d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1629e213d8f1SJed Brown . monitor - monitoring routine 1630329f5518SBarry Smith . mctx - [optional] user-defined context for private data for the 1631b3006f0bSLois Curfman McInnes monitor routine (use PETSC_NULL if no context is desired) 1632b3006f0bSLois Curfman McInnes - monitordestroy - [optional] routine that frees monitor context 1633b3006f0bSLois Curfman McInnes (may be PETSC_NULL) 1634d763cef2SBarry Smith 1635e213d8f1SJed Brown Calling sequence of monitor: 1636e213d8f1SJed Brown $ int monitor(TS ts,PetscInt steps,PetscReal time,Vec x,void *mctx) 1637d763cef2SBarry Smith 1638d763cef2SBarry Smith + ts - the TS context 1639d763cef2SBarry Smith . steps - iteration number 16401f06c33eSBarry Smith . time - current time 1641d763cef2SBarry Smith . x - current iterate 1642d763cef2SBarry Smith - mctx - [optional] monitoring context 1643d763cef2SBarry Smith 1644d763cef2SBarry Smith Notes: 1645d763cef2SBarry Smith This routine adds an additional monitor to the list of monitors that 1646d763cef2SBarry Smith already has been loaded. 1647d763cef2SBarry Smith 1648025f1a04SBarry Smith Fortran notes: Only a single monitor function can be set for each TS object 1649025f1a04SBarry Smith 1650d763cef2SBarry Smith Level: intermediate 1651d763cef2SBarry Smith 1652d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 1653d763cef2SBarry Smith 1654a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel() 1655d763cef2SBarry Smith @*/ 1656c2efdce3SBarry Smith PetscErrorCode TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**)) 1657d763cef2SBarry Smith { 1658d763cef2SBarry Smith PetscFunctionBegin; 16590700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 166017186662SBarry Smith if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 1661d763cef2SBarry Smith ts->monitor[ts->numbermonitors] = monitor; 1662329f5518SBarry Smith ts->mdestroy[ts->numbermonitors] = mdestroy; 1663d763cef2SBarry Smith ts->monitorcontext[ts->numbermonitors++] = (void*)mctx; 1664d763cef2SBarry Smith PetscFunctionReturn(0); 1665d763cef2SBarry Smith } 1666d763cef2SBarry Smith 16674a2ae208SSatish Balay #undef __FUNCT__ 1668a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel" 1669d763cef2SBarry Smith /*@C 1670a6570f20SBarry Smith TSMonitorCancel - Clears all the monitors that have been set on a time-step object. 1671d763cef2SBarry Smith 16723f9fe445SBarry Smith Logically Collective on TS 1673d763cef2SBarry Smith 1674d763cef2SBarry Smith Input Parameters: 1675d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1676d763cef2SBarry Smith 1677d763cef2SBarry Smith Notes: 1678d763cef2SBarry Smith There is no way to remove a single, specific monitor. 1679d763cef2SBarry Smith 1680d763cef2SBarry Smith Level: intermediate 1681d763cef2SBarry Smith 1682d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 1683d763cef2SBarry Smith 1684a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet() 1685d763cef2SBarry Smith @*/ 16867087cfbeSBarry Smith PetscErrorCode TSMonitorCancel(TS ts) 1687d763cef2SBarry Smith { 1688d952e501SBarry Smith PetscErrorCode ierr; 1689d952e501SBarry Smith PetscInt i; 1690d952e501SBarry Smith 1691d763cef2SBarry Smith PetscFunctionBegin; 16920700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1693d952e501SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 1694d952e501SBarry Smith if (ts->mdestroy[i]) { 16953c4aec1bSBarry Smith ierr = (*ts->mdestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr); 1696d952e501SBarry Smith } 1697d952e501SBarry Smith } 1698d763cef2SBarry Smith ts->numbermonitors = 0; 1699d763cef2SBarry Smith PetscFunctionReturn(0); 1700d763cef2SBarry Smith } 1701d763cef2SBarry Smith 17024a2ae208SSatish Balay #undef __FUNCT__ 1703a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault" 1704d8e5e3e6SSatish Balay /*@ 1705a6570f20SBarry Smith TSMonitorDefault - Sets the Default monitor 17065516499fSSatish Balay 17075516499fSSatish Balay Level: intermediate 170841251cbbSSatish Balay 17095516499fSSatish Balay .keywords: TS, set, monitor 17105516499fSSatish Balay 171141251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet() 171241251cbbSSatish Balay @*/ 1713649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy) 1714d763cef2SBarry Smith { 1715dfbe8321SBarry Smith PetscErrorCode ierr; 1716649052a6SBarry Smith PetscViewer viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(((PetscObject)ts)->comm); 1717d132466eSBarry Smith 1718d763cef2SBarry Smith PetscFunctionBegin; 1719649052a6SBarry Smith ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 1720971832b6SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g\n",step,(double)ts->time_step,(double)ptime);CHKERRQ(ierr); 1721649052a6SBarry Smith ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 1722d763cef2SBarry Smith PetscFunctionReturn(0); 1723d763cef2SBarry Smith } 1724d763cef2SBarry Smith 17254a2ae208SSatish Balay #undef __FUNCT__ 1726cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages" 1727cd652676SJed Brown /*@ 1728cd652676SJed Brown TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available. 1729cd652676SJed Brown 1730cd652676SJed Brown Logically Collective on TS 1731cd652676SJed Brown 1732cd652676SJed Brown Input Argument: 1733cd652676SJed Brown . ts - time stepping context 1734cd652676SJed Brown 1735cd652676SJed Brown Output Argument: 1736cd652676SJed Brown . flg - PETSC_TRUE or PETSC_FALSE 1737cd652676SJed Brown 1738cd652676SJed Brown Level: intermediate 1739cd652676SJed Brown 1740cd652676SJed Brown .keywords: TS, set 1741cd652676SJed Brown 1742cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep() 1743cd652676SJed Brown @*/ 1744cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg) 1745cd652676SJed Brown { 1746cd652676SJed Brown 1747cd652676SJed Brown PetscFunctionBegin; 1748cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1749cd652676SJed Brown ts->retain_stages = flg; 1750cd652676SJed Brown PetscFunctionReturn(0); 1751cd652676SJed Brown } 1752cd652676SJed Brown 1753cd652676SJed Brown #undef __FUNCT__ 1754cd652676SJed Brown #define __FUNCT__ "TSInterpolate" 1755cd652676SJed Brown /*@ 1756cd652676SJed Brown TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval 1757cd652676SJed Brown 1758cd652676SJed Brown Collective on TS 1759cd652676SJed Brown 1760cd652676SJed Brown Input Argument: 1761cd652676SJed Brown + ts - time stepping context 1762cd652676SJed Brown - t - time to interpolate to 1763cd652676SJed Brown 1764cd652676SJed Brown Output Argument: 1765cd652676SJed Brown . X - state at given time 1766cd652676SJed Brown 1767cd652676SJed Brown Notes: 1768cd652676SJed Brown The user should call TSSetRetainStages() before taking a step in which interpolation will be requested. 1769cd652676SJed Brown 1770cd652676SJed Brown Level: intermediate 1771cd652676SJed Brown 1772cd652676SJed Brown Developer Notes: 1773cd652676SJed Brown TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints. 1774cd652676SJed Brown 1775cd652676SJed Brown .keywords: TS, set 1776cd652676SJed Brown 1777cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep() 1778cd652676SJed Brown @*/ 1779cd652676SJed Brown PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec X) 1780cd652676SJed Brown { 1781cd652676SJed Brown PetscErrorCode ierr; 1782cd652676SJed Brown 1783cd652676SJed Brown PetscFunctionBegin; 1784cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1785d8cd7023SBarry Smith if (t < ts->ptime - ts->time_step_prev || t > ts->ptime) SETERRQ3(((PetscObject)ts)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Requested time %G not in last time steps [%G,%G]",t,ts->ptime-ts->time_step_prev,ts->ptime); 1786cd652676SJed Brown if (!ts->ops->interpolate) SETERRQ1(((PetscObject)ts)->comm,PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name); 1787cd652676SJed Brown ierr = (*ts->ops->interpolate)(ts,t,X);CHKERRQ(ierr); 1788cd652676SJed Brown PetscFunctionReturn(0); 1789cd652676SJed Brown } 1790cd652676SJed Brown 1791cd652676SJed Brown #undef __FUNCT__ 17924a2ae208SSatish Balay #define __FUNCT__ "TSStep" 1793d763cef2SBarry Smith /*@ 17946d9e5789SSean Farley TSStep - Steps one time step 1795d763cef2SBarry Smith 1796d763cef2SBarry Smith Collective on TS 1797d763cef2SBarry Smith 1798d763cef2SBarry Smith Input Parameter: 1799d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1800d763cef2SBarry Smith 18016d9e5789SSean Farley Level: intermediate 1802d763cef2SBarry Smith 1803d763cef2SBarry Smith .keywords: TS, timestep, solve 1804d763cef2SBarry Smith 18056d9e5789SSean Farley .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve() 1806d763cef2SBarry Smith @*/ 1807193ac0bcSJed Brown PetscErrorCode TSStep(TS ts) 1808d763cef2SBarry Smith { 1809362cd11cSLisandro Dalcin PetscReal ptime_prev; 1810dfbe8321SBarry Smith PetscErrorCode ierr; 1811d763cef2SBarry Smith 1812d763cef2SBarry Smith PetscFunctionBegin; 18130700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1814d405a339SMatthew Knepley ierr = TSSetUp(ts);CHKERRQ(ierr); 1815d405a339SMatthew Knepley 1816362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_ITERATING; 1817362cd11cSLisandro Dalcin 1818362cd11cSLisandro Dalcin ptime_prev = ts->ptime; 1819d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 1820193ac0bcSJed Brown ierr = (*ts->ops->step)(ts);CHKERRQ(ierr); 1821d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 1822362cd11cSLisandro Dalcin ts->time_step_prev = ts->ptime - ptime_prev; 1823362cd11cSLisandro Dalcin 1824362cd11cSLisandro Dalcin if (ts->reason < 0) { 1825f1b97656SJed Brown if (ts->errorifstepfailed) SETERRQ1(((PetscObject)ts)->comm,PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 1826362cd11cSLisandro Dalcin } else if (!ts->reason) { 1827362cd11cSLisandro Dalcin if (ts->steps >= ts->max_steps) 1828362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_ITS; 1829362cd11cSLisandro Dalcin else if (ts->ptime >= ts->max_time) 1830362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_TIME; 1831362cd11cSLisandro Dalcin } 1832362cd11cSLisandro Dalcin 1833d763cef2SBarry Smith PetscFunctionReturn(0); 1834d763cef2SBarry Smith } 1835d763cef2SBarry Smith 18364a2ae208SSatish Balay #undef __FUNCT__ 183705175c85SJed Brown #define __FUNCT__ "TSEvaluateStep" 183805175c85SJed Brown /*@ 183905175c85SJed Brown TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy. 184005175c85SJed Brown 18411c3436cfSJed Brown Collective on TS 184205175c85SJed Brown 184305175c85SJed Brown Input Arguments: 18441c3436cfSJed Brown + ts - time stepping context 18451c3436cfSJed Brown . order - desired order of accuracy 18461c3436cfSJed Brown - done - whether the step was evaluated at this order (pass PETSC_NULL to generate an error if not available) 184705175c85SJed Brown 184805175c85SJed Brown Output Arguments: 18491c3436cfSJed Brown . X - state at the end of the current step 185005175c85SJed Brown 185105175c85SJed Brown Level: advanced 185205175c85SJed Brown 1853108c343cSJed Brown Notes: 1854108c343cSJed Brown This function cannot be called until all stages have been evaluated. 1855108c343cSJed Brown It is normally called by adaptive controllers before a step has been accepted and may also be called by the user after TSStep() has returned. 1856108c343cSJed Brown 18571c3436cfSJed Brown .seealso: TSStep(), TSAdapt 185805175c85SJed Brown @*/ 18591c3436cfSJed Brown PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec X,PetscBool *done) 186005175c85SJed Brown { 186105175c85SJed Brown PetscErrorCode ierr; 186205175c85SJed Brown 186305175c85SJed Brown PetscFunctionBegin; 186405175c85SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 186505175c85SJed Brown PetscValidType(ts,1); 186605175c85SJed Brown PetscValidHeaderSpecific(X,VEC_CLASSID,3); 18671c3436cfSJed Brown if (!ts->ops->evaluatestep) SETERRQ1(((PetscObject)ts)->comm,PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name); 18681c3436cfSJed Brown ierr = (*ts->ops->evaluatestep)(ts,order,X,done);CHKERRQ(ierr); 186905175c85SJed Brown PetscFunctionReturn(0); 187005175c85SJed Brown } 187105175c85SJed Brown 187205175c85SJed Brown #undef __FUNCT__ 18736a4d4014SLisandro Dalcin #define __FUNCT__ "TSSolve" 18746a4d4014SLisandro Dalcin /*@ 18756a4d4014SLisandro Dalcin TSSolve - Steps the requested number of timesteps. 18766a4d4014SLisandro Dalcin 18776a4d4014SLisandro Dalcin Collective on TS 18786a4d4014SLisandro Dalcin 18796a4d4014SLisandro Dalcin Input Parameter: 18806a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 1881362cd11cSLisandro Dalcin - x - the solution vector 18826a4d4014SLisandro Dalcin 18835a3a76d0SJed Brown Output Parameter: 18845a3a76d0SJed Brown . ftime - time of the state vector x upon completion 18855a3a76d0SJed Brown 18866a4d4014SLisandro Dalcin Level: beginner 18876a4d4014SLisandro Dalcin 18885a3a76d0SJed Brown Notes: 18895a3a76d0SJed Brown The final time returned by this function may be different from the time of the internally 18905a3a76d0SJed Brown held state accessible by TSGetSolution() and TSGetTime() because the method may have 18915a3a76d0SJed Brown stepped over the final time. 18925a3a76d0SJed Brown 18936a4d4014SLisandro Dalcin .keywords: TS, timestep, solve 18946a4d4014SLisandro Dalcin 18956a4d4014SLisandro Dalcin .seealso: TSCreate(), TSSetSolution(), TSStep() 18966a4d4014SLisandro Dalcin @*/ 18975a3a76d0SJed Brown PetscErrorCode TSSolve(TS ts,Vec x,PetscReal *ftime) 18986a4d4014SLisandro Dalcin { 18994d7d938eSLisandro Dalcin PetscBool flg; 19004d7d938eSLisandro Dalcin char filename[PETSC_MAX_PATH_LEN]; 19014d7d938eSLisandro Dalcin PetscViewer viewer; 19026a4d4014SLisandro Dalcin PetscErrorCode ierr; 1903f22f69f0SBarry Smith 19046a4d4014SLisandro Dalcin PetscFunctionBegin; 19050700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1906193ac0bcSJed Brown PetscValidHeaderSpecific(x,VEC_CLASSID,2); 19075a3a76d0SJed Brown if (ts->exact_final_time) { /* Need ts->vec_sol to be distinct so it is not overwritten when we interpolate at the end */ 19085a3a76d0SJed Brown if (!ts->vec_sol || x == ts->vec_sol) { 19095a3a76d0SJed Brown Vec y; 19105a3a76d0SJed Brown ierr = VecDuplicate(x,&y);CHKERRQ(ierr); 19115a3a76d0SJed Brown ierr = TSSetSolution(ts,y);CHKERRQ(ierr); 19125a3a76d0SJed Brown ierr = VecDestroy(&y);CHKERRQ(ierr); /* grant ownership */ 19135a3a76d0SJed Brown } 1914362cd11cSLisandro Dalcin ierr = VecCopy(x,ts->vec_sol);CHKERRQ(ierr); 19155a3a76d0SJed Brown } else { 1916193ac0bcSJed Brown ierr = TSSetSolution(ts,x);CHKERRQ(ierr); 19175a3a76d0SJed Brown } 1918b5d403baSSean Farley ierr = TSSetUp(ts);CHKERRQ(ierr); 19196a4d4014SLisandro Dalcin /* reset time step and iteration counters */ 1920193ac0bcSJed Brown ts->steps = 0; 1921193ac0bcSJed Brown ts->linear_its = 0; 1922193ac0bcSJed Brown ts->nonlinear_its = 0; 1923c610991cSLisandro Dalcin ts->num_snes_failures = 0; 1924c610991cSLisandro Dalcin ts->reject = 0; 1925193ac0bcSJed Brown ts->reason = TS_CONVERGED_ITERATING; 1926193ac0bcSJed Brown 1927193ac0bcSJed Brown if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 1928193ac0bcSJed Brown ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr); 19295a3a76d0SJed Brown ierr = VecCopy(ts->vec_sol,x);CHKERRQ(ierr); 1930a5b82c69SSean Farley if (ftime) *ftime = ts->ptime; 1931193ac0bcSJed Brown } else { 19326a4d4014SLisandro Dalcin /* steps the requested number of timesteps. */ 1933362cd11cSLisandro Dalcin ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 1934362cd11cSLisandro Dalcin if (ts->steps >= ts->max_steps) 1935362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_ITS; 1936362cd11cSLisandro Dalcin else if (ts->ptime >= ts->max_time) 1937362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_TIME; 1938e1a7a14fSJed Brown while (!ts->reason) { 1939193ac0bcSJed Brown ierr = TSPreStep(ts);CHKERRQ(ierr); 1940193ac0bcSJed Brown ierr = TSStep(ts);CHKERRQ(ierr); 1941193ac0bcSJed Brown ierr = TSPostStep(ts);CHKERRQ(ierr); 1942193ac0bcSJed Brown ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 1943193ac0bcSJed Brown } 1944362cd11cSLisandro Dalcin if (ts->exact_final_time && ts->ptime > ts->max_time) { 1945a43b19c4SJed Brown ierr = TSInterpolate(ts,ts->max_time,x);CHKERRQ(ierr); 19465a3a76d0SJed Brown if (ftime) *ftime = ts->max_time; 19470574a7fbSJed Brown } else { 19480574a7fbSJed Brown ierr = VecCopy(ts->vec_sol,x);CHKERRQ(ierr); 19490574a7fbSJed Brown if (ftime) *ftime = ts->ptime; 19500574a7fbSJed Brown } 1951193ac0bcSJed Brown } 19524d7d938eSLisandro Dalcin ierr = PetscOptionsGetString(((PetscObject)ts)->prefix,"-ts_view",filename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 19534d7d938eSLisandro Dalcin if (flg && !PetscPreLoadingOn) { 19544d7d938eSLisandro Dalcin ierr = PetscViewerASCIIOpen(((PetscObject)ts)->comm,filename,&viewer);CHKERRQ(ierr); 19554d7d938eSLisandro Dalcin ierr = TSView(ts,viewer);CHKERRQ(ierr); 19564d7d938eSLisandro Dalcin ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 1957193ac0bcSJed Brown } 19586a4d4014SLisandro Dalcin PetscFunctionReturn(0); 19596a4d4014SLisandro Dalcin } 19606a4d4014SLisandro Dalcin 19616a4d4014SLisandro Dalcin #undef __FUNCT__ 19624a2ae208SSatish Balay #define __FUNCT__ "TSMonitor" 1963228d79bcSJed Brown /*@ 1964228d79bcSJed Brown TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet() 1965228d79bcSJed Brown 1966228d79bcSJed Brown Collective on TS 1967228d79bcSJed Brown 1968228d79bcSJed Brown Input Parameters: 1969228d79bcSJed Brown + ts - time stepping context obtained from TSCreate() 1970228d79bcSJed Brown . step - step number that has just completed 1971228d79bcSJed Brown . ptime - model time of the state 1972228d79bcSJed Brown - x - state at the current model time 1973228d79bcSJed Brown 1974228d79bcSJed Brown Notes: 1975228d79bcSJed Brown TSMonitor() is typically used within the time stepping implementations. 1976228d79bcSJed Brown Users might call this function when using the TSStep() interface instead of TSSolve(). 1977228d79bcSJed Brown 1978228d79bcSJed Brown Level: advanced 1979228d79bcSJed Brown 1980228d79bcSJed Brown .keywords: TS, timestep 1981228d79bcSJed Brown @*/ 1982a7cc72afSBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec x) 1983d763cef2SBarry Smith { 19846849ba73SBarry Smith PetscErrorCode ierr; 1985a7cc72afSBarry Smith PetscInt i,n = ts->numbermonitors; 1986d763cef2SBarry Smith 1987d763cef2SBarry Smith PetscFunctionBegin; 1988d763cef2SBarry Smith for (i=0; i<n; i++) { 1989142b95e3SSatish Balay ierr = (*ts->monitor[i])(ts,step,ptime,x,ts->monitorcontext[i]);CHKERRQ(ierr); 1990d763cef2SBarry Smith } 1991d763cef2SBarry Smith PetscFunctionReturn(0); 1992d763cef2SBarry Smith } 1993d763cef2SBarry Smith 1994d763cef2SBarry Smith /* ------------------------------------------------------------------------*/ 1995d763cef2SBarry Smith 19964a2ae208SSatish Balay #undef __FUNCT__ 1997a6570f20SBarry Smith #define __FUNCT__ "TSMonitorLGCreate" 1998d763cef2SBarry Smith /*@C 1999a6570f20SBarry Smith TSMonitorLGCreate - Creates a line graph context for use with 2000d763cef2SBarry Smith TS to monitor convergence of preconditioned residual norms. 2001d763cef2SBarry Smith 2002d763cef2SBarry Smith Collective on TS 2003d763cef2SBarry Smith 2004d763cef2SBarry Smith Input Parameters: 2005d763cef2SBarry Smith + host - the X display to open, or null for the local machine 2006d763cef2SBarry Smith . label - the title to put in the title bar 20077c922b88SBarry Smith . x, y - the screen coordinates of the upper left coordinate of the window 2008d763cef2SBarry Smith - m, n - the screen width and height in pixels 2009d763cef2SBarry Smith 2010d763cef2SBarry Smith Output Parameter: 2011d763cef2SBarry Smith . draw - the drawing context 2012d763cef2SBarry Smith 2013d763cef2SBarry Smith Options Database Key: 2014a6570f20SBarry Smith . -ts_monitor_draw - automatically sets line graph monitor 2015d763cef2SBarry Smith 2016d763cef2SBarry Smith Notes: 2017a6570f20SBarry Smith Use TSMonitorLGDestroy() to destroy this line graph, not PetscDrawLGDestroy(). 2018d763cef2SBarry Smith 2019d763cef2SBarry Smith Level: intermediate 2020d763cef2SBarry Smith 20217c922b88SBarry Smith .keywords: TS, monitor, line graph, residual, seealso 2022d763cef2SBarry Smith 2023a6570f20SBarry Smith .seealso: TSMonitorLGDestroy(), TSMonitorSet() 20247c922b88SBarry Smith 2025d763cef2SBarry Smith @*/ 20267087cfbeSBarry Smith PetscErrorCode TSMonitorLGCreate(const char host[],const char label[],int x,int y,int m,int n,PetscDrawLG *draw) 2027d763cef2SBarry Smith { 2028b0a32e0cSBarry Smith PetscDraw win; 2029dfbe8321SBarry Smith PetscErrorCode ierr; 2030d763cef2SBarry Smith 2031d763cef2SBarry Smith PetscFunctionBegin; 2032b0a32e0cSBarry Smith ierr = PetscDrawCreate(PETSC_COMM_SELF,host,label,x,y,m,n,&win);CHKERRQ(ierr); 2033b0a32e0cSBarry Smith ierr = PetscDrawSetType(win,PETSC_DRAW_X);CHKERRQ(ierr); 2034b0a32e0cSBarry Smith ierr = PetscDrawLGCreate(win,1,draw);CHKERRQ(ierr); 2035b0a32e0cSBarry Smith ierr = PetscDrawLGIndicateDataPoints(*draw);CHKERRQ(ierr); 2036d763cef2SBarry Smith 203752e6d16bSBarry Smith ierr = PetscLogObjectParent(*draw,win);CHKERRQ(ierr); 2038d763cef2SBarry Smith PetscFunctionReturn(0); 2039d763cef2SBarry Smith } 2040d763cef2SBarry Smith 20414a2ae208SSatish Balay #undef __FUNCT__ 2042a6570f20SBarry Smith #define __FUNCT__ "TSMonitorLG" 2043a6570f20SBarry Smith PetscErrorCode TSMonitorLG(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 2044d763cef2SBarry Smith { 2045b0a32e0cSBarry Smith PetscDrawLG lg = (PetscDrawLG) monctx; 204687828ca2SBarry Smith PetscReal x,y = ptime; 2047dfbe8321SBarry Smith PetscErrorCode ierr; 2048d763cef2SBarry Smith 2049d763cef2SBarry Smith PetscFunctionBegin; 20507c922b88SBarry Smith if (!monctx) { 20517c922b88SBarry Smith MPI_Comm comm; 2052b0a32e0cSBarry Smith PetscViewer viewer; 20537c922b88SBarry Smith 20547c922b88SBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 2055b0a32e0cSBarry Smith viewer = PETSC_VIEWER_DRAW_(comm); 2056b0a32e0cSBarry Smith ierr = PetscViewerDrawGetDrawLG(viewer,0,&lg);CHKERRQ(ierr); 20577c922b88SBarry Smith } 20587c922b88SBarry Smith 2059b0a32e0cSBarry Smith if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);} 206087828ca2SBarry Smith x = (PetscReal)n; 2061b0a32e0cSBarry Smith ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr); 2062d763cef2SBarry Smith if (n < 20 || (n % 5)) { 2063b0a32e0cSBarry Smith ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr); 2064d763cef2SBarry Smith } 2065d763cef2SBarry Smith PetscFunctionReturn(0); 2066d763cef2SBarry Smith } 2067d763cef2SBarry Smith 20684a2ae208SSatish Balay #undef __FUNCT__ 2069a6570f20SBarry Smith #define __FUNCT__ "TSMonitorLGDestroy" 2070d763cef2SBarry Smith /*@C 2071a6570f20SBarry Smith TSMonitorLGDestroy - Destroys a line graph context that was created 2072a6570f20SBarry Smith with TSMonitorLGCreate(). 2073d763cef2SBarry Smith 2074b0a32e0cSBarry Smith Collective on PetscDrawLG 2075d763cef2SBarry Smith 2076d763cef2SBarry Smith Input Parameter: 2077d763cef2SBarry Smith . draw - the drawing context 2078d763cef2SBarry Smith 2079d763cef2SBarry Smith Level: intermediate 2080d763cef2SBarry Smith 2081d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy 2082d763cef2SBarry Smith 2083a6570f20SBarry Smith .seealso: TSMonitorLGCreate(), TSMonitorSet(), TSMonitorLG(); 2084d763cef2SBarry Smith @*/ 20856bf464f9SBarry Smith PetscErrorCode TSMonitorLGDestroy(PetscDrawLG *drawlg) 2086d763cef2SBarry Smith { 2087b0a32e0cSBarry Smith PetscDraw draw; 2088dfbe8321SBarry Smith PetscErrorCode ierr; 2089d763cef2SBarry Smith 2090d763cef2SBarry Smith PetscFunctionBegin; 20916bf464f9SBarry Smith ierr = PetscDrawLGGetDraw(*drawlg,&draw);CHKERRQ(ierr); 20926bf464f9SBarry Smith ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 2093b0a32e0cSBarry Smith ierr = PetscDrawLGDestroy(drawlg);CHKERRQ(ierr); 2094d763cef2SBarry Smith PetscFunctionReturn(0); 2095d763cef2SBarry Smith } 2096d763cef2SBarry Smith 20974a2ae208SSatish Balay #undef __FUNCT__ 20984a2ae208SSatish Balay #define __FUNCT__ "TSGetTime" 2099d763cef2SBarry Smith /*@ 2100d763cef2SBarry Smith TSGetTime - Gets the current time. 2101d763cef2SBarry Smith 2102d763cef2SBarry Smith Not Collective 2103d763cef2SBarry Smith 2104d763cef2SBarry Smith Input Parameter: 2105d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2106d763cef2SBarry Smith 2107d763cef2SBarry Smith Output Parameter: 2108d763cef2SBarry Smith . t - the current time 2109d763cef2SBarry Smith 2110d763cef2SBarry Smith Level: beginner 2111d763cef2SBarry Smith 2112d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 2113d763cef2SBarry Smith 2114d763cef2SBarry Smith .keywords: TS, get, time 2115d763cef2SBarry Smith @*/ 21167087cfbeSBarry Smith PetscErrorCode TSGetTime(TS ts,PetscReal* t) 2117d763cef2SBarry Smith { 2118d763cef2SBarry Smith PetscFunctionBegin; 21190700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 21204482741eSBarry Smith PetscValidDoublePointer(t,2); 2121d763cef2SBarry Smith *t = ts->ptime; 2122d763cef2SBarry Smith PetscFunctionReturn(0); 2123d763cef2SBarry Smith } 2124d763cef2SBarry Smith 21254a2ae208SSatish Balay #undef __FUNCT__ 21266a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime" 21276a4d4014SLisandro Dalcin /*@ 21286a4d4014SLisandro Dalcin TSSetTime - Allows one to reset the time. 21296a4d4014SLisandro Dalcin 21303f9fe445SBarry Smith Logically Collective on TS 21316a4d4014SLisandro Dalcin 21326a4d4014SLisandro Dalcin Input Parameters: 21336a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 21346a4d4014SLisandro Dalcin - time - the time 21356a4d4014SLisandro Dalcin 21366a4d4014SLisandro Dalcin Level: intermediate 21376a4d4014SLisandro Dalcin 21386a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration() 21396a4d4014SLisandro Dalcin 21406a4d4014SLisandro Dalcin .keywords: TS, set, time 21416a4d4014SLisandro Dalcin @*/ 21427087cfbeSBarry Smith PetscErrorCode TSSetTime(TS ts, PetscReal t) 21436a4d4014SLisandro Dalcin { 21446a4d4014SLisandro Dalcin PetscFunctionBegin; 21450700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2146c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,t,2); 21476a4d4014SLisandro Dalcin ts->ptime = t; 21486a4d4014SLisandro Dalcin PetscFunctionReturn(0); 21496a4d4014SLisandro Dalcin } 21506a4d4014SLisandro Dalcin 21516a4d4014SLisandro Dalcin #undef __FUNCT__ 21524a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix" 2153d763cef2SBarry Smith /*@C 2154d763cef2SBarry Smith TSSetOptionsPrefix - Sets the prefix used for searching for all 2155d763cef2SBarry Smith TS options in the database. 2156d763cef2SBarry Smith 21573f9fe445SBarry Smith Logically Collective on TS 2158d763cef2SBarry Smith 2159d763cef2SBarry Smith Input Parameter: 2160d763cef2SBarry Smith + ts - The TS context 2161d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 2162d763cef2SBarry Smith 2163d763cef2SBarry Smith Notes: 2164d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 2165d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 2166d763cef2SBarry Smith hyphen. 2167d763cef2SBarry Smith 2168d763cef2SBarry Smith Level: advanced 2169d763cef2SBarry Smith 2170d763cef2SBarry Smith .keywords: TS, set, options, prefix, database 2171d763cef2SBarry Smith 2172d763cef2SBarry Smith .seealso: TSSetFromOptions() 2173d763cef2SBarry Smith 2174d763cef2SBarry Smith @*/ 21757087cfbeSBarry Smith PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[]) 2176d763cef2SBarry Smith { 2177dfbe8321SBarry Smith PetscErrorCode ierr; 2178089b2837SJed Brown SNES snes; 2179d763cef2SBarry Smith 2180d763cef2SBarry Smith PetscFunctionBegin; 21810700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2182d763cef2SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 2183089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2184089b2837SJed Brown ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr); 2185d763cef2SBarry Smith PetscFunctionReturn(0); 2186d763cef2SBarry Smith } 2187d763cef2SBarry Smith 2188d763cef2SBarry Smith 21894a2ae208SSatish Balay #undef __FUNCT__ 21904a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix" 2191d763cef2SBarry Smith /*@C 2192d763cef2SBarry Smith TSAppendOptionsPrefix - Appends to the prefix used for searching for all 2193d763cef2SBarry Smith TS options in the database. 2194d763cef2SBarry Smith 21953f9fe445SBarry Smith Logically Collective on TS 2196d763cef2SBarry Smith 2197d763cef2SBarry Smith Input Parameter: 2198d763cef2SBarry Smith + ts - The TS context 2199d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 2200d763cef2SBarry Smith 2201d763cef2SBarry Smith Notes: 2202d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 2203d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 2204d763cef2SBarry Smith hyphen. 2205d763cef2SBarry Smith 2206d763cef2SBarry Smith Level: advanced 2207d763cef2SBarry Smith 2208d763cef2SBarry Smith .keywords: TS, append, options, prefix, database 2209d763cef2SBarry Smith 2210d763cef2SBarry Smith .seealso: TSGetOptionsPrefix() 2211d763cef2SBarry Smith 2212d763cef2SBarry Smith @*/ 22137087cfbeSBarry Smith PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[]) 2214d763cef2SBarry Smith { 2215dfbe8321SBarry Smith PetscErrorCode ierr; 2216089b2837SJed Brown SNES snes; 2217d763cef2SBarry Smith 2218d763cef2SBarry Smith PetscFunctionBegin; 22190700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2220d763cef2SBarry Smith ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 2221089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2222089b2837SJed Brown ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr); 2223d763cef2SBarry Smith PetscFunctionReturn(0); 2224d763cef2SBarry Smith } 2225d763cef2SBarry Smith 22264a2ae208SSatish Balay #undef __FUNCT__ 22274a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix" 2228d763cef2SBarry Smith /*@C 2229d763cef2SBarry Smith TSGetOptionsPrefix - Sets the prefix used for searching for all 2230d763cef2SBarry Smith TS options in the database. 2231d763cef2SBarry Smith 2232d763cef2SBarry Smith Not Collective 2233d763cef2SBarry Smith 2234d763cef2SBarry Smith Input Parameter: 2235d763cef2SBarry Smith . ts - The TS context 2236d763cef2SBarry Smith 2237d763cef2SBarry Smith Output Parameter: 2238d763cef2SBarry Smith . prefix - A pointer to the prefix string used 2239d763cef2SBarry Smith 2240d763cef2SBarry Smith Notes: On the fortran side, the user should pass in a string 'prifix' of 2241d763cef2SBarry Smith sufficient length to hold the prefix. 2242d763cef2SBarry Smith 2243d763cef2SBarry Smith Level: intermediate 2244d763cef2SBarry Smith 2245d763cef2SBarry Smith .keywords: TS, get, options, prefix, database 2246d763cef2SBarry Smith 2247d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix() 2248d763cef2SBarry Smith @*/ 22497087cfbeSBarry Smith PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[]) 2250d763cef2SBarry Smith { 2251dfbe8321SBarry Smith PetscErrorCode ierr; 2252d763cef2SBarry Smith 2253d763cef2SBarry Smith PetscFunctionBegin; 22540700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 22554482741eSBarry Smith PetscValidPointer(prefix,2); 2256d763cef2SBarry Smith ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 2257d763cef2SBarry Smith PetscFunctionReturn(0); 2258d763cef2SBarry Smith } 2259d763cef2SBarry Smith 22604a2ae208SSatish Balay #undef __FUNCT__ 22614a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian" 2262d763cef2SBarry Smith /*@C 2263d763cef2SBarry Smith TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 2264d763cef2SBarry Smith 2265d763cef2SBarry Smith Not Collective, but parallel objects are returned if TS is parallel 2266d763cef2SBarry Smith 2267d763cef2SBarry Smith Input Parameter: 2268d763cef2SBarry Smith . ts - The TS context obtained from TSCreate() 2269d763cef2SBarry Smith 2270d763cef2SBarry Smith Output Parameters: 2271d763cef2SBarry Smith + J - The Jacobian J of F, where U_t = F(U,t) 2272d763cef2SBarry Smith . M - The preconditioner matrix, usually the same as J 2273089b2837SJed Brown . func - Function to compute the Jacobian of the RHS 2274d763cef2SBarry Smith - ctx - User-defined context for Jacobian evaluation routine 2275d763cef2SBarry Smith 2276d763cef2SBarry Smith Notes: You can pass in PETSC_NULL for any return argument you do not need. 2277d763cef2SBarry Smith 2278d763cef2SBarry Smith Level: intermediate 2279d763cef2SBarry Smith 228026d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 2281d763cef2SBarry Smith 2282d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian 2283d763cef2SBarry Smith @*/ 2284089b2837SJed Brown PetscErrorCode TSGetRHSJacobian(TS ts,Mat *J,Mat *M,TSRHSJacobian *func,void **ctx) 2285d763cef2SBarry Smith { 2286089b2837SJed Brown PetscErrorCode ierr; 2287089b2837SJed Brown SNES snes; 2288089b2837SJed Brown 2289d763cef2SBarry Smith PetscFunctionBegin; 2290089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2291089b2837SJed Brown ierr = SNESGetJacobian(snes,J,M,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 22923b5f76d0SSean Farley if (func) *func = ts->userops->rhsjacobian; 229326d46c62SHong Zhang if (ctx) *ctx = ts->jacP; 2294d763cef2SBarry Smith PetscFunctionReturn(0); 2295d763cef2SBarry Smith } 2296d763cef2SBarry Smith 22971713a123SBarry Smith #undef __FUNCT__ 22982eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian" 22992eca1d9cSJed Brown /*@C 23002eca1d9cSJed Brown TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 23012eca1d9cSJed Brown 23022eca1d9cSJed Brown Not Collective, but parallel objects are returned if TS is parallel 23032eca1d9cSJed Brown 23042eca1d9cSJed Brown Input Parameter: 23052eca1d9cSJed Brown . ts - The TS context obtained from TSCreate() 23062eca1d9cSJed Brown 23072eca1d9cSJed Brown Output Parameters: 23082eca1d9cSJed Brown + A - The Jacobian of F(t,U,U_t) 23092eca1d9cSJed Brown . B - The preconditioner matrix, often the same as A 23102eca1d9cSJed Brown . f - The function to compute the matrices 23112eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine 23122eca1d9cSJed Brown 23132eca1d9cSJed Brown Notes: You can pass in PETSC_NULL for any return argument you do not need. 23142eca1d9cSJed Brown 23152eca1d9cSJed Brown Level: advanced 23162eca1d9cSJed Brown 23172eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 23182eca1d9cSJed Brown 23192eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian 23202eca1d9cSJed Brown @*/ 23217087cfbeSBarry Smith PetscErrorCode TSGetIJacobian(TS ts,Mat *A,Mat *B,TSIJacobian *f,void **ctx) 23222eca1d9cSJed Brown { 2323089b2837SJed Brown PetscErrorCode ierr; 2324089b2837SJed Brown SNES snes; 2325089b2837SJed Brown 23262eca1d9cSJed Brown PetscFunctionBegin; 2327089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2328089b2837SJed Brown ierr = SNESGetJacobian(snes,A,B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 23293b5f76d0SSean Farley if (f) *f = ts->userops->ijacobian; 23302eca1d9cSJed Brown if (ctx) *ctx = ts->jacP; 23312eca1d9cSJed Brown PetscFunctionReturn(0); 23322eca1d9cSJed Brown } 23332eca1d9cSJed Brown 23346083293cSBarry Smith typedef struct { 23356083293cSBarry Smith PetscViewer viewer; 23366083293cSBarry Smith Vec initialsolution; 23376083293cSBarry Smith PetscBool showinitial; 23386083293cSBarry Smith } TSMonitorSolutionCtx; 23396083293cSBarry Smith 23402eca1d9cSJed Brown #undef __FUNCT__ 2341a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSolution" 23421713a123SBarry Smith /*@C 2343a6570f20SBarry Smith TSMonitorSolution - Monitors progress of the TS solvers by calling 23441713a123SBarry Smith VecView() for the solution at each timestep 23451713a123SBarry Smith 23461713a123SBarry Smith Collective on TS 23471713a123SBarry Smith 23481713a123SBarry Smith Input Parameters: 23491713a123SBarry Smith + ts - the TS context 23501713a123SBarry Smith . step - current time-step 2351142b95e3SSatish Balay . ptime - current time 23521713a123SBarry Smith - dummy - either a viewer or PETSC_NULL 23531713a123SBarry Smith 23541713a123SBarry Smith Level: intermediate 23551713a123SBarry Smith 23561713a123SBarry Smith .keywords: TS, vector, monitor, view 23571713a123SBarry Smith 2358a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 23591713a123SBarry Smith @*/ 23607087cfbeSBarry Smith PetscErrorCode TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec x,void *dummy) 23611713a123SBarry Smith { 2362dfbe8321SBarry Smith PetscErrorCode ierr; 23636083293cSBarry Smith TSMonitorSolutionCtx *ictx = (TSMonitorSolutionCtx*)dummy; 23641713a123SBarry Smith 23651713a123SBarry Smith PetscFunctionBegin; 23666083293cSBarry Smith if (!step && ictx->showinitial) { 23676083293cSBarry Smith if (!ictx->initialsolution) { 23686083293cSBarry Smith ierr = VecDuplicate(x,&ictx->initialsolution);CHKERRQ(ierr); 23691713a123SBarry Smith } 23706083293cSBarry Smith ierr = VecCopy(x,ictx->initialsolution);CHKERRQ(ierr); 23716083293cSBarry Smith } 23726083293cSBarry Smith if (ictx->showinitial) { 23736083293cSBarry Smith PetscReal pause; 23746083293cSBarry Smith ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr); 23756083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr); 23766083293cSBarry Smith ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr); 23776083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr); 23786083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr); 23796083293cSBarry Smith } 23806083293cSBarry Smith ierr = VecView(x,ictx->viewer);CHKERRQ(ierr); 23816083293cSBarry Smith if (ictx->showinitial) { 23826083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr); 23836083293cSBarry Smith } 23841713a123SBarry Smith PetscFunctionReturn(0); 23851713a123SBarry Smith } 23861713a123SBarry Smith 23871713a123SBarry Smith 23886c699258SBarry Smith #undef __FUNCT__ 23896083293cSBarry Smith #define __FUNCT__ "TSMonitorSolutionDestroy" 23906083293cSBarry Smith /*@C 23916083293cSBarry Smith TSMonitorSolutionDestroy - Destroys the monitor context for TSMonitorSolution 23926083293cSBarry Smith 23936083293cSBarry Smith Collective on TS 23946083293cSBarry Smith 23956083293cSBarry Smith Input Parameters: 23966083293cSBarry Smith . ctx - the monitor context 23976083293cSBarry Smith 23986083293cSBarry Smith Level: intermediate 23996083293cSBarry Smith 24006083293cSBarry Smith .keywords: TS, vector, monitor, view 24016083293cSBarry Smith 24026083293cSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorSolution() 24036083293cSBarry Smith @*/ 24046083293cSBarry Smith PetscErrorCode TSMonitorSolutionDestroy(void **ctx) 24056083293cSBarry Smith { 24066083293cSBarry Smith PetscErrorCode ierr; 24076083293cSBarry Smith TSMonitorSolutionCtx *ictx = *(TSMonitorSolutionCtx**)ctx; 24086083293cSBarry Smith 24096083293cSBarry Smith PetscFunctionBegin; 24106083293cSBarry Smith ierr = PetscViewerDestroy(&ictx->viewer);CHKERRQ(ierr); 24116083293cSBarry Smith ierr = VecDestroy(&ictx->initialsolution);CHKERRQ(ierr); 24126083293cSBarry Smith ierr = PetscFree(ictx);CHKERRQ(ierr); 24136083293cSBarry Smith PetscFunctionReturn(0); 24146083293cSBarry Smith } 24156083293cSBarry Smith 24166083293cSBarry Smith #undef __FUNCT__ 24176083293cSBarry Smith #define __FUNCT__ "TSMonitorSolutionCreate" 24186083293cSBarry Smith /*@C 24196083293cSBarry Smith TSMonitorSolutionCreate - Creates the monitor context for TSMonitorSolution 24206083293cSBarry Smith 24216083293cSBarry Smith Collective on TS 24226083293cSBarry Smith 24236083293cSBarry Smith Input Parameter: 24246083293cSBarry Smith . ts - time-step context 24256083293cSBarry Smith 24266083293cSBarry Smith Output Patameter: 24276083293cSBarry Smith . ctx - the monitor context 24286083293cSBarry Smith 24296083293cSBarry Smith Level: intermediate 24306083293cSBarry Smith 24316083293cSBarry Smith .keywords: TS, vector, monitor, view 24326083293cSBarry Smith 24336083293cSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorSolution() 24346083293cSBarry Smith @*/ 24356083293cSBarry Smith PetscErrorCode TSMonitorSolutionCreate(TS ts,PetscViewer viewer,void **ctx) 24366083293cSBarry Smith { 24376083293cSBarry Smith PetscErrorCode ierr; 24386083293cSBarry Smith TSMonitorSolutionCtx *ictx; 24396083293cSBarry Smith 24406083293cSBarry Smith PetscFunctionBegin; 24416083293cSBarry Smith ierr = PetscNew(TSMonitorSolutionCtx,&ictx);CHKERRQ(ierr); 24426083293cSBarry Smith *ctx = (void*)ictx; 24436083293cSBarry Smith if (!viewer) { 24446083293cSBarry Smith viewer = PETSC_VIEWER_DRAW_(((PetscObject)ts)->comm); 24456083293cSBarry Smith } 24466083293cSBarry Smith ierr = PetscObjectReference((PetscObject)viewer);CHKERRQ(ierr); 24476083293cSBarry Smith ictx->viewer = viewer; 24486083293cSBarry Smith ictx->showinitial = PETSC_FALSE; 24496083293cSBarry Smith ierr = PetscOptionsGetBool(((PetscObject)ts)->prefix,"-ts_monitor_solution_initial",&ictx->showinitial,PETSC_NULL);CHKERRQ(ierr); 24506083293cSBarry Smith PetscFunctionReturn(0); 24516083293cSBarry Smith } 24526083293cSBarry Smith 24536083293cSBarry Smith #undef __FUNCT__ 24546c699258SBarry Smith #define __FUNCT__ "TSSetDM" 24556c699258SBarry Smith /*@ 24566c699258SBarry Smith TSSetDM - Sets the DM that may be used by some preconditioners 24576c699258SBarry Smith 24583f9fe445SBarry Smith Logically Collective on TS and DM 24596c699258SBarry Smith 24606c699258SBarry Smith Input Parameters: 24616c699258SBarry Smith + ts - the preconditioner context 24626c699258SBarry Smith - dm - the dm 24636c699258SBarry Smith 24646c699258SBarry Smith Level: intermediate 24656c699258SBarry Smith 24666c699258SBarry Smith 24676c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM() 24686c699258SBarry Smith @*/ 24697087cfbeSBarry Smith PetscErrorCode TSSetDM(TS ts,DM dm) 24706c699258SBarry Smith { 24716c699258SBarry Smith PetscErrorCode ierr; 2472089b2837SJed Brown SNES snes; 24736c699258SBarry Smith 24746c699258SBarry Smith PetscFunctionBegin; 24750700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 247670663e4aSLisandro Dalcin ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr); 24776bf464f9SBarry Smith ierr = DMDestroy(&ts->dm);CHKERRQ(ierr); 24786c699258SBarry Smith ts->dm = dm; 2479089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2480089b2837SJed Brown ierr = SNESSetDM(snes,dm);CHKERRQ(ierr); 24816c699258SBarry Smith PetscFunctionReturn(0); 24826c699258SBarry Smith } 24836c699258SBarry Smith 24846c699258SBarry Smith #undef __FUNCT__ 24856c699258SBarry Smith #define __FUNCT__ "TSGetDM" 24866c699258SBarry Smith /*@ 24876c699258SBarry Smith TSGetDM - Gets the DM that may be used by some preconditioners 24886c699258SBarry Smith 24893f9fe445SBarry Smith Not Collective 24906c699258SBarry Smith 24916c699258SBarry Smith Input Parameter: 24926c699258SBarry Smith . ts - the preconditioner context 24936c699258SBarry Smith 24946c699258SBarry Smith Output Parameter: 24956c699258SBarry Smith . dm - the dm 24966c699258SBarry Smith 24976c699258SBarry Smith Level: intermediate 24986c699258SBarry Smith 24996c699258SBarry Smith 25006c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM() 25016c699258SBarry Smith @*/ 25027087cfbeSBarry Smith PetscErrorCode TSGetDM(TS ts,DM *dm) 25036c699258SBarry Smith { 25046c699258SBarry Smith PetscFunctionBegin; 25050700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 25066c699258SBarry Smith *dm = ts->dm; 25076c699258SBarry Smith PetscFunctionReturn(0); 25086c699258SBarry Smith } 25091713a123SBarry Smith 25100f5c6efeSJed Brown #undef __FUNCT__ 25110f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction" 25120f5c6efeSJed Brown /*@ 25130f5c6efeSJed Brown SNESTSFormFunction - Function to evaluate nonlinear residual 25140f5c6efeSJed Brown 25153f9fe445SBarry Smith Logically Collective on SNES 25160f5c6efeSJed Brown 25170f5c6efeSJed Brown Input Parameter: 2518d42a1c89SJed Brown + snes - nonlinear solver 25190f5c6efeSJed Brown . X - the current state at which to evaluate the residual 2520d42a1c89SJed Brown - ctx - user context, must be a TS 25210f5c6efeSJed Brown 25220f5c6efeSJed Brown Output Parameter: 25230f5c6efeSJed Brown . F - the nonlinear residual 25240f5c6efeSJed Brown 25250f5c6efeSJed Brown Notes: 25260f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 25270f5c6efeSJed Brown It is most frequently passed to MatFDColoringSetFunction(). 25280f5c6efeSJed Brown 25290f5c6efeSJed Brown Level: advanced 25300f5c6efeSJed Brown 25310f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction() 25320f5c6efeSJed Brown @*/ 25337087cfbeSBarry Smith PetscErrorCode SNESTSFormFunction(SNES snes,Vec X,Vec F,void *ctx) 25340f5c6efeSJed Brown { 25350f5c6efeSJed Brown TS ts = (TS)ctx; 25360f5c6efeSJed Brown PetscErrorCode ierr; 25370f5c6efeSJed Brown 25380f5c6efeSJed Brown PetscFunctionBegin; 25390f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 25400f5c6efeSJed Brown PetscValidHeaderSpecific(X,VEC_CLASSID,2); 25410f5c6efeSJed Brown PetscValidHeaderSpecific(F,VEC_CLASSID,3); 25420f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,4); 25430f5c6efeSJed Brown ierr = (ts->ops->snesfunction)(snes,X,F,ts);CHKERRQ(ierr); 25440f5c6efeSJed Brown PetscFunctionReturn(0); 25450f5c6efeSJed Brown } 25460f5c6efeSJed Brown 25470f5c6efeSJed Brown #undef __FUNCT__ 25480f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian" 25490f5c6efeSJed Brown /*@ 25500f5c6efeSJed Brown SNESTSFormJacobian - Function to evaluate the Jacobian 25510f5c6efeSJed Brown 25520f5c6efeSJed Brown Collective on SNES 25530f5c6efeSJed Brown 25540f5c6efeSJed Brown Input Parameter: 25550f5c6efeSJed Brown + snes - nonlinear solver 25560f5c6efeSJed Brown . X - the current state at which to evaluate the residual 25570f5c6efeSJed Brown - ctx - user context, must be a TS 25580f5c6efeSJed Brown 25590f5c6efeSJed Brown Output Parameter: 25600f5c6efeSJed Brown + A - the Jacobian 25610f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A) 25620f5c6efeSJed Brown - flag - indicates any structure change in the matrix 25630f5c6efeSJed Brown 25640f5c6efeSJed Brown Notes: 25650f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 25660f5c6efeSJed Brown 25670f5c6efeSJed Brown Level: developer 25680f5c6efeSJed Brown 25690f5c6efeSJed Brown .seealso: SNESSetJacobian() 25700f5c6efeSJed Brown @*/ 25717087cfbeSBarry Smith PetscErrorCode SNESTSFormJacobian(SNES snes,Vec X,Mat *A,Mat *B,MatStructure *flag,void *ctx) 25720f5c6efeSJed Brown { 25730f5c6efeSJed Brown TS ts = (TS)ctx; 25740f5c6efeSJed Brown PetscErrorCode ierr; 25750f5c6efeSJed Brown 25760f5c6efeSJed Brown PetscFunctionBegin; 25770f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 25780f5c6efeSJed Brown PetscValidHeaderSpecific(X,VEC_CLASSID,2); 25790f5c6efeSJed Brown PetscValidPointer(A,3); 25800f5c6efeSJed Brown PetscValidHeaderSpecific(*A,MAT_CLASSID,3); 25810f5c6efeSJed Brown PetscValidPointer(B,4); 25820f5c6efeSJed Brown PetscValidHeaderSpecific(*B,MAT_CLASSID,4); 25830f5c6efeSJed Brown PetscValidPointer(flag,5); 25840f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,6); 25850f5c6efeSJed Brown ierr = (ts->ops->snesjacobian)(snes,X,A,B,flag,ts);CHKERRQ(ierr); 25860f5c6efeSJed Brown PetscFunctionReturn(0); 25870f5c6efeSJed Brown } 2588325fc9f4SBarry Smith 25890e4ef248SJed Brown #undef __FUNCT__ 25900e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear" 25910e4ef248SJed Brown /*@C 25920e4ef248SJed Brown TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only 25930e4ef248SJed Brown 25940e4ef248SJed Brown Collective on TS 25950e4ef248SJed Brown 25960e4ef248SJed Brown Input Arguments: 25970e4ef248SJed Brown + ts - time stepping context 25980e4ef248SJed Brown . t - time at which to evaluate 25990e4ef248SJed Brown . X - state at which to evaluate 26000e4ef248SJed Brown - ctx - context 26010e4ef248SJed Brown 26020e4ef248SJed Brown Output Arguments: 26030e4ef248SJed Brown . F - right hand side 26040e4ef248SJed Brown 26050e4ef248SJed Brown Level: intermediate 26060e4ef248SJed Brown 26070e4ef248SJed Brown Notes: 26080e4ef248SJed Brown This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems. 26090e4ef248SJed Brown The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian(). 26100e4ef248SJed Brown 26110e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 26120e4ef248SJed Brown @*/ 26130e4ef248SJed Brown PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec X,Vec F,void *ctx) 26140e4ef248SJed Brown { 26150e4ef248SJed Brown PetscErrorCode ierr; 26160e4ef248SJed Brown Mat Arhs,Brhs; 26170e4ef248SJed Brown MatStructure flg2; 26180e4ef248SJed Brown 26190e4ef248SJed Brown PetscFunctionBegin; 26200e4ef248SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 26210e4ef248SJed Brown ierr = TSComputeRHSJacobian(ts,t,X,&Arhs,&Brhs,&flg2);CHKERRQ(ierr); 26220e4ef248SJed Brown ierr = MatMult(Arhs,X,F);CHKERRQ(ierr); 26230e4ef248SJed Brown PetscFunctionReturn(0); 26240e4ef248SJed Brown } 26250e4ef248SJed Brown 26260e4ef248SJed Brown #undef __FUNCT__ 26270e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant" 26280e4ef248SJed Brown /*@C 26290e4ef248SJed Brown TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 26300e4ef248SJed Brown 26310e4ef248SJed Brown Collective on TS 26320e4ef248SJed Brown 26330e4ef248SJed Brown Input Arguments: 26340e4ef248SJed Brown + ts - time stepping context 26350e4ef248SJed Brown . t - time at which to evaluate 26360e4ef248SJed Brown . X - state at which to evaluate 26370e4ef248SJed Brown - ctx - context 26380e4ef248SJed Brown 26390e4ef248SJed Brown Output Arguments: 26400e4ef248SJed Brown + A - pointer to operator 26410e4ef248SJed Brown . B - pointer to preconditioning matrix 26420e4ef248SJed Brown - flg - matrix structure flag 26430e4ef248SJed Brown 26440e4ef248SJed Brown Level: intermediate 26450e4ef248SJed Brown 26460e4ef248SJed Brown Notes: 26470e4ef248SJed Brown This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems. 26480e4ef248SJed Brown 26490e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear() 26500e4ef248SJed Brown @*/ 26510e4ef248SJed Brown PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec X,Mat *A,Mat *B,MatStructure *flg,void *ctx) 26520e4ef248SJed Brown { 26530e4ef248SJed Brown 26540e4ef248SJed Brown PetscFunctionBegin; 26550e4ef248SJed Brown *flg = SAME_PRECONDITIONER; 26560e4ef248SJed Brown PetscFunctionReturn(0); 26570e4ef248SJed Brown } 26580e4ef248SJed Brown 26590026cea9SSean Farley #undef __FUNCT__ 26600026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear" 26610026cea9SSean Farley /*@C 26620026cea9SSean Farley TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 26630026cea9SSean Farley 26640026cea9SSean Farley Collective on TS 26650026cea9SSean Farley 26660026cea9SSean Farley Input Arguments: 26670026cea9SSean Farley + ts - time stepping context 26680026cea9SSean Farley . t - time at which to evaluate 26690026cea9SSean Farley . X - state at which to evaluate 26700026cea9SSean Farley . Xdot - time derivative of state vector 26710026cea9SSean Farley - ctx - context 26720026cea9SSean Farley 26730026cea9SSean Farley Output Arguments: 26740026cea9SSean Farley . F - left hand side 26750026cea9SSean Farley 26760026cea9SSean Farley Level: intermediate 26770026cea9SSean Farley 26780026cea9SSean Farley Notes: 26790026cea9SSean 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 26800026cea9SSean Farley user is required to write their own TSComputeIFunction. 26810026cea9SSean Farley This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems. 26820026cea9SSean Farley The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian(). 26830026cea9SSean Farley 26840026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant() 26850026cea9SSean Farley @*/ 26860026cea9SSean Farley PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec X,Vec Xdot,Vec F,void *ctx) 26870026cea9SSean Farley { 26880026cea9SSean Farley PetscErrorCode ierr; 26890026cea9SSean Farley Mat A,B; 26900026cea9SSean Farley MatStructure flg2; 26910026cea9SSean Farley 26920026cea9SSean Farley PetscFunctionBegin; 26930026cea9SSean Farley ierr = TSGetIJacobian(ts,&A,&B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 26940026cea9SSean Farley ierr = TSComputeIJacobian(ts,t,X,Xdot,1.0,&A,&B,&flg2,PETSC_TRUE);CHKERRQ(ierr); 26950026cea9SSean Farley ierr = MatMult(A,Xdot,F);CHKERRQ(ierr); 26960026cea9SSean Farley PetscFunctionReturn(0); 26970026cea9SSean Farley } 26980026cea9SSean Farley 26990026cea9SSean Farley #undef __FUNCT__ 27000026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant" 27010026cea9SSean Farley /*@C 270224e94211SJed Brown TSComputeIJacobianConstant - Reuses a Jacobian that is time-independent. 27030026cea9SSean Farley 27040026cea9SSean Farley Collective on TS 27050026cea9SSean Farley 27060026cea9SSean Farley Input Arguments: 27070026cea9SSean Farley + ts - time stepping context 27080026cea9SSean Farley . t - time at which to evaluate 27090026cea9SSean Farley . X - state at which to evaluate 27100026cea9SSean Farley . Xdot - time derivative of state vector 27110026cea9SSean Farley . shift - shift to apply 27120026cea9SSean Farley - ctx - context 27130026cea9SSean Farley 27140026cea9SSean Farley Output Arguments: 27150026cea9SSean Farley + A - pointer to operator 27160026cea9SSean Farley . B - pointer to preconditioning matrix 27170026cea9SSean Farley - flg - matrix structure flag 27180026cea9SSean Farley 27190026cea9SSean Farley Level: intermediate 27200026cea9SSean Farley 27210026cea9SSean Farley Notes: 27220026cea9SSean Farley This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems. 27230026cea9SSean Farley 27240026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear() 27250026cea9SSean Farley @*/ 27260026cea9SSean Farley PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec X,Vec Xdot,PetscReal shift,Mat *A,Mat *B,MatStructure *flg,void *ctx) 27270026cea9SSean Farley { 27280026cea9SSean Farley 27290026cea9SSean Farley PetscFunctionBegin; 27300026cea9SSean Farley *flg = SAME_PRECONDITIONER; 27310026cea9SSean Farley PetscFunctionReturn(0); 27320026cea9SSean Farley } 27330026cea9SSean Farley 27344af1b03aSJed Brown 27354af1b03aSJed Brown #undef __FUNCT__ 27364af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason" 27374af1b03aSJed Brown /*@ 27384af1b03aSJed Brown TSGetConvergedReason - Gets the reason the TS iteration was stopped. 27394af1b03aSJed Brown 27404af1b03aSJed Brown Not Collective 27414af1b03aSJed Brown 27424af1b03aSJed Brown Input Parameter: 27434af1b03aSJed Brown . ts - the TS context 27444af1b03aSJed Brown 27454af1b03aSJed Brown Output Parameter: 27464af1b03aSJed Brown . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 27474af1b03aSJed Brown manual pages for the individual convergence tests for complete lists 27484af1b03aSJed Brown 27494af1b03aSJed Brown Level: intermediate 27504af1b03aSJed Brown 2751cd652676SJed Brown Notes: 2752cd652676SJed Brown Can only be called after the call to TSSolve() is complete. 27534af1b03aSJed Brown 27544af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test 27554af1b03aSJed Brown 27564af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason 27574af1b03aSJed Brown @*/ 27584af1b03aSJed Brown PetscErrorCode TSGetConvergedReason(TS ts,TSConvergedReason *reason) 27594af1b03aSJed Brown { 27604af1b03aSJed Brown PetscFunctionBegin; 27614af1b03aSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 27624af1b03aSJed Brown PetscValidPointer(reason,2); 27634af1b03aSJed Brown *reason = ts->reason; 27644af1b03aSJed Brown PetscFunctionReturn(0); 27654af1b03aSJed Brown } 27664af1b03aSJed Brown 2767fb1732b5SBarry Smith #undef __FUNCT__ 27689f67acb7SJed Brown #define __FUNCT__ "TSGetNonlinearSolveIterations" 27699f67acb7SJed Brown /*@ 277001c7e25bSJed Brown TSGetNonlinearSolveIterations - Gets the total number of linear iterations 27719f67acb7SJed Brown used by the time integrator. 27729f67acb7SJed Brown 27739f67acb7SJed Brown Not Collective 27749f67acb7SJed Brown 27759f67acb7SJed Brown Input Parameter: 27769f67acb7SJed Brown . ts - TS context 27779f67acb7SJed Brown 27789f67acb7SJed Brown Output Parameter: 27799f67acb7SJed Brown . nits - number of nonlinear iterations 27809f67acb7SJed Brown 27819f67acb7SJed Brown Notes: 27829f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 27839f67acb7SJed Brown 27849f67acb7SJed Brown Level: intermediate 27859f67acb7SJed Brown 27869f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations 27879f67acb7SJed Brown 27889f67acb7SJed Brown .seealso: TSGetLinearSolveIterations() 27899f67acb7SJed Brown @*/ 27909f67acb7SJed Brown PetscErrorCode TSGetNonlinearSolveIterations(TS ts,PetscInt *nits) 27919f67acb7SJed Brown { 27929f67acb7SJed Brown PetscFunctionBegin; 27939f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 27949f67acb7SJed Brown PetscValidIntPointer(nits,2); 27959f67acb7SJed Brown *nits = ts->nonlinear_its; 27969f67acb7SJed Brown PetscFunctionReturn(0); 27979f67acb7SJed Brown } 27989f67acb7SJed Brown 27999f67acb7SJed Brown #undef __FUNCT__ 28009f67acb7SJed Brown #define __FUNCT__ "TSGetLinearSolveIterations" 28019f67acb7SJed Brown /*@ 28029f67acb7SJed Brown TSGetLinearSolveIterations - Gets the total number of linear iterations 28039f67acb7SJed Brown used by the time integrator. 28049f67acb7SJed Brown 28059f67acb7SJed Brown Not Collective 28069f67acb7SJed Brown 28079f67acb7SJed Brown Input Parameter: 28089f67acb7SJed Brown . ts - TS context 28099f67acb7SJed Brown 28109f67acb7SJed Brown Output Parameter: 28119f67acb7SJed Brown . lits - number of linear iterations 28129f67acb7SJed Brown 28139f67acb7SJed Brown Notes: 28149f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 28159f67acb7SJed Brown 28169f67acb7SJed Brown Level: intermediate 28179f67acb7SJed Brown 28189f67acb7SJed Brown .keywords: TS, get, number, linear, iterations 28199f67acb7SJed Brown 28209f67acb7SJed Brown .seealso: TSGetNonlinearSolveIterations(), SNESGetLinearSolveIterations() 28219f67acb7SJed Brown @*/ 28229f67acb7SJed Brown PetscErrorCode TSGetLinearSolveIterations(TS ts,PetscInt *lits) 28239f67acb7SJed Brown { 28249f67acb7SJed Brown PetscFunctionBegin; 28259f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 28269f67acb7SJed Brown PetscValidIntPointer(lits,2); 28279f67acb7SJed Brown *lits = ts->linear_its; 28289f67acb7SJed Brown PetscFunctionReturn(0); 28299f67acb7SJed Brown } 28309f67acb7SJed Brown 28319f67acb7SJed Brown #undef __FUNCT__ 2832fb1732b5SBarry Smith #define __FUNCT__ "TSMonitorSolutionBinary" 2833fb1732b5SBarry Smith /*@C 2834fb1732b5SBarry Smith TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file 2835fb1732b5SBarry Smith 2836fb1732b5SBarry Smith Collective on TS 2837fb1732b5SBarry Smith 2838fb1732b5SBarry Smith Input Parameters: 2839fb1732b5SBarry Smith + ts - the TS context 2840fb1732b5SBarry Smith . step - current time-step 2841fb1732b5SBarry Smith . ptime - current time 2842ed81e22dSJed Brown . x - current state 2843fb1732b5SBarry Smith - viewer - binary viewer 2844fb1732b5SBarry Smith 2845fb1732b5SBarry Smith Level: intermediate 2846fb1732b5SBarry Smith 2847fb1732b5SBarry Smith .keywords: TS, vector, monitor, view 2848fb1732b5SBarry Smith 2849fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 2850fb1732b5SBarry Smith @*/ 2851ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec x,void *viewer) 2852fb1732b5SBarry Smith { 2853fb1732b5SBarry Smith PetscErrorCode ierr; 2854ed81e22dSJed Brown PetscViewer v = (PetscViewer)viewer; 2855fb1732b5SBarry Smith 2856fb1732b5SBarry Smith PetscFunctionBegin; 2857ed81e22dSJed Brown ierr = VecView(x,v);CHKERRQ(ierr); 2858ed81e22dSJed Brown PetscFunctionReturn(0); 2859ed81e22dSJed Brown } 2860ed81e22dSJed Brown 2861ed81e22dSJed Brown #undef __FUNCT__ 2862ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK" 2863ed81e22dSJed Brown /*@C 2864ed81e22dSJed Brown TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep. 2865ed81e22dSJed Brown 2866ed81e22dSJed Brown Collective on TS 2867ed81e22dSJed Brown 2868ed81e22dSJed Brown Input Parameters: 2869ed81e22dSJed Brown + ts - the TS context 2870ed81e22dSJed Brown . step - current time-step 2871ed81e22dSJed Brown . ptime - current time 2872ed81e22dSJed Brown . x - current state 2873ed81e22dSJed Brown - filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 2874ed81e22dSJed Brown 2875ed81e22dSJed Brown Level: intermediate 2876ed81e22dSJed Brown 2877ed81e22dSJed Brown Notes: 2878ed81e22dSJed Brown The VTK format does not allow writing multiple time steps in the same file, therefore a different file will be written for each time step. 2879ed81e22dSJed Brown These are named according to the file name template. 2880ed81e22dSJed Brown 2881ed81e22dSJed Brown This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy(). 2882ed81e22dSJed Brown 2883ed81e22dSJed Brown .keywords: TS, vector, monitor, view 2884ed81e22dSJed Brown 2885ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 2886ed81e22dSJed Brown @*/ 2887ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec x,void *filenametemplate) 2888ed81e22dSJed Brown { 2889ed81e22dSJed Brown PetscErrorCode ierr; 2890ed81e22dSJed Brown char filename[PETSC_MAX_PATH_LEN]; 2891ed81e22dSJed Brown PetscViewer viewer; 2892ed81e22dSJed Brown 2893ed81e22dSJed Brown PetscFunctionBegin; 2894ed81e22dSJed Brown ierr = PetscSNPrintf(filename,sizeof filename,(const char*)filenametemplate,step);CHKERRQ(ierr); 2895ed81e22dSJed Brown ierr = PetscViewerVTKOpen(((PetscObject)ts)->comm,filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr); 2896fb1732b5SBarry Smith ierr = VecView(x,viewer);CHKERRQ(ierr); 2897ed81e22dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 2898ed81e22dSJed Brown PetscFunctionReturn(0); 2899ed81e22dSJed Brown } 2900ed81e22dSJed Brown 2901ed81e22dSJed Brown #undef __FUNCT__ 2902ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy" 2903ed81e22dSJed Brown /*@C 2904ed81e22dSJed Brown TSMonitorSolutionVTKDestroy - Destroy context for monitoring 2905ed81e22dSJed Brown 2906ed81e22dSJed Brown Collective on TS 2907ed81e22dSJed Brown 2908ed81e22dSJed Brown Input Parameters: 2909ed81e22dSJed Brown . filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 2910ed81e22dSJed Brown 2911ed81e22dSJed Brown Level: intermediate 2912ed81e22dSJed Brown 2913ed81e22dSJed Brown Note: 2914ed81e22dSJed Brown This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK(). 2915ed81e22dSJed Brown 2916ed81e22dSJed Brown .keywords: TS, vector, monitor, view 2917ed81e22dSJed Brown 2918ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK() 2919ed81e22dSJed Brown @*/ 2920ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate) 2921ed81e22dSJed Brown { 2922ed81e22dSJed Brown PetscErrorCode ierr; 2923ed81e22dSJed Brown 2924ed81e22dSJed Brown PetscFunctionBegin; 2925ed81e22dSJed Brown ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr); 2926fb1732b5SBarry Smith PetscFunctionReturn(0); 2927fb1732b5SBarry Smith } 2928fb1732b5SBarry Smith 292984df9cb4SJed Brown #undef __FUNCT__ 293084df9cb4SJed Brown #define __FUNCT__ "TSGetAdapt" 293184df9cb4SJed Brown /*@ 293284df9cb4SJed Brown TSGetAdapt - Get the adaptive controller context for the current method 293384df9cb4SJed Brown 2934ed81e22dSJed Brown Collective on TS if controller has not been created yet 293584df9cb4SJed Brown 293684df9cb4SJed Brown Input Arguments: 2937ed81e22dSJed Brown . ts - time stepping context 293884df9cb4SJed Brown 293984df9cb4SJed Brown Output Arguments: 2940ed81e22dSJed Brown . adapt - adaptive controller 294184df9cb4SJed Brown 294284df9cb4SJed Brown Level: intermediate 294384df9cb4SJed Brown 2944ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose() 294584df9cb4SJed Brown @*/ 294684df9cb4SJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt) 294784df9cb4SJed Brown { 294884df9cb4SJed Brown PetscErrorCode ierr; 294984df9cb4SJed Brown 295084df9cb4SJed Brown PetscFunctionBegin; 295184df9cb4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 295284df9cb4SJed Brown PetscValidPointer(adapt,2); 295384df9cb4SJed Brown if (!ts->adapt) { 295484df9cb4SJed Brown ierr = TSAdaptCreate(((PetscObject)ts)->comm,&ts->adapt);CHKERRQ(ierr); 29551c3436cfSJed Brown ierr = PetscLogObjectParent(ts,ts->adapt);CHKERRQ(ierr); 29561c3436cfSJed Brown ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr); 295784df9cb4SJed Brown } 295884df9cb4SJed Brown *adapt = ts->adapt; 295984df9cb4SJed Brown PetscFunctionReturn(0); 296084df9cb4SJed Brown } 2961d6ebe24aSShri Abhyankar 2962d6ebe24aSShri Abhyankar #undef __FUNCT__ 29631c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances" 29641c3436cfSJed Brown /*@ 29651c3436cfSJed Brown TSSetTolerances - Set tolerances for local truncation error when using adaptive controller 29661c3436cfSJed Brown 29671c3436cfSJed Brown Logically Collective 29681c3436cfSJed Brown 29691c3436cfSJed Brown Input Arguments: 29701c3436cfSJed Brown + ts - time integration context 29711c3436cfSJed Brown . atol - scalar absolute tolerances, PETSC_DECIDE to leave current value 29721c3436cfSJed Brown . vatol - vector of absolute tolerances or PETSC_NULL, used in preference to atol if present 29731c3436cfSJed Brown . rtol - scalar relative tolerances, PETSC_DECIDE to leave current value 29741c3436cfSJed Brown - vrtol - vector of relative tolerances or PETSC_NULL, used in preference to atol if present 29751c3436cfSJed Brown 29761c3436cfSJed Brown Level: beginner 29771c3436cfSJed Brown 29781c3436cfSJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS() 29791c3436cfSJed Brown @*/ 29801c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol) 29811c3436cfSJed Brown { 29821c3436cfSJed Brown PetscErrorCode ierr; 29831c3436cfSJed Brown 29841c3436cfSJed Brown PetscFunctionBegin; 29851c3436cfSJed Brown if (atol != PETSC_DECIDE) ts->atol = atol; 29861c3436cfSJed Brown if (vatol) { 29871c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr); 29881c3436cfSJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 29891c3436cfSJed Brown ts->vatol = vatol; 29901c3436cfSJed Brown } 29911c3436cfSJed Brown if (rtol != PETSC_DECIDE) ts->rtol = rtol; 29921c3436cfSJed Brown if (vrtol) { 29931c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr); 29941c3436cfSJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 29951c3436cfSJed Brown ts->vrtol = vrtol; 29961c3436cfSJed Brown } 29971c3436cfSJed Brown PetscFunctionReturn(0); 29981c3436cfSJed Brown } 29991c3436cfSJed Brown 30001c3436cfSJed Brown #undef __FUNCT__ 30011c3436cfSJed Brown #define __FUNCT__ "TSErrorNormWRMS" 30021c3436cfSJed Brown /*@ 30031c3436cfSJed Brown TSErrorNormWRMS - compute a weighted norm of the difference between a vector and the current state 30041c3436cfSJed Brown 30051c3436cfSJed Brown Collective on TS 30061c3436cfSJed Brown 30071c3436cfSJed Brown Input Arguments: 30081c3436cfSJed Brown + ts - time stepping context 30091c3436cfSJed Brown - Y - state vector to be compared to ts->vec_sol 30101c3436cfSJed Brown 30111c3436cfSJed Brown Output Arguments: 30121c3436cfSJed Brown . norm - weighted norm, a value of 1.0 is considered small 30131c3436cfSJed Brown 30141c3436cfSJed Brown Level: developer 30151c3436cfSJed Brown 30161c3436cfSJed Brown .seealso: TSSetTolerances() 30171c3436cfSJed Brown @*/ 30181c3436cfSJed Brown PetscErrorCode TSErrorNormWRMS(TS ts,Vec Y,PetscReal *norm) 30191c3436cfSJed Brown { 30201c3436cfSJed Brown PetscErrorCode ierr; 30211c3436cfSJed Brown PetscInt i,n,N; 30221c3436cfSJed Brown const PetscScalar *x,*y; 30231c3436cfSJed Brown Vec X; 30241c3436cfSJed Brown PetscReal sum,gsum; 30251c3436cfSJed Brown 30261c3436cfSJed Brown PetscFunctionBegin; 30271c3436cfSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 30281c3436cfSJed Brown PetscValidHeaderSpecific(Y,VEC_CLASSID,2); 30291c3436cfSJed Brown PetscValidPointer(norm,3); 30301c3436cfSJed Brown X = ts->vec_sol; 30311c3436cfSJed Brown PetscCheckSameTypeAndComm(X,1,Y,2); 30321c3436cfSJed Brown if (X == Y) SETERRQ(((PetscObject)X)->comm,PETSC_ERR_ARG_IDN,"Y cannot be the TS solution vector"); 30331c3436cfSJed Brown 30341c3436cfSJed Brown /* This is simple to implement, just not done yet */ 30351c3436cfSJed Brown if (ts->vatol || ts->vrtol) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_SUP,"No support for vector scaling yet"); 30361c3436cfSJed Brown 30371c3436cfSJed Brown ierr = VecGetSize(X,&N);CHKERRQ(ierr); 30381c3436cfSJed Brown ierr = VecGetLocalSize(X,&n);CHKERRQ(ierr); 30391c3436cfSJed Brown ierr = VecGetArrayRead(X,&x);CHKERRQ(ierr); 30401c3436cfSJed Brown ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 30411c3436cfSJed Brown sum = 0.; 30421c3436cfSJed Brown for (i=0; i<n; i++) { 30431c3436cfSJed Brown PetscReal tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(x[i]),PetscAbsScalar(y[i])); 30441c3436cfSJed Brown sum += PetscSqr(PetscAbsScalar(y[i] - x[i]) / tol); 30451c3436cfSJed Brown } 30461c3436cfSJed Brown ierr = VecRestoreArrayRead(X,&x);CHKERRQ(ierr); 30471c3436cfSJed Brown ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 30481c3436cfSJed Brown 30491c3436cfSJed Brown ierr = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,((PetscObject)ts)->comm);CHKERRQ(ierr); 30501c3436cfSJed Brown *norm = PetscSqrtReal(gsum / N); 30511c3436cfSJed Brown if (PetscIsInfOrNanScalar(*norm)) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 30521c3436cfSJed Brown PetscFunctionReturn(0); 30531c3436cfSJed Brown } 30541c3436cfSJed Brown 30551c3436cfSJed Brown #undef __FUNCT__ 30568d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal" 30578d59e960SJed Brown /*@ 30588d59e960SJed Brown TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler 30598d59e960SJed Brown 30608d59e960SJed Brown Logically Collective on TS 30618d59e960SJed Brown 30628d59e960SJed Brown Input Arguments: 30638d59e960SJed Brown + ts - time stepping context 30648d59e960SJed Brown - cfltime - maximum stable time step if using forward Euler (value can be different on each process) 30658d59e960SJed Brown 30668d59e960SJed Brown Note: 30678d59e960SJed Brown After calling this function, the global CFL time can be obtained by calling TSGetCFLTime() 30688d59e960SJed Brown 30698d59e960SJed Brown Level: intermediate 30708d59e960SJed Brown 30718d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL 30728d59e960SJed Brown @*/ 30738d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime) 30748d59e960SJed Brown { 30758d59e960SJed Brown 30768d59e960SJed Brown PetscFunctionBegin; 30778d59e960SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 30788d59e960SJed Brown ts->cfltime_local = cfltime; 30798d59e960SJed Brown ts->cfltime = -1.; 30808d59e960SJed Brown PetscFunctionReturn(0); 30818d59e960SJed Brown } 30828d59e960SJed Brown 30838d59e960SJed Brown #undef __FUNCT__ 30848d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime" 30858d59e960SJed Brown /*@ 30868d59e960SJed Brown TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler 30878d59e960SJed Brown 30888d59e960SJed Brown Collective on TS 30898d59e960SJed Brown 30908d59e960SJed Brown Input Arguments: 30918d59e960SJed Brown . ts - time stepping context 30928d59e960SJed Brown 30938d59e960SJed Brown Output Arguments: 30948d59e960SJed Brown . cfltime - maximum stable time step for forward Euler 30958d59e960SJed Brown 30968d59e960SJed Brown Level: advanced 30978d59e960SJed Brown 30988d59e960SJed Brown .seealso: TSSetCFLTimeLocal() 30998d59e960SJed Brown @*/ 31008d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime) 31018d59e960SJed Brown { 31028d59e960SJed Brown PetscErrorCode ierr; 31038d59e960SJed Brown 31048d59e960SJed Brown PetscFunctionBegin; 31058d59e960SJed Brown if (ts->cfltime < 0) { 31068d59e960SJed Brown ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,((PetscObject)ts)->comm);CHKERRQ(ierr); 31078d59e960SJed Brown } 31088d59e960SJed Brown *cfltime = ts->cfltime; 31098d59e960SJed Brown PetscFunctionReturn(0); 31108d59e960SJed Brown } 31118d59e960SJed Brown 31128d59e960SJed Brown #undef __FUNCT__ 3113d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds" 3114d6ebe24aSShri Abhyankar /*@ 3115d6ebe24aSShri Abhyankar TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu 3116d6ebe24aSShri Abhyankar 3117d6ebe24aSShri Abhyankar Input Parameters: 3118d6ebe24aSShri Abhyankar . ts - the TS context. 3119d6ebe24aSShri Abhyankar . xl - lower bound. 3120d6ebe24aSShri Abhyankar . xu - upper bound. 3121d6ebe24aSShri Abhyankar 3122d6ebe24aSShri Abhyankar Notes: 3123d6ebe24aSShri Abhyankar If this routine is not called then the lower and upper bounds are set to 3124d6ebe24aSShri Abhyankar SNES_VI_INF and SNES_VI_NINF respectively during SNESSetUp(). 3125d6ebe24aSShri Abhyankar 31262bd2b0e6SSatish Balay Level: advanced 31272bd2b0e6SSatish Balay 3128d6ebe24aSShri Abhyankar @*/ 3129d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu) 3130d6ebe24aSShri Abhyankar { 3131d6ebe24aSShri Abhyankar PetscErrorCode ierr; 3132d6ebe24aSShri Abhyankar SNES snes; 3133d6ebe24aSShri Abhyankar 3134d6ebe24aSShri Abhyankar PetscFunctionBegin; 3135d6ebe24aSShri Abhyankar ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3136d6ebe24aSShri Abhyankar ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr); 3137d6ebe24aSShri Abhyankar PetscFunctionReturn(0); 3138d6ebe24aSShri Abhyankar } 3139d6ebe24aSShri Abhyankar 3140325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 3141c6db04a5SJed Brown #include <mex.h> 3142325fc9f4SBarry Smith 3143325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext; 3144325fc9f4SBarry Smith 3145325fc9f4SBarry Smith #undef __FUNCT__ 3146325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab" 3147325fc9f4SBarry Smith /* 3148325fc9f4SBarry Smith TSComputeFunction_Matlab - Calls the function that has been set with 3149325fc9f4SBarry Smith TSSetFunctionMatlab(). 3150325fc9f4SBarry Smith 3151325fc9f4SBarry Smith Collective on TS 3152325fc9f4SBarry Smith 3153325fc9f4SBarry Smith Input Parameters: 3154325fc9f4SBarry Smith + snes - the TS context 3155325fc9f4SBarry Smith - x - input vector 3156325fc9f4SBarry Smith 3157325fc9f4SBarry Smith Output Parameter: 3158325fc9f4SBarry Smith . y - function vector, as set by TSSetFunction() 3159325fc9f4SBarry Smith 3160325fc9f4SBarry Smith Notes: 3161325fc9f4SBarry Smith TSComputeFunction() is typically used within nonlinear solvers 3162325fc9f4SBarry Smith implementations, so most users would not generally call this routine 3163325fc9f4SBarry Smith themselves. 3164325fc9f4SBarry Smith 3165325fc9f4SBarry Smith Level: developer 3166325fc9f4SBarry Smith 3167325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 3168325fc9f4SBarry Smith 3169325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 3170325fc9f4SBarry Smith */ 31717087cfbeSBarry Smith PetscErrorCode TSComputeFunction_Matlab(TS snes,PetscReal time,Vec x,Vec xdot,Vec y, void *ctx) 3172325fc9f4SBarry Smith { 3173325fc9f4SBarry Smith PetscErrorCode ierr; 3174325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext *)ctx; 3175325fc9f4SBarry Smith int nlhs = 1,nrhs = 7; 3176325fc9f4SBarry Smith mxArray *plhs[1],*prhs[7]; 3177325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,ly = 0,ls = 0; 3178325fc9f4SBarry Smith 3179325fc9f4SBarry Smith PetscFunctionBegin; 3180325fc9f4SBarry Smith PetscValidHeaderSpecific(snes,TS_CLASSID,1); 3181325fc9f4SBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,3); 3182325fc9f4SBarry Smith PetscValidHeaderSpecific(xdot,VEC_CLASSID,4); 3183325fc9f4SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,5); 3184325fc9f4SBarry Smith PetscCheckSameComm(snes,1,x,3); 3185325fc9f4SBarry Smith PetscCheckSameComm(snes,1,y,5); 3186325fc9f4SBarry Smith 3187325fc9f4SBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 3188325fc9f4SBarry Smith ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr); 3189880f3077SBarry Smith ierr = PetscMemcpy(&lxdot,&xdot,sizeof(xdot));CHKERRQ(ierr); 3190325fc9f4SBarry Smith ierr = PetscMemcpy(&ly,&y,sizeof(x));CHKERRQ(ierr); 3191325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 3192325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar(time); 3193325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 3194325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 3195325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)ly); 3196325fc9f4SBarry Smith prhs[5] = mxCreateString(sctx->funcname); 3197325fc9f4SBarry Smith prhs[6] = sctx->ctx; 3198325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr); 3199325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 3200325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 3201325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 3202325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 3203325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 3204325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 3205325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 3206325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 3207325fc9f4SBarry Smith PetscFunctionReturn(0); 3208325fc9f4SBarry Smith } 3209325fc9f4SBarry Smith 3210325fc9f4SBarry Smith 3211325fc9f4SBarry Smith #undef __FUNCT__ 3212325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab" 3213325fc9f4SBarry Smith /* 3214325fc9f4SBarry Smith TSSetFunctionMatlab - Sets the function evaluation routine and function 3215325fc9f4SBarry Smith vector for use by the TS routines in solving ODEs 3216e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 3217325fc9f4SBarry Smith 3218325fc9f4SBarry Smith Logically Collective on TS 3219325fc9f4SBarry Smith 3220325fc9f4SBarry Smith Input Parameters: 3221325fc9f4SBarry Smith + ts - the TS context 3222325fc9f4SBarry Smith - func - function evaluation routine 3223325fc9f4SBarry Smith 3224325fc9f4SBarry Smith Calling sequence of func: 3225325fc9f4SBarry Smith $ func (TS ts,PetscReal time,Vec x,Vec xdot,Vec f,void *ctx); 3226325fc9f4SBarry Smith 3227325fc9f4SBarry Smith Level: beginner 3228325fc9f4SBarry Smith 3229325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 3230325fc9f4SBarry Smith 3231325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 3232325fc9f4SBarry Smith */ 3233cdcf91faSSean Farley PetscErrorCode TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx) 3234325fc9f4SBarry Smith { 3235325fc9f4SBarry Smith PetscErrorCode ierr; 3236325fc9f4SBarry Smith TSMatlabContext *sctx; 3237325fc9f4SBarry Smith 3238325fc9f4SBarry Smith PetscFunctionBegin; 3239325fc9f4SBarry Smith /* currently sctx is memory bleed */ 3240325fc9f4SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 3241325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 3242325fc9f4SBarry Smith /* 3243325fc9f4SBarry Smith This should work, but it doesn't 3244325fc9f4SBarry Smith sctx->ctx = ctx; 3245325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 3246325fc9f4SBarry Smith */ 3247325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 3248cdcf91faSSean Farley ierr = TSSetIFunction(ts,PETSC_NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr); 3249325fc9f4SBarry Smith PetscFunctionReturn(0); 3250325fc9f4SBarry Smith } 3251325fc9f4SBarry Smith 3252325fc9f4SBarry Smith #undef __FUNCT__ 3253325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab" 3254325fc9f4SBarry Smith /* 3255325fc9f4SBarry Smith TSComputeJacobian_Matlab - Calls the function that has been set with 3256325fc9f4SBarry Smith TSSetJacobianMatlab(). 3257325fc9f4SBarry Smith 3258325fc9f4SBarry Smith Collective on TS 3259325fc9f4SBarry Smith 3260325fc9f4SBarry Smith Input Parameters: 3261cdcf91faSSean Farley + ts - the TS context 3262325fc9f4SBarry Smith . x - input vector 3263325fc9f4SBarry Smith . A, B - the matrices 3264325fc9f4SBarry Smith - ctx - user context 3265325fc9f4SBarry Smith 3266325fc9f4SBarry Smith Output Parameter: 3267325fc9f4SBarry Smith . flag - structure of the matrix 3268325fc9f4SBarry Smith 3269325fc9f4SBarry Smith Level: developer 3270325fc9f4SBarry Smith 3271325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 3272325fc9f4SBarry Smith 3273325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 3274325fc9f4SBarry Smith @*/ 3275cdcf91faSSean Farley PetscErrorCode TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec x,Vec xdot,PetscReal shift,Mat *A,Mat *B,MatStructure *flag, void *ctx) 3276325fc9f4SBarry Smith { 3277325fc9f4SBarry Smith PetscErrorCode ierr; 3278325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext *)ctx; 3279325fc9f4SBarry Smith int nlhs = 2,nrhs = 9; 3280325fc9f4SBarry Smith mxArray *plhs[2],*prhs[9]; 3281325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0; 3282325fc9f4SBarry Smith 3283325fc9f4SBarry Smith PetscFunctionBegin; 3284cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3285325fc9f4SBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,3); 3286325fc9f4SBarry Smith 3287325fc9f4SBarry Smith /* call Matlab function in ctx with arguments x and y */ 3288325fc9f4SBarry Smith 3289cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 3290325fc9f4SBarry Smith ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr); 3291325fc9f4SBarry Smith ierr = PetscMemcpy(&lxdot,&xdot,sizeof(x));CHKERRQ(ierr); 3292325fc9f4SBarry Smith ierr = PetscMemcpy(&lA,A,sizeof(x));CHKERRQ(ierr); 3293325fc9f4SBarry Smith ierr = PetscMemcpy(&lB,B,sizeof(x));CHKERRQ(ierr); 3294325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 3295325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar((double)time); 3296325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 3297325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 3298325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)shift); 3299325fc9f4SBarry Smith prhs[5] = mxCreateDoubleScalar((double)lA); 3300325fc9f4SBarry Smith prhs[6] = mxCreateDoubleScalar((double)lB); 3301325fc9f4SBarry Smith prhs[7] = mxCreateString(sctx->funcname); 3302325fc9f4SBarry Smith prhs[8] = sctx->ctx; 3303325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr); 3304325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 3305325fc9f4SBarry Smith *flag = (MatStructure) mxGetScalar(plhs[1]);CHKERRQ(ierr); 3306325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 3307325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 3308325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 3309325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 3310325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 3311325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 3312325fc9f4SBarry Smith mxDestroyArray(prhs[6]); 3313325fc9f4SBarry Smith mxDestroyArray(prhs[7]); 3314325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 3315325fc9f4SBarry Smith mxDestroyArray(plhs[1]); 3316325fc9f4SBarry Smith PetscFunctionReturn(0); 3317325fc9f4SBarry Smith } 3318325fc9f4SBarry Smith 3319325fc9f4SBarry Smith 3320325fc9f4SBarry Smith #undef __FUNCT__ 3321325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab" 3322325fc9f4SBarry Smith /* 3323325fc9f4SBarry Smith TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 3324e3c5b3baSBarry 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 3325325fc9f4SBarry Smith 3326325fc9f4SBarry Smith Logically Collective on TS 3327325fc9f4SBarry Smith 3328325fc9f4SBarry Smith Input Parameters: 3329cdcf91faSSean Farley + ts - the TS context 3330325fc9f4SBarry Smith . A,B - Jacobian matrices 3331325fc9f4SBarry Smith . func - function evaluation routine 3332325fc9f4SBarry Smith - ctx - user context 3333325fc9f4SBarry Smith 3334325fc9f4SBarry Smith Calling sequence of func: 3335cdcf91faSSean Farley $ flag = func (TS ts,PetscReal time,Vec x,Vec xdot,Mat A,Mat B,void *ctx); 3336325fc9f4SBarry Smith 3337325fc9f4SBarry Smith 3338325fc9f4SBarry Smith Level: developer 3339325fc9f4SBarry Smith 3340325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 3341325fc9f4SBarry Smith 3342325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 3343325fc9f4SBarry Smith */ 3344cdcf91faSSean Farley PetscErrorCode TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx) 3345325fc9f4SBarry Smith { 3346325fc9f4SBarry Smith PetscErrorCode ierr; 3347325fc9f4SBarry Smith TSMatlabContext *sctx; 3348325fc9f4SBarry Smith 3349325fc9f4SBarry Smith PetscFunctionBegin; 3350325fc9f4SBarry Smith /* currently sctx is memory bleed */ 3351325fc9f4SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 3352325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 3353325fc9f4SBarry Smith /* 3354325fc9f4SBarry Smith This should work, but it doesn't 3355325fc9f4SBarry Smith sctx->ctx = ctx; 3356325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 3357325fc9f4SBarry Smith */ 3358325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 3359cdcf91faSSean Farley ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 3360325fc9f4SBarry Smith PetscFunctionReturn(0); 3361325fc9f4SBarry Smith } 3362325fc9f4SBarry Smith 3363b5b1a830SBarry Smith #undef __FUNCT__ 3364b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab" 3365b5b1a830SBarry Smith /* 3366b5b1a830SBarry Smith TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab(). 3367b5b1a830SBarry Smith 3368b5b1a830SBarry Smith Collective on TS 3369b5b1a830SBarry Smith 3370b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 3371b5b1a830SBarry Smith @*/ 3372cdcf91faSSean Farley PetscErrorCode TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec x, void *ctx) 3373b5b1a830SBarry Smith { 3374b5b1a830SBarry Smith PetscErrorCode ierr; 3375b5b1a830SBarry Smith TSMatlabContext *sctx = (TSMatlabContext *)ctx; 3376a530c242SBarry Smith int nlhs = 1,nrhs = 6; 3377b5b1a830SBarry Smith mxArray *plhs[1],*prhs[6]; 3378b5b1a830SBarry Smith long long int lx = 0,ls = 0; 3379b5b1a830SBarry Smith 3380b5b1a830SBarry Smith PetscFunctionBegin; 3381cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3382b5b1a830SBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,4); 3383b5b1a830SBarry Smith 3384cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 3385b5b1a830SBarry Smith ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr); 3386b5b1a830SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 3387b5b1a830SBarry Smith prhs[1] = mxCreateDoubleScalar((double)it); 3388b5b1a830SBarry Smith prhs[2] = mxCreateDoubleScalar((double)time); 3389b5b1a830SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lx); 3390b5b1a830SBarry Smith prhs[4] = mxCreateString(sctx->funcname); 3391b5b1a830SBarry Smith prhs[5] = sctx->ctx; 3392b5b1a830SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr); 3393b5b1a830SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 3394b5b1a830SBarry Smith mxDestroyArray(prhs[0]); 3395b5b1a830SBarry Smith mxDestroyArray(prhs[1]); 3396b5b1a830SBarry Smith mxDestroyArray(prhs[2]); 3397b5b1a830SBarry Smith mxDestroyArray(prhs[3]); 3398b5b1a830SBarry Smith mxDestroyArray(prhs[4]); 3399b5b1a830SBarry Smith mxDestroyArray(plhs[0]); 3400b5b1a830SBarry Smith PetscFunctionReturn(0); 3401b5b1a830SBarry Smith } 3402b5b1a830SBarry Smith 3403b5b1a830SBarry Smith 3404b5b1a830SBarry Smith #undef __FUNCT__ 3405b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab" 3406b5b1a830SBarry Smith /* 3407b5b1a830SBarry Smith TSMonitorSetMatlab - Sets the monitor function from Matlab 3408b5b1a830SBarry Smith 3409b5b1a830SBarry Smith Level: developer 3410b5b1a830SBarry Smith 3411b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function 3412b5b1a830SBarry Smith 3413b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 3414b5b1a830SBarry Smith */ 3415cdcf91faSSean Farley PetscErrorCode TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx) 3416b5b1a830SBarry Smith { 3417b5b1a830SBarry Smith PetscErrorCode ierr; 3418b5b1a830SBarry Smith TSMatlabContext *sctx; 3419b5b1a830SBarry Smith 3420b5b1a830SBarry Smith PetscFunctionBegin; 3421b5b1a830SBarry Smith /* currently sctx is memory bleed */ 3422b5b1a830SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 3423b5b1a830SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 3424b5b1a830SBarry Smith /* 3425b5b1a830SBarry Smith This should work, but it doesn't 3426b5b1a830SBarry Smith sctx->ctx = ctx; 3427b5b1a830SBarry Smith mexMakeArrayPersistent(sctx->ctx); 3428b5b1a830SBarry Smith */ 3429b5b1a830SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 3430cdcf91faSSean Farley ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,PETSC_NULL);CHKERRQ(ierr); 3431b5b1a830SBarry Smith PetscFunctionReturn(0); 3432b5b1a830SBarry Smith } 3433325fc9f4SBarry Smith #endif 3434