163dd3a1aSKris Buschelman 2*b45d2f2cSJed Brown #include <petsc-private/tsimpl.h> /*I "petscts.h" I*/ 3496e6a7aSJed Brown #include <petscdmshell.h> 4d763cef2SBarry Smith 5d5ba7fb7SMatthew Knepley /* Logging support */ 67087cfbeSBarry Smith PetscClassId TS_CLASSID; 7166c7f25SBarry Smith PetscLogEvent TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval; 8d405a339SMatthew Knepley 94a2ae208SSatish Balay #undef __FUNCT__ 10bdad233fSMatthew Knepley #define __FUNCT__ "TSSetTypeFromOptions" 11bdad233fSMatthew Knepley /* 12bdad233fSMatthew Knepley TSSetTypeFromOptions - Sets the type of ts from user options. 13bdad233fSMatthew Knepley 14bdad233fSMatthew Knepley Collective on TS 15bdad233fSMatthew Knepley 16bdad233fSMatthew Knepley Input Parameter: 17bdad233fSMatthew Knepley . ts - The ts 18bdad233fSMatthew Knepley 19bdad233fSMatthew Knepley Level: intermediate 20bdad233fSMatthew Knepley 21bdad233fSMatthew Knepley .keywords: TS, set, options, database, type 22bdad233fSMatthew Knepley .seealso: TSSetFromOptions(), TSSetType() 23bdad233fSMatthew Knepley */ 246849ba73SBarry Smith static PetscErrorCode TSSetTypeFromOptions(TS ts) 25bdad233fSMatthew Knepley { 26ace3abfcSBarry Smith PetscBool opt; 272fc52814SBarry Smith const char *defaultType; 28bdad233fSMatthew Knepley char typeName[256]; 29dfbe8321SBarry Smith PetscErrorCode ierr; 30bdad233fSMatthew Knepley 31bdad233fSMatthew Knepley PetscFunctionBegin; 327adad957SLisandro Dalcin if (((PetscObject)ts)->type_name) { 337adad957SLisandro Dalcin defaultType = ((PetscObject)ts)->type_name; 34bdad233fSMatthew Knepley } else { 359596e0b4SJed Brown defaultType = TSEULER; 36bdad233fSMatthew Knepley } 37bdad233fSMatthew Knepley 38cce0b1b2SLisandro Dalcin if (!TSRegisterAllCalled) {ierr = TSRegisterAll(PETSC_NULL);CHKERRQ(ierr);} 39bdad233fSMatthew Knepley ierr = PetscOptionsList("-ts_type", "TS method"," TSSetType", TSList, defaultType, typeName, 256, &opt);CHKERRQ(ierr); 40a7cc72afSBarry Smith if (opt) { 41bdad233fSMatthew Knepley ierr = TSSetType(ts, typeName);CHKERRQ(ierr); 42bdad233fSMatthew Knepley } else { 43bdad233fSMatthew Knepley ierr = TSSetType(ts, defaultType);CHKERRQ(ierr); 44bdad233fSMatthew Knepley } 45bdad233fSMatthew Knepley PetscFunctionReturn(0); 46bdad233fSMatthew Knepley } 47bdad233fSMatthew Knepley 48bdad233fSMatthew Knepley #undef __FUNCT__ 49bdad233fSMatthew Knepley #define __FUNCT__ "TSSetFromOptions" 50bdad233fSMatthew Knepley /*@ 51bdad233fSMatthew Knepley TSSetFromOptions - Sets various TS parameters from user options. 52bdad233fSMatthew Knepley 53bdad233fSMatthew Knepley Collective on TS 54bdad233fSMatthew Knepley 55bdad233fSMatthew Knepley Input Parameter: 56bdad233fSMatthew Knepley . ts - the TS context obtained from TSCreate() 57bdad233fSMatthew Knepley 58bdad233fSMatthew Knepley Options Database Keys: 594d91e141SJed Brown + -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSGL, TSSSP 60bdad233fSMatthew Knepley . -ts_max_steps maxsteps - maximum number of time-steps to take 613bca7d26SBarry Smith . -ts_final_time time - maximum time to compute to 62bdad233fSMatthew Knepley . -ts_dt dt - initial time step 63bdad233fSMatthew Knepley . -ts_monitor - print information at each timestep 64a6570f20SBarry Smith - -ts_monitor_draw - plot information at each timestep 65bdad233fSMatthew Knepley 66bdad233fSMatthew Knepley Level: beginner 67bdad233fSMatthew Knepley 68bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database 69bdad233fSMatthew Knepley 70a313700dSBarry Smith .seealso: TSGetType() 71bdad233fSMatthew Knepley @*/ 727087cfbeSBarry Smith PetscErrorCode TSSetFromOptions(TS ts) 73bdad233fSMatthew Knepley { 74ace3abfcSBarry Smith PetscBool opt,flg; 75dfbe8321SBarry Smith PetscErrorCode ierr; 76649052a6SBarry Smith PetscViewer monviewer; 77eabae89aSBarry Smith char monfilename[PETSC_MAX_PATH_LEN]; 78089b2837SJed Brown SNES snes; 791c3436cfSJed Brown TSAdapt adapt; 80bdad233fSMatthew Knepley 81bdad233fSMatthew Knepley PetscFunctionBegin; 820700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 833194b578SJed Brown ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr); 84a43b19c4SJed Brown /* Handle TS type options */ 85a43b19c4SJed Brown ierr = TSSetTypeFromOptions(ts);CHKERRQ(ierr); 86bdad233fSMatthew Knepley 87bdad233fSMatthew Knepley /* Handle generic TS options */ 88bdad233fSMatthew Knepley ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,PETSC_NULL);CHKERRQ(ierr); 893bca7d26SBarry Smith ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,PETSC_NULL);CHKERRQ(ierr); 90d8cd7023SBarry Smith ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,PETSC_NULL);CHKERRQ(ierr); 91d8cd7023SBarry Smith ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&ts->time_step,PETSC_NULL);CHKERRQ(ierr); 92a43b19c4SJed Brown opt = ts->exact_final_time == PETSC_DECIDE ? PETSC_FALSE : (PetscBool)ts->exact_final_time; 93a43b19c4SJed Brown ierr = PetscOptionsBool("-ts_exact_final_time","Interpolate output to stop exactly at the final time","TSSetExactFinalTime",opt,&opt,&flg);CHKERRQ(ierr); 94461e00b3SSean Farley if (flg) {ierr = TSSetExactFinalTime(ts,opt);CHKERRQ(ierr);} 95193ac0bcSJed 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); 96193ac0bcSJed Brown ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections","",ts->max_reject,&ts->max_reject,PETSC_NULL);CHKERRQ(ierr); 97193ac0bcSJed Brown ierr = PetscOptionsBool("-ts_error_if_step_failed","Error if no step succeeds","",ts->errorifstepfailed,&ts->errorifstepfailed,PETSC_NULL);CHKERRQ(ierr); 981c3436cfSJed Brown ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,PETSC_NULL);CHKERRQ(ierr); 991c3436cfSJed Brown ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,PETSC_NULL);CHKERRQ(ierr); 100bdad233fSMatthew Knepley 101bdad233fSMatthew Knepley /* Monitor options */ 102a6570f20SBarry Smith ierr = PetscOptionsString("-ts_monitor","Monitor timestep size","TSMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 103eabae89aSBarry Smith if (flg) { 104649052a6SBarry Smith ierr = PetscViewerASCIIOpen(((PetscObject)ts)->comm,monfilename,&monviewer);CHKERRQ(ierr); 105649052a6SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 106bdad233fSMatthew Knepley } 1075180491cSLisandro Dalcin ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 1085180491cSLisandro Dalcin if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);} 1095180491cSLisandro Dalcin 11090d69ab7SBarry Smith opt = PETSC_FALSE; 111acfcf0e5SJed Brown ierr = PetscOptionsBool("-ts_monitor_draw","Monitor timestep size graphically","TSMonitorLG",opt,&opt,PETSC_NULL);CHKERRQ(ierr); 112a7cc72afSBarry Smith if (opt) { 113a6570f20SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLG,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 114bdad233fSMatthew Knepley } 11590d69ab7SBarry Smith opt = PETSC_FALSE; 116acfcf0e5SJed Brown ierr = PetscOptionsBool("-ts_monitor_solution","Monitor solution graphically","TSMonitorSolution",opt,&opt,PETSC_NULL);CHKERRQ(ierr); 117a7cc72afSBarry Smith if (opt) { 1186083293cSBarry Smith void *ctx; 1196083293cSBarry Smith ierr = TSMonitorSolutionCreate(ts,PETSC_NULL,&ctx);CHKERRQ(ierr); 1206083293cSBarry Smith ierr = TSMonitorSet(ts,TSMonitorSolution,ctx,TSMonitorSolutionDestroy);CHKERRQ(ierr); 121bdad233fSMatthew Knepley } 122fb1732b5SBarry Smith opt = PETSC_FALSE; 123fb1732b5SBarry Smith ierr = PetscOptionsString("-ts_monitor_solution_binary","Save each solution to a binary file","TSMonitorSolutionBinary",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 124fb1732b5SBarry Smith if (flg) { 125fb1732b5SBarry Smith PetscViewer ctx; 126fb1732b5SBarry Smith if (monfilename[0]) { 127fb1732b5SBarry Smith ierr = PetscViewerBinaryOpen(((PetscObject)ts)->comm,monfilename,FILE_MODE_WRITE,&ctx);CHKERRQ(ierr); 128fb1732b5SBarry Smith } else { 129fb1732b5SBarry Smith ctx = PETSC_VIEWER_BINARY_(((PetscObject)ts)->comm); 130fb1732b5SBarry Smith } 131fb1732b5SBarry Smith ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 132fb1732b5SBarry Smith } 133ed81e22dSJed Brown opt = PETSC_FALSE; 134ed81e22dSJed 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); 135ed81e22dSJed Brown if (flg) { 136ed81e22dSJed Brown const char *ptr,*ptr2; 137ed81e22dSJed Brown char *filetemplate; 138ed81e22dSJed Brown if (!monfilename[0]) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 139ed81e22dSJed Brown /* Do some cursory validation of the input. */ 140ed81e22dSJed Brown ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr); 141ed81e22dSJed Brown if (!ptr) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 142ed81e22dSJed Brown for (ptr++ ; ptr && *ptr; ptr++) { 143ed81e22dSJed Brown ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr); 144ed81e22dSJed 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"); 145ed81e22dSJed Brown if (ptr2) break; 146ed81e22dSJed Brown } 147ed81e22dSJed Brown ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr); 148ed81e22dSJed Brown ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr); 149ed81e22dSJed Brown } 150bdad233fSMatthew Knepley 1511c3436cfSJed Brown ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr); 1521c3436cfSJed Brown ierr = TSAdaptSetFromOptions(adapt);CHKERRQ(ierr); 1531c3436cfSJed Brown 154d52bd9f3SBarry Smith ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 155d52bd9f3SBarry Smith if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);} 156d52bd9f3SBarry Smith 157bdad233fSMatthew Knepley /* Handle specific TS options */ 158abc0a331SBarry Smith if (ts->ops->setfromoptions) { 159bdad233fSMatthew Knepley ierr = (*ts->ops->setfromoptions)(ts);CHKERRQ(ierr); 160bdad233fSMatthew Knepley } 1615d973c19SBarry Smith 1625d973c19SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 1635d973c19SBarry Smith ierr = PetscObjectProcessOptionsHandlers((PetscObject)ts);CHKERRQ(ierr); 164bdad233fSMatthew Knepley ierr = PetscOptionsEnd();CHKERRQ(ierr); 165bdad233fSMatthew Knepley PetscFunctionReturn(0); 166bdad233fSMatthew Knepley } 167bdad233fSMatthew Knepley 168bdad233fSMatthew Knepley #undef __FUNCT__ 169cdcf91faSSean Farley #undef __FUNCT__ 1704a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSJacobian" 171a7a1495cSBarry Smith /*@ 1728c385f81SBarry Smith TSComputeRHSJacobian - Computes the Jacobian matrix that has been 173a7a1495cSBarry Smith set with TSSetRHSJacobian(). 174a7a1495cSBarry Smith 175a7a1495cSBarry Smith Collective on TS and Vec 176a7a1495cSBarry Smith 177a7a1495cSBarry Smith Input Parameters: 178316643e7SJed Brown + ts - the TS context 179a7a1495cSBarry Smith . t - current timestep 180a7a1495cSBarry Smith - x - input vector 181a7a1495cSBarry Smith 182a7a1495cSBarry Smith Output Parameters: 183a7a1495cSBarry Smith + A - Jacobian matrix 184a7a1495cSBarry Smith . B - optional preconditioning matrix 185a7a1495cSBarry Smith - flag - flag indicating matrix structure 186a7a1495cSBarry Smith 187a7a1495cSBarry Smith Notes: 188a7a1495cSBarry Smith Most users should not need to explicitly call this routine, as it 189a7a1495cSBarry Smith is used internally within the nonlinear solvers. 190a7a1495cSBarry Smith 19194b7f48cSBarry Smith See KSPSetOperators() for important information about setting the 192a7a1495cSBarry Smith flag parameter. 193a7a1495cSBarry Smith 194a7a1495cSBarry Smith Level: developer 195a7a1495cSBarry Smith 196a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix 197a7a1495cSBarry Smith 19894b7f48cSBarry Smith .seealso: TSSetRHSJacobian(), KSPSetOperators() 199a7a1495cSBarry Smith @*/ 2007087cfbeSBarry Smith PetscErrorCode TSComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat *A,Mat *B,MatStructure *flg) 201a7a1495cSBarry Smith { 202dfbe8321SBarry Smith PetscErrorCode ierr; 2030e4ef248SJed Brown PetscInt Xstate; 204a7a1495cSBarry Smith 205a7a1495cSBarry Smith PetscFunctionBegin; 2060700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2070700a824SBarry Smith PetscValidHeaderSpecific(X,VEC_CLASSID,3); 208c9780b6fSBarry Smith PetscCheckSameComm(ts,1,X,3); 2090e4ef248SJed Brown ierr = PetscObjectStateQuery((PetscObject)X,&Xstate);CHKERRQ(ierr); 2100e4ef248SJed Brown if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == X && ts->rhsjacobian.Xstate == Xstate))) { 2110e4ef248SJed Brown *flg = ts->rhsjacobian.mstructure; 2120e4ef248SJed Brown PetscFunctionReturn(0); 213f8ede8e7SJed Brown } 214d90be118SSean Farley 2153b5f76d0SSean Farley if (!ts->userops->rhsjacobian && !ts->userops->ijacobian) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 216d90be118SSean Farley 2173b5f76d0SSean Farley if (ts->userops->rhsjacobian) { 218d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_JacobianEval,ts,X,*A,*B);CHKERRQ(ierr); 219a7a1495cSBarry Smith *flg = DIFFERENT_NONZERO_PATTERN; 220a7a1495cSBarry Smith PetscStackPush("TS user Jacobian function"); 2213b5f76d0SSean Farley ierr = (*ts->userops->rhsjacobian)(ts,t,X,A,B,flg,ts->jacP);CHKERRQ(ierr); 222a7a1495cSBarry Smith PetscStackPop; 223d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_JacobianEval,ts,X,*A,*B);CHKERRQ(ierr); 224a7a1495cSBarry Smith /* make sure user returned a correct Jacobian and preconditioner */ 2250700a824SBarry Smith PetscValidHeaderSpecific(*A,MAT_CLASSID,4); 2260700a824SBarry Smith PetscValidHeaderSpecific(*B,MAT_CLASSID,5); 227ef66eb69SBarry Smith } else { 228214bc6a2SJed Brown ierr = MatZeroEntries(*A);CHKERRQ(ierr); 229214bc6a2SJed Brown if (*A != *B) {ierr = MatZeroEntries(*B);CHKERRQ(ierr);} 230214bc6a2SJed Brown *flg = SAME_NONZERO_PATTERN; 231ef66eb69SBarry Smith } 2320e4ef248SJed Brown ts->rhsjacobian.time = t; 2330e4ef248SJed Brown ts->rhsjacobian.X = X; 2340e4ef248SJed Brown ierr = PetscObjectStateQuery((PetscObject)X,&ts->rhsjacobian.Xstate);CHKERRQ(ierr); 2350e4ef248SJed Brown ts->rhsjacobian.mstructure = *flg; 236a7a1495cSBarry Smith PetscFunctionReturn(0); 237a7a1495cSBarry Smith } 238a7a1495cSBarry Smith 2394a2ae208SSatish Balay #undef __FUNCT__ 2404a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction" 241316643e7SJed Brown /*@ 242d763cef2SBarry Smith TSComputeRHSFunction - Evaluates the right-hand-side function. 243d763cef2SBarry Smith 244316643e7SJed Brown Collective on TS and Vec 245316643e7SJed Brown 246316643e7SJed Brown Input Parameters: 247316643e7SJed Brown + ts - the TS context 248316643e7SJed Brown . t - current time 249316643e7SJed Brown - x - state vector 250316643e7SJed Brown 251316643e7SJed Brown Output Parameter: 252316643e7SJed Brown . y - right hand side 253316643e7SJed Brown 254316643e7SJed Brown Note: 255316643e7SJed Brown Most users should not need to explicitly call this routine, as it 256316643e7SJed Brown is used internally within the nonlinear solvers. 257316643e7SJed Brown 258316643e7SJed Brown Level: developer 259316643e7SJed Brown 260316643e7SJed Brown .keywords: TS, compute 261316643e7SJed Brown 262316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction() 263316643e7SJed Brown @*/ 264dfbe8321SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec x,Vec y) 265d763cef2SBarry Smith { 266dfbe8321SBarry Smith PetscErrorCode ierr; 267d763cef2SBarry Smith 268d763cef2SBarry Smith PetscFunctionBegin; 2690700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2700700a824SBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,3); 2710700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,4); 272d763cef2SBarry Smith 2733b5f76d0SSean Farley if (!ts->userops->rhsfunction && !ts->userops->ifunction) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 274d763cef2SBarry Smith 275d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_FunctionEval,ts,x,y,0);CHKERRQ(ierr); 2763b5f76d0SSean Farley if (ts->userops->rhsfunction) { 277d763cef2SBarry Smith PetscStackPush("TS user right-hand-side function"); 2783b5f76d0SSean Farley ierr = (*ts->userops->rhsfunction)(ts,t,x,y,ts->funP);CHKERRQ(ierr); 279d763cef2SBarry Smith PetscStackPop; 280214bc6a2SJed Brown } else { 281214bc6a2SJed Brown ierr = VecZeroEntries(y);CHKERRQ(ierr); 282b2cd27e8SJed Brown } 28344a41b28SSean Farley 284d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_FunctionEval,ts,x,y,0);CHKERRQ(ierr); 285d763cef2SBarry Smith PetscFunctionReturn(0); 286d763cef2SBarry Smith } 287d763cef2SBarry Smith 2884a2ae208SSatish Balay #undef __FUNCT__ 289214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private" 290214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs) 291214bc6a2SJed Brown { 2922dd45cf8SJed Brown Vec F; 293214bc6a2SJed Brown PetscErrorCode ierr; 294214bc6a2SJed Brown 295214bc6a2SJed Brown PetscFunctionBegin; 2960da9a4f0SJed Brown *Frhs = PETSC_NULL; 2972dd45cf8SJed Brown ierr = TSGetIFunction(ts,&F,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 298214bc6a2SJed Brown if (!ts->Frhs) { 2992dd45cf8SJed Brown ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr); 300214bc6a2SJed Brown } 301214bc6a2SJed Brown *Frhs = ts->Frhs; 302214bc6a2SJed Brown PetscFunctionReturn(0); 303214bc6a2SJed Brown } 304214bc6a2SJed Brown 305214bc6a2SJed Brown #undef __FUNCT__ 306214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private" 307214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs) 308214bc6a2SJed Brown { 309214bc6a2SJed Brown Mat A,B; 3102dd45cf8SJed Brown PetscErrorCode ierr; 311214bc6a2SJed Brown 312214bc6a2SJed Brown PetscFunctionBegin; 313214bc6a2SJed Brown ierr = TSGetIJacobian(ts,&A,&B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 314214bc6a2SJed Brown if (Arhs) { 315214bc6a2SJed Brown if (!ts->Arhs) { 316214bc6a2SJed Brown ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr); 317214bc6a2SJed Brown } 318214bc6a2SJed Brown *Arhs = ts->Arhs; 319214bc6a2SJed Brown } 320214bc6a2SJed Brown if (Brhs) { 321214bc6a2SJed Brown if (!ts->Brhs) { 322214bc6a2SJed Brown ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr); 323214bc6a2SJed Brown } 324214bc6a2SJed Brown *Brhs = ts->Brhs; 325214bc6a2SJed Brown } 326214bc6a2SJed Brown PetscFunctionReturn(0); 327214bc6a2SJed Brown } 328214bc6a2SJed Brown 329214bc6a2SJed Brown #undef __FUNCT__ 330316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction" 331316643e7SJed Brown /*@ 332316643e7SJed Brown TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,X,Xdot)=0 333316643e7SJed Brown 334316643e7SJed Brown Collective on TS and Vec 335316643e7SJed Brown 336316643e7SJed Brown Input Parameters: 337316643e7SJed Brown + ts - the TS context 338316643e7SJed Brown . t - current time 339316643e7SJed Brown . X - state vector 340214bc6a2SJed Brown . Xdot - time derivative of state vector 341214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate 342316643e7SJed Brown 343316643e7SJed Brown Output Parameter: 344316643e7SJed Brown . Y - right hand side 345316643e7SJed Brown 346316643e7SJed Brown Note: 347316643e7SJed Brown Most users should not need to explicitly call this routine, as it 348316643e7SJed Brown is used internally within the nonlinear solvers. 349316643e7SJed Brown 350316643e7SJed Brown If the user did did not write their equations in implicit form, this 351316643e7SJed Brown function recasts them in implicit form. 352316643e7SJed Brown 353316643e7SJed Brown Level: developer 354316643e7SJed Brown 355316643e7SJed Brown .keywords: TS, compute 356316643e7SJed Brown 357316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction() 358316643e7SJed Brown @*/ 359214bc6a2SJed Brown PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec X,Vec Xdot,Vec Y,PetscBool imex) 360316643e7SJed Brown { 361316643e7SJed Brown PetscErrorCode ierr; 362316643e7SJed Brown 363316643e7SJed Brown PetscFunctionBegin; 3640700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3650700a824SBarry Smith PetscValidHeaderSpecific(X,VEC_CLASSID,3); 3660700a824SBarry Smith PetscValidHeaderSpecific(Xdot,VEC_CLASSID,4); 3670700a824SBarry Smith PetscValidHeaderSpecific(Y,VEC_CLASSID,5); 368316643e7SJed Brown 369d90be118SSean Farley if (!ts->userops->rhsfunction && !ts->userops->ifunction) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 370d90be118SSean Farley 371316643e7SJed Brown ierr = PetscLogEventBegin(TS_FunctionEval,ts,X,Xdot,Y);CHKERRQ(ierr); 3723b5f76d0SSean Farley if (ts->userops->ifunction) { 373316643e7SJed Brown PetscStackPush("TS user implicit function"); 3743b5f76d0SSean Farley ierr = (*ts->userops->ifunction)(ts,t,X,Xdot,Y,ts->funP);CHKERRQ(ierr); 375316643e7SJed Brown PetscStackPop; 376214bc6a2SJed Brown } 377214bc6a2SJed Brown if (imex) { 3783b5f76d0SSean Farley if (!ts->userops->ifunction) { 3792dd45cf8SJed Brown ierr = VecCopy(Xdot,Y);CHKERRQ(ierr); 3802dd45cf8SJed Brown } 3812dd45cf8SJed Brown } else if (ts->userops->rhsfunction) { 3822dd45cf8SJed Brown if (ts->userops->ifunction) { 383214bc6a2SJed Brown Vec Frhs; 384214bc6a2SJed Brown ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 385214bc6a2SJed Brown ierr = TSComputeRHSFunction(ts,t,X,Frhs);CHKERRQ(ierr); 386214bc6a2SJed Brown ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr); 3872dd45cf8SJed Brown } else { 3882dd45cf8SJed Brown ierr = TSComputeRHSFunction(ts,t,X,Y);CHKERRQ(ierr); 3892dd45cf8SJed Brown ierr = VecAYPX(Y,-1,Xdot);CHKERRQ(ierr); 390316643e7SJed Brown } 3914a6899ffSJed Brown } 392316643e7SJed Brown ierr = PetscLogEventEnd(TS_FunctionEval,ts,X,Xdot,Y);CHKERRQ(ierr); 393316643e7SJed Brown PetscFunctionReturn(0); 394316643e7SJed Brown } 395316643e7SJed Brown 396316643e7SJed Brown #undef __FUNCT__ 397316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian" 398316643e7SJed Brown /*@ 399316643e7SJed Brown TSComputeIJacobian - Evaluates the Jacobian of the DAE 400316643e7SJed Brown 401316643e7SJed Brown Collective on TS and Vec 402316643e7SJed Brown 403316643e7SJed Brown Input 404316643e7SJed Brown Input Parameters: 405316643e7SJed Brown + ts - the TS context 406316643e7SJed Brown . t - current timestep 407316643e7SJed Brown . X - state vector 408316643e7SJed Brown . Xdot - time derivative of state vector 409214bc6a2SJed Brown . shift - shift to apply, see note below 410214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate 411316643e7SJed Brown 412316643e7SJed Brown Output Parameters: 413316643e7SJed Brown + A - Jacobian matrix 414316643e7SJed Brown . B - optional preconditioning matrix 415316643e7SJed Brown - flag - flag indicating matrix structure 416316643e7SJed Brown 417316643e7SJed Brown Notes: 418316643e7SJed Brown If F(t,X,Xdot)=0 is the DAE, the required Jacobian is 419316643e7SJed Brown 420316643e7SJed Brown dF/dX + shift*dF/dXdot 421316643e7SJed Brown 422316643e7SJed Brown Most users should not need to explicitly call this routine, as it 423316643e7SJed Brown is used internally within the nonlinear solvers. 424316643e7SJed Brown 425316643e7SJed Brown Level: developer 426316643e7SJed Brown 427316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix 428316643e7SJed Brown 429316643e7SJed Brown .seealso: TSSetIJacobian() 43063495f91SJed Brown @*/ 431214bc6a2SJed Brown PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec X,Vec Xdot,PetscReal shift,Mat *A,Mat *B,MatStructure *flg,PetscBool imex) 432316643e7SJed Brown { 4330026cea9SSean Farley PetscInt Xstate, Xdotstate; 434316643e7SJed Brown PetscErrorCode ierr; 435316643e7SJed Brown 436316643e7SJed Brown PetscFunctionBegin; 4370700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4380700a824SBarry Smith PetscValidHeaderSpecific(X,VEC_CLASSID,3); 4390700a824SBarry Smith PetscValidHeaderSpecific(Xdot,VEC_CLASSID,4); 440316643e7SJed Brown PetscValidPointer(A,6); 4410700a824SBarry Smith PetscValidHeaderSpecific(*A,MAT_CLASSID,6); 442316643e7SJed Brown PetscValidPointer(B,7); 4430700a824SBarry Smith PetscValidHeaderSpecific(*B,MAT_CLASSID,7); 444316643e7SJed Brown PetscValidPointer(flg,8); 4450026cea9SSean Farley ierr = PetscObjectStateQuery((PetscObject)X,&Xstate);CHKERRQ(ierr); 4460026cea9SSean Farley ierr = PetscObjectStateQuery((PetscObject)Xdot,&Xdotstate);CHKERRQ(ierr); 4470026cea9SSean 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))) { 4480026cea9SSean Farley *flg = ts->ijacobian.mstructure; 4490026cea9SSean Farley ierr = MatScale(*A, shift / ts->ijacobian.shift);CHKERRQ(ierr); 4500026cea9SSean Farley PetscFunctionReturn(0); 4510026cea9SSean Farley } 452316643e7SJed Brown 4533b5f76d0SSean Farley if (!ts->userops->rhsjacobian && !ts->userops->ijacobian) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 454316643e7SJed Brown 4554e684422SJed Brown *flg = SAME_NONZERO_PATTERN; /* In case we're solving a linear problem in which case it wouldn't get initialized below. */ 456316643e7SJed Brown ierr = PetscLogEventBegin(TS_JacobianEval,ts,X,*A,*B);CHKERRQ(ierr); 4573b5f76d0SSean Farley if (ts->userops->ijacobian) { 4582dd45cf8SJed Brown *flg = DIFFERENT_NONZERO_PATTERN; 459316643e7SJed Brown PetscStackPush("TS user implicit Jacobian"); 4603b5f76d0SSean Farley ierr = (*ts->userops->ijacobian)(ts,t,X,Xdot,shift,A,B,flg,ts->jacP);CHKERRQ(ierr); 461316643e7SJed Brown PetscStackPop; 462214bc6a2SJed Brown /* make sure user returned a correct Jacobian and preconditioner */ 463214bc6a2SJed Brown PetscValidHeaderSpecific(*A,MAT_CLASSID,4); 464214bc6a2SJed Brown PetscValidHeaderSpecific(*B,MAT_CLASSID,5); 4654a6899ffSJed Brown } 466214bc6a2SJed Brown if (imex) { 4673b5f76d0SSean Farley if (!ts->userops->ijacobian) { /* system was written as Xdot = F(t,X) */ 468214bc6a2SJed Brown ierr = MatZeroEntries(*A);CHKERRQ(ierr); 4692dd45cf8SJed Brown ierr = MatShift(*A,shift);CHKERRQ(ierr); 470214bc6a2SJed Brown if (*A != *B) { 471214bc6a2SJed Brown ierr = MatZeroEntries(*B);CHKERRQ(ierr); 472214bc6a2SJed Brown ierr = MatShift(*B,shift);CHKERRQ(ierr); 473214bc6a2SJed Brown } 474214bc6a2SJed Brown *flg = SAME_PRECONDITIONER; 475214bc6a2SJed Brown } 476214bc6a2SJed Brown } else { 4773b5f76d0SSean Farley if (!ts->userops->ijacobian) { 478214bc6a2SJed Brown ierr = TSComputeRHSJacobian(ts,t,X,A,B,flg);CHKERRQ(ierr); 479214bc6a2SJed Brown ierr = MatScale(*A,-1);CHKERRQ(ierr); 480214bc6a2SJed Brown ierr = MatShift(*A,shift);CHKERRQ(ierr); 481316643e7SJed Brown if (*A != *B) { 482316643e7SJed Brown ierr = MatScale(*B,-1);CHKERRQ(ierr); 483316643e7SJed Brown ierr = MatShift(*B,shift);CHKERRQ(ierr); 484316643e7SJed Brown } 4853b5f76d0SSean Farley } else if (ts->userops->rhsjacobian) { 486214bc6a2SJed Brown Mat Arhs,Brhs; 487214bc6a2SJed Brown MatStructure axpy,flg2 = DIFFERENT_NONZERO_PATTERN; 488214bc6a2SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 489214bc6a2SJed Brown ierr = TSComputeRHSJacobian(ts,t,X,&Arhs,&Brhs,&flg2);CHKERRQ(ierr); 490214bc6a2SJed Brown axpy = (*flg == flg2) ? SAME_NONZERO_PATTERN : DIFFERENT_NONZERO_PATTERN; 491214bc6a2SJed Brown ierr = MatAXPY(*A,-1,Arhs,axpy);CHKERRQ(ierr); 492214bc6a2SJed Brown if (*A != *B) { 493214bc6a2SJed Brown ierr = MatAXPY(*B,-1,Brhs,axpy);CHKERRQ(ierr); 494214bc6a2SJed Brown } 495214bc6a2SJed Brown *flg = PetscMin(*flg,flg2); 496214bc6a2SJed Brown } 497316643e7SJed Brown } 4980026cea9SSean Farley 4990026cea9SSean Farley ts->ijacobian.time = t; 5000026cea9SSean Farley ts->ijacobian.X = X; 5010026cea9SSean Farley ts->ijacobian.Xdot = Xdot; 5020026cea9SSean Farley ierr = PetscObjectStateQuery((PetscObject)X,&ts->ijacobian.Xstate);CHKERRQ(ierr); 5030026cea9SSean Farley ierr = PetscObjectStateQuery((PetscObject)Xdot,&ts->ijacobian.Xdotstate);CHKERRQ(ierr); 5040026cea9SSean Farley ts->ijacobian.shift = shift; 5050026cea9SSean Farley ts->ijacobian.imex = imex; 5060026cea9SSean Farley ts->ijacobian.mstructure = *flg; 507316643e7SJed Brown ierr = PetscLogEventEnd(TS_JacobianEval,ts,X,*A,*B);CHKERRQ(ierr); 508316643e7SJed Brown PetscFunctionReturn(0); 509316643e7SJed Brown } 510316643e7SJed Brown 511316643e7SJed Brown #undef __FUNCT__ 5124a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction" 513d763cef2SBarry Smith /*@C 514d763cef2SBarry Smith TSSetRHSFunction - Sets the routine for evaluating the function, 515d763cef2SBarry Smith F(t,u), where U_t = F(t,u). 516d763cef2SBarry Smith 5173f9fe445SBarry Smith Logically Collective on TS 518d763cef2SBarry Smith 519d763cef2SBarry Smith Input Parameters: 520d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 521ca94891dSJed Brown . r - vector to put the computed right hand side (or PETSC_NULL to have it created) 522d763cef2SBarry Smith . f - routine for evaluating the right-hand-side function 523d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 524d763cef2SBarry Smith function evaluation routine (may be PETSC_NULL) 525d763cef2SBarry Smith 526d763cef2SBarry Smith Calling sequence of func: 52787828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Vec F,void *ctx); 528d763cef2SBarry Smith 529d763cef2SBarry Smith + t - current timestep 530d763cef2SBarry Smith . u - input vector 531d763cef2SBarry Smith . F - function vector 532d763cef2SBarry Smith - ctx - [optional] user-defined function context 533d763cef2SBarry Smith 534d763cef2SBarry Smith Level: beginner 535d763cef2SBarry Smith 536d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 537d763cef2SBarry Smith 538d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian() 539d763cef2SBarry Smith @*/ 540089b2837SJed Brown PetscErrorCode TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx) 541d763cef2SBarry Smith { 542089b2837SJed Brown PetscErrorCode ierr; 543089b2837SJed Brown SNES snes; 544e856ceecSJed Brown Vec ralloc = PETSC_NULL; 545d763cef2SBarry Smith 546089b2837SJed Brown PetscFunctionBegin; 5470700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 548ca94891dSJed Brown if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 5493b5f76d0SSean Farley if (f) ts->userops->rhsfunction = f; 5504e684422SJed Brown if (ctx) ts->funP = ctx; 551089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 552e856ceecSJed Brown if (!r && !ts->dm && ts->vec_sol) { 553e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 554e856ceecSJed Brown r = ralloc; 555e856ceecSJed Brown } 556089b2837SJed Brown ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 557e856ceecSJed Brown ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 558d763cef2SBarry Smith PetscFunctionReturn(0); 559d763cef2SBarry Smith } 560d763cef2SBarry Smith 5614a2ae208SSatish Balay #undef __FUNCT__ 5624a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian" 563d763cef2SBarry Smith /*@C 564d763cef2SBarry Smith TSSetRHSJacobian - Sets the function to compute the Jacobian of F, 565d763cef2SBarry Smith where U_t = F(U,t), as well as the location to store the matrix. 566d763cef2SBarry Smith 5673f9fe445SBarry Smith Logically Collective on TS 568d763cef2SBarry Smith 569d763cef2SBarry Smith Input Parameters: 570d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 571d763cef2SBarry Smith . A - Jacobian matrix 572d763cef2SBarry Smith . B - preconditioner matrix (usually same as A) 573d763cef2SBarry Smith . f - the Jacobian evaluation routine 574d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 575d763cef2SBarry Smith Jacobian evaluation routine (may be PETSC_NULL) 576d763cef2SBarry Smith 577d763cef2SBarry Smith Calling sequence of func: 57887828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Mat *A,Mat *B,MatStructure *flag,void *ctx); 579d763cef2SBarry Smith 580d763cef2SBarry Smith + t - current timestep 581d763cef2SBarry Smith . u - input vector 582d763cef2SBarry Smith . A - matrix A, where U_t = A(t)u 583d763cef2SBarry Smith . B - preconditioner matrix, usually the same as A 584d763cef2SBarry Smith . flag - flag indicating information about the preconditioner matrix 58594b7f48cSBarry Smith structure (same as flag in KSPSetOperators()) 586d763cef2SBarry Smith - ctx - [optional] user-defined context for matrix evaluation routine 587d763cef2SBarry Smith 588d763cef2SBarry Smith Notes: 58994b7f48cSBarry Smith See KSPSetOperators() for important information about setting the flag 590d763cef2SBarry Smith output parameter in the routine func(). Be sure to read this information! 591d763cef2SBarry Smith 592d763cef2SBarry Smith The routine func() takes Mat * as the matrix arguments rather than Mat. 593d763cef2SBarry Smith This allows the matrix evaluation routine to replace A and/or B with a 59456335db2SHong Zhang completely new matrix structure (not just different matrix elements) 595d763cef2SBarry Smith when appropriate, for instance, if the nonzero structure is changing 596d763cef2SBarry Smith throughout the global iterations. 597d763cef2SBarry Smith 598d763cef2SBarry Smith Level: beginner 599d763cef2SBarry Smith 600d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian 601d763cef2SBarry Smith 602ab637aeaSJed Brown .seealso: SNESDefaultComputeJacobianColor(), TSSetRHSFunction() 603d763cef2SBarry Smith 604d763cef2SBarry Smith @*/ 605089b2837SJed Brown PetscErrorCode TSSetRHSJacobian(TS ts,Mat A,Mat B,TSRHSJacobian f,void *ctx) 606d763cef2SBarry Smith { 607277b19d0SLisandro Dalcin PetscErrorCode ierr; 608089b2837SJed Brown SNES snes; 609277b19d0SLisandro Dalcin 610d763cef2SBarry Smith PetscFunctionBegin; 6110700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 612277b19d0SLisandro Dalcin if (A) PetscValidHeaderSpecific(A,MAT_CLASSID,2); 613277b19d0SLisandro Dalcin if (B) PetscValidHeaderSpecific(B,MAT_CLASSID,3); 614277b19d0SLisandro Dalcin if (A) PetscCheckSameComm(ts,1,A,2); 615277b19d0SLisandro Dalcin if (B) PetscCheckSameComm(ts,1,B,3); 616d763cef2SBarry Smith 6173b5f76d0SSean Farley if (f) ts->userops->rhsjacobian = f; 618277b19d0SLisandro Dalcin if (ctx) ts->jacP = ctx; 619089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 620dabe61deSJed Brown if (!ts->userops->ijacobian) { 621089b2837SJed Brown ierr = SNESSetJacobian(snes,A,B,SNESTSFormJacobian,ts);CHKERRQ(ierr); 6220e4ef248SJed Brown } 6230e4ef248SJed Brown if (A) { 6240e4ef248SJed Brown ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr); 6250e4ef248SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 6260e4ef248SJed Brown ts->Arhs = A; 6270e4ef248SJed Brown } 6280e4ef248SJed Brown if (B) { 6290e4ef248SJed Brown ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr); 6300e4ef248SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 6310e4ef248SJed Brown ts->Brhs = B; 6320e4ef248SJed Brown } 633d763cef2SBarry Smith PetscFunctionReturn(0); 634d763cef2SBarry Smith } 635d763cef2SBarry Smith 636316643e7SJed Brown 637316643e7SJed Brown #undef __FUNCT__ 638316643e7SJed Brown #define __FUNCT__ "TSSetIFunction" 639316643e7SJed Brown /*@C 640316643e7SJed Brown TSSetIFunction - Set the function to compute F(t,U,U_t) where F = 0 is the DAE to be solved. 641316643e7SJed Brown 6423f9fe445SBarry Smith Logically Collective on TS 643316643e7SJed Brown 644316643e7SJed Brown Input Parameters: 645316643e7SJed Brown + ts - the TS context obtained from TSCreate() 646ca94891dSJed Brown . r - vector to hold the residual (or PETSC_NULL to have it created internally) 647316643e7SJed Brown . f - the function evaluation routine 648316643e7SJed Brown - ctx - user-defined context for private data for the function evaluation routine (may be PETSC_NULL) 649316643e7SJed Brown 650316643e7SJed Brown Calling sequence of f: 651316643e7SJed Brown $ f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx); 652316643e7SJed Brown 653316643e7SJed Brown + t - time at step/stage being solved 654316643e7SJed Brown . u - state vector 655316643e7SJed Brown . u_t - time derivative of state vector 656316643e7SJed Brown . F - function vector 657316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 658316643e7SJed Brown 659316643e7SJed Brown Important: 660d6cbdb99SBarry Smith The user MUST call either this routine, TSSetRHSFunction(). This routine must be used when not solving an ODE, for example a DAE. 661316643e7SJed Brown 662316643e7SJed Brown Level: beginner 663316643e7SJed Brown 664316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian 665316643e7SJed Brown 666d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian() 667316643e7SJed Brown @*/ 668089b2837SJed Brown PetscErrorCode TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx) 669316643e7SJed Brown { 670089b2837SJed Brown PetscErrorCode ierr; 671089b2837SJed Brown SNES snes; 672e856ceecSJed Brown Vec resalloc = PETSC_NULL; 673316643e7SJed Brown 674316643e7SJed Brown PetscFunctionBegin; 6750700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 676ca94891dSJed Brown if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2); 6773b5f76d0SSean Farley if (f) ts->userops->ifunction = f; 678089b2837SJed Brown if (ctx) ts->funP = ctx; 679089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 680e856ceecSJed Brown if (!res && !ts->dm && ts->vec_sol) { 681e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr); 682e856ceecSJed Brown res = resalloc; 683e856ceecSJed Brown } 684089b2837SJed Brown ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr); 685e856ceecSJed Brown ierr = VecDestroy(&resalloc);CHKERRQ(ierr); 686089b2837SJed Brown PetscFunctionReturn(0); 687089b2837SJed Brown } 688089b2837SJed Brown 689089b2837SJed Brown #undef __FUNCT__ 690089b2837SJed Brown #define __FUNCT__ "TSGetIFunction" 691089b2837SJed Brown /*@C 692089b2837SJed Brown TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it. 693089b2837SJed Brown 694089b2837SJed Brown Not Collective 695089b2837SJed Brown 696089b2837SJed Brown Input Parameter: 697089b2837SJed Brown . ts - the TS context 698089b2837SJed Brown 699089b2837SJed Brown Output Parameter: 700089b2837SJed Brown + r - vector to hold residual (or PETSC_NULL) 701089b2837SJed Brown . func - the function to compute residual (or PETSC_NULL) 702089b2837SJed Brown - ctx - the function context (or PETSC_NULL) 703089b2837SJed Brown 704089b2837SJed Brown Level: advanced 705089b2837SJed Brown 706089b2837SJed Brown .keywords: TS, nonlinear, get, function 707089b2837SJed Brown 708089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction() 709089b2837SJed Brown @*/ 710089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx) 711089b2837SJed Brown { 712089b2837SJed Brown PetscErrorCode ierr; 713089b2837SJed Brown SNES snes; 714089b2837SJed Brown 715089b2837SJed Brown PetscFunctionBegin; 716089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 717089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 718089b2837SJed Brown ierr = SNESGetFunction(snes,r,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 7193b5f76d0SSean Farley if (func) *func = ts->userops->ifunction; 720089b2837SJed Brown if (ctx) *ctx = ts->funP; 721089b2837SJed Brown PetscFunctionReturn(0); 722089b2837SJed Brown } 723089b2837SJed Brown 724089b2837SJed Brown #undef __FUNCT__ 725089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction" 726089b2837SJed Brown /*@C 727089b2837SJed Brown TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it. 728089b2837SJed Brown 729089b2837SJed Brown Not Collective 730089b2837SJed Brown 731089b2837SJed Brown Input Parameter: 732089b2837SJed Brown . ts - the TS context 733089b2837SJed Brown 734089b2837SJed Brown Output Parameter: 735089b2837SJed Brown + r - vector to hold computed right hand side (or PETSC_NULL) 736089b2837SJed Brown . func - the function to compute right hand side (or PETSC_NULL) 737089b2837SJed Brown - ctx - the function context (or PETSC_NULL) 738089b2837SJed Brown 739089b2837SJed Brown Level: advanced 740089b2837SJed Brown 741089b2837SJed Brown .keywords: TS, nonlinear, get, function 742089b2837SJed Brown 743089b2837SJed Brown .seealso: TSSetRhsfunction(), SNESGetFunction() 744089b2837SJed Brown @*/ 745089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx) 746089b2837SJed Brown { 747089b2837SJed Brown PetscErrorCode ierr; 748089b2837SJed Brown SNES snes; 749089b2837SJed Brown 750089b2837SJed Brown PetscFunctionBegin; 751089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 752089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 753089b2837SJed Brown ierr = SNESGetFunction(snes,r,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 7543b5f76d0SSean Farley if (func) *func = ts->userops->rhsfunction; 755089b2837SJed Brown if (ctx) *ctx = ts->funP; 756316643e7SJed Brown PetscFunctionReturn(0); 757316643e7SJed Brown } 758316643e7SJed Brown 759316643e7SJed Brown #undef __FUNCT__ 760316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian" 761316643e7SJed Brown /*@C 762a4f0a591SBarry Smith TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function 763a4f0a591SBarry Smith you provided with TSSetIFunction(). 764316643e7SJed Brown 7653f9fe445SBarry Smith Logically Collective on TS 766316643e7SJed Brown 767316643e7SJed Brown Input Parameters: 768316643e7SJed Brown + ts - the TS context obtained from TSCreate() 769316643e7SJed Brown . A - Jacobian matrix 770316643e7SJed Brown . B - preconditioning matrix for A (may be same as A) 771316643e7SJed Brown . f - the Jacobian evaluation routine 772316643e7SJed Brown - ctx - user-defined context for private data for the Jacobian evaluation routine (may be PETSC_NULL) 773316643e7SJed Brown 774316643e7SJed Brown Calling sequence of f: 7751b4a444bSJed Brown $ f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat *A,Mat *B,MatStructure *flag,void *ctx); 776316643e7SJed Brown 777316643e7SJed Brown + t - time at step/stage being solved 7781b4a444bSJed Brown . U - state vector 7791b4a444bSJed Brown . U_t - time derivative of state vector 780316643e7SJed Brown . a - shift 7811b4a444bSJed Brown . A - Jacobian of G(U) = F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t 782316643e7SJed Brown . B - preconditioning matrix for A, may be same as A 783316643e7SJed Brown . flag - flag indicating information about the preconditioner matrix 784316643e7SJed Brown structure (same as flag in KSPSetOperators()) 785316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 786316643e7SJed Brown 787316643e7SJed Brown Notes: 788316643e7SJed Brown The matrices A and B are exactly the matrices that are used by SNES for the nonlinear solve. 789316643e7SJed Brown 790a4f0a591SBarry Smith The matrix dF/dU + a*dF/dU_t you provide turns out to be 791a4f0a591SBarry Smith the Jacobian of G(U) = F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved. 792a4f0a591SBarry Smith The time integrator internally approximates U_t by W+a*U where the positive "shift" 793a4f0a591SBarry Smith a and vector W depend on the integration method, step size, and past states. For example with 794a4f0a591SBarry Smith the backward Euler method a = 1/dt and W = -a*U(previous timestep) so 795a4f0a591SBarry Smith W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt 796a4f0a591SBarry Smith 797316643e7SJed Brown Level: beginner 798316643e7SJed Brown 799316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian 800316643e7SJed Brown 801ab637aeaSJed Brown .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESDefaultComputeJacobianColor(), SNESDefaultComputeJacobian() 802316643e7SJed Brown 803316643e7SJed Brown @*/ 8047087cfbeSBarry Smith PetscErrorCode TSSetIJacobian(TS ts,Mat A,Mat B,TSIJacobian f,void *ctx) 805316643e7SJed Brown { 806316643e7SJed Brown PetscErrorCode ierr; 807089b2837SJed Brown SNES snes; 808316643e7SJed Brown 809316643e7SJed Brown PetscFunctionBegin; 8100700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 8110700a824SBarry Smith if (A) PetscValidHeaderSpecific(A,MAT_CLASSID,2); 8120700a824SBarry Smith if (B) PetscValidHeaderSpecific(B,MAT_CLASSID,3); 813316643e7SJed Brown if (A) PetscCheckSameComm(ts,1,A,2); 814316643e7SJed Brown if (B) PetscCheckSameComm(ts,1,B,3); 8153b5f76d0SSean Farley if (f) ts->userops->ijacobian = f; 816316643e7SJed Brown if (ctx) ts->jacP = ctx; 817089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 818089b2837SJed Brown ierr = SNESSetJacobian(snes,A,B,SNESTSFormJacobian,ts);CHKERRQ(ierr); 819316643e7SJed Brown PetscFunctionReturn(0); 820316643e7SJed Brown } 821316643e7SJed Brown 8224a2ae208SSatish Balay #undef __FUNCT__ 8234a2ae208SSatish Balay #define __FUNCT__ "TSView" 8247e2c5f70SBarry Smith /*@C 825d763cef2SBarry Smith TSView - Prints the TS data structure. 826d763cef2SBarry Smith 8274c49b128SBarry Smith Collective on TS 828d763cef2SBarry Smith 829d763cef2SBarry Smith Input Parameters: 830d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 831d763cef2SBarry Smith - viewer - visualization context 832d763cef2SBarry Smith 833d763cef2SBarry Smith Options Database Key: 834d763cef2SBarry Smith . -ts_view - calls TSView() at end of TSStep() 835d763cef2SBarry Smith 836d763cef2SBarry Smith Notes: 837d763cef2SBarry Smith The available visualization contexts include 838b0a32e0cSBarry Smith + PETSC_VIEWER_STDOUT_SELF - standard output (default) 839b0a32e0cSBarry Smith - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 840d763cef2SBarry Smith output where only the first processor opens 841d763cef2SBarry Smith the file. All other processors send their 842d763cef2SBarry Smith data to the first processor to print. 843d763cef2SBarry Smith 844d763cef2SBarry Smith The user can open an alternative visualization context with 845b0a32e0cSBarry Smith PetscViewerASCIIOpen() - output to a specified file. 846d763cef2SBarry Smith 847d763cef2SBarry Smith Level: beginner 848d763cef2SBarry Smith 849d763cef2SBarry Smith .keywords: TS, timestep, view 850d763cef2SBarry Smith 851b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen() 852d763cef2SBarry Smith @*/ 8537087cfbeSBarry Smith PetscErrorCode TSView(TS ts,PetscViewer viewer) 854d763cef2SBarry Smith { 855dfbe8321SBarry Smith PetscErrorCode ierr; 856a313700dSBarry Smith const TSType type; 857089b2837SJed Brown PetscBool iascii,isstring,isundials; 858d763cef2SBarry Smith 859d763cef2SBarry Smith PetscFunctionBegin; 8600700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 8613050cee2SBarry Smith if (!viewer) { 8627adad957SLisandro Dalcin ierr = PetscViewerASCIIGetStdout(((PetscObject)ts)->comm,&viewer);CHKERRQ(ierr); 8633050cee2SBarry Smith } 8640700a824SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 865c9780b6fSBarry Smith PetscCheckSameComm(ts,1,viewer,2); 866fd16b177SBarry Smith 8672692d6eeSBarry Smith ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 8682692d6eeSBarry Smith ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 86932077d6dSBarry Smith if (iascii) { 870317d6ea6SBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer,"TS Object");CHKERRQ(ierr); 87177431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr); 872a83599f4SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum time=%G\n",ts->max_time);CHKERRQ(ierr); 873d763cef2SBarry Smith if (ts->problem_type == TS_NONLINEAR) { 87477431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solver iterations=%D\n",ts->nonlinear_its);CHKERRQ(ierr); 875c610991cSLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr); 876d763cef2SBarry Smith } 87777431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",ts->linear_its);CHKERRQ(ierr); 878193ac0bcSJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr); 879d52bd9f3SBarry Smith if (ts->ops->view) { 880d52bd9f3SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 881d52bd9f3SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 882d52bd9f3SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 883d52bd9f3SBarry Smith } 8840f5bd95cSBarry Smith } else if (isstring) { 885a313700dSBarry Smith ierr = TSGetType(ts,&type);CHKERRQ(ierr); 886b0a32e0cSBarry Smith ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr); 887d763cef2SBarry Smith } 888b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 889089b2837SJed Brown ierr = PetscTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr); 890b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 891d763cef2SBarry Smith PetscFunctionReturn(0); 892d763cef2SBarry Smith } 893d763cef2SBarry Smith 894d763cef2SBarry Smith 8954a2ae208SSatish Balay #undef __FUNCT__ 8964a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext" 897b07ff414SBarry Smith /*@ 898d763cef2SBarry Smith TSSetApplicationContext - Sets an optional user-defined context for 899d763cef2SBarry Smith the timesteppers. 900d763cef2SBarry Smith 9013f9fe445SBarry Smith Logically Collective on TS 902d763cef2SBarry Smith 903d763cef2SBarry Smith Input Parameters: 904d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 905d763cef2SBarry Smith - usrP - optional user context 906d763cef2SBarry Smith 907d763cef2SBarry Smith Level: intermediate 908d763cef2SBarry Smith 909d763cef2SBarry Smith .keywords: TS, timestep, set, application, context 910d763cef2SBarry Smith 911d763cef2SBarry Smith .seealso: TSGetApplicationContext() 912d763cef2SBarry Smith @*/ 9137087cfbeSBarry Smith PetscErrorCode TSSetApplicationContext(TS ts,void *usrP) 914d763cef2SBarry Smith { 915d763cef2SBarry Smith PetscFunctionBegin; 9160700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 917d763cef2SBarry Smith ts->user = usrP; 918d763cef2SBarry Smith PetscFunctionReturn(0); 919d763cef2SBarry Smith } 920d763cef2SBarry Smith 9214a2ae208SSatish Balay #undef __FUNCT__ 9224a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext" 923b07ff414SBarry Smith /*@ 924d763cef2SBarry Smith TSGetApplicationContext - Gets the user-defined context for the 925d763cef2SBarry Smith timestepper. 926d763cef2SBarry Smith 927d763cef2SBarry Smith Not Collective 928d763cef2SBarry Smith 929d763cef2SBarry Smith Input Parameter: 930d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 931d763cef2SBarry Smith 932d763cef2SBarry Smith Output Parameter: 933d763cef2SBarry Smith . usrP - user context 934d763cef2SBarry Smith 935d763cef2SBarry Smith Level: intermediate 936d763cef2SBarry Smith 937d763cef2SBarry Smith .keywords: TS, timestep, get, application, context 938d763cef2SBarry Smith 939d763cef2SBarry Smith .seealso: TSSetApplicationContext() 940d763cef2SBarry Smith @*/ 941e71120c6SJed Brown PetscErrorCode TSGetApplicationContext(TS ts,void *usrP) 942d763cef2SBarry Smith { 943d763cef2SBarry Smith PetscFunctionBegin; 9440700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 945e71120c6SJed Brown *(void**)usrP = ts->user; 946d763cef2SBarry Smith PetscFunctionReturn(0); 947d763cef2SBarry Smith } 948d763cef2SBarry Smith 9494a2ae208SSatish Balay #undef __FUNCT__ 9504a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber" 951d763cef2SBarry Smith /*@ 952d763cef2SBarry Smith TSGetTimeStepNumber - Gets the current number of timesteps. 953d763cef2SBarry Smith 954d763cef2SBarry Smith Not Collective 955d763cef2SBarry Smith 956d763cef2SBarry Smith Input Parameter: 957d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 958d763cef2SBarry Smith 959d763cef2SBarry Smith Output Parameter: 960d763cef2SBarry Smith . iter - number steps so far 961d763cef2SBarry Smith 962d763cef2SBarry Smith Level: intermediate 963d763cef2SBarry Smith 964d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number 965d763cef2SBarry Smith @*/ 9667087cfbeSBarry Smith PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt* iter) 967d763cef2SBarry Smith { 968d763cef2SBarry Smith PetscFunctionBegin; 9690700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 9704482741eSBarry Smith PetscValidIntPointer(iter,2); 971d763cef2SBarry Smith *iter = ts->steps; 972d763cef2SBarry Smith PetscFunctionReturn(0); 973d763cef2SBarry Smith } 974d763cef2SBarry Smith 9754a2ae208SSatish Balay #undef __FUNCT__ 9764a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep" 977d763cef2SBarry Smith /*@ 978d763cef2SBarry Smith TSSetInitialTimeStep - Sets the initial timestep to be used, 979d763cef2SBarry Smith as well as the initial time. 980d763cef2SBarry Smith 9813f9fe445SBarry Smith Logically Collective on TS 982d763cef2SBarry Smith 983d763cef2SBarry Smith Input Parameters: 984d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 985d763cef2SBarry Smith . initial_time - the initial time 986d763cef2SBarry Smith - time_step - the size of the timestep 987d763cef2SBarry Smith 988d763cef2SBarry Smith Level: intermediate 989d763cef2SBarry Smith 990d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep() 991d763cef2SBarry Smith 992d763cef2SBarry Smith .keywords: TS, set, initial, timestep 993d763cef2SBarry Smith @*/ 9947087cfbeSBarry Smith PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step) 995d763cef2SBarry Smith { 996e144a568SJed Brown PetscErrorCode ierr; 997e144a568SJed Brown 998d763cef2SBarry Smith PetscFunctionBegin; 9990700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1000e144a568SJed Brown ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 1001d8cd7023SBarry Smith ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr); 1002d763cef2SBarry Smith PetscFunctionReturn(0); 1003d763cef2SBarry Smith } 1004d763cef2SBarry Smith 10054a2ae208SSatish Balay #undef __FUNCT__ 10064a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep" 1007d763cef2SBarry Smith /*@ 1008d763cef2SBarry Smith TSSetTimeStep - Allows one to reset the timestep at any time, 1009d763cef2SBarry Smith useful for simple pseudo-timestepping codes. 1010d763cef2SBarry Smith 10113f9fe445SBarry Smith Logically Collective on TS 1012d763cef2SBarry Smith 1013d763cef2SBarry Smith Input Parameters: 1014d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1015d763cef2SBarry Smith - time_step - the size of the timestep 1016d763cef2SBarry Smith 1017d763cef2SBarry Smith Level: intermediate 1018d763cef2SBarry Smith 1019d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1020d763cef2SBarry Smith 1021d763cef2SBarry Smith .keywords: TS, set, timestep 1022d763cef2SBarry Smith @*/ 10237087cfbeSBarry Smith PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step) 1024d763cef2SBarry Smith { 1025d763cef2SBarry Smith PetscFunctionBegin; 10260700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1027c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,time_step,2); 1028d763cef2SBarry Smith ts->time_step = time_step; 1029d763cef2SBarry Smith PetscFunctionReturn(0); 1030d763cef2SBarry Smith } 1031d763cef2SBarry Smith 10324a2ae208SSatish Balay #undef __FUNCT__ 1033a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime" 1034a43b19c4SJed Brown /*@ 1035a43b19c4SJed Brown TSSetExactFinalTime - Determines whether to interpolate solution to the 1036a43b19c4SJed Brown exact final time requested by the user or just returns it at the final time 1037a43b19c4SJed Brown it computed. 1038a43b19c4SJed Brown 1039a43b19c4SJed Brown Logically Collective on TS 1040a43b19c4SJed Brown 1041a43b19c4SJed Brown Input Parameter: 1042a43b19c4SJed Brown + ts - the time-step context 1043a43b19c4SJed Brown - ft - PETSC_TRUE if interpolates, else PETSC_FALSE 1044a43b19c4SJed Brown 1045a43b19c4SJed Brown Level: beginner 1046a43b19c4SJed Brown 1047a43b19c4SJed Brown .seealso: TSSetDuration() 1048a43b19c4SJed Brown @*/ 1049a43b19c4SJed Brown PetscErrorCode TSSetExactFinalTime(TS ts,PetscBool flg) 1050a43b19c4SJed Brown { 1051a43b19c4SJed Brown 1052a43b19c4SJed Brown PetscFunctionBegin; 1053a43b19c4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1054d8cd7023SBarry Smith PetscValidLogicalCollectiveBool(ts,flg,2); 1055a43b19c4SJed Brown ts->exact_final_time = flg; 1056a43b19c4SJed Brown PetscFunctionReturn(0); 1057a43b19c4SJed Brown } 1058a43b19c4SJed Brown 1059a43b19c4SJed Brown #undef __FUNCT__ 10604a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep" 1061d763cef2SBarry Smith /*@ 1062d763cef2SBarry Smith TSGetTimeStep - Gets the current timestep size. 1063d763cef2SBarry Smith 1064d763cef2SBarry Smith Not Collective 1065d763cef2SBarry Smith 1066d763cef2SBarry Smith Input Parameter: 1067d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1068d763cef2SBarry Smith 1069d763cef2SBarry Smith Output Parameter: 1070d763cef2SBarry Smith . dt - the current timestep size 1071d763cef2SBarry Smith 1072d763cef2SBarry Smith Level: intermediate 1073d763cef2SBarry Smith 1074d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1075d763cef2SBarry Smith 1076d763cef2SBarry Smith .keywords: TS, get, timestep 1077d763cef2SBarry Smith @*/ 10787087cfbeSBarry Smith PetscErrorCode TSGetTimeStep(TS ts,PetscReal* dt) 1079d763cef2SBarry Smith { 1080d763cef2SBarry Smith PetscFunctionBegin; 10810700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 10824482741eSBarry Smith PetscValidDoublePointer(dt,2); 1083d763cef2SBarry Smith *dt = ts->time_step; 1084d763cef2SBarry Smith PetscFunctionReturn(0); 1085d763cef2SBarry Smith } 1086d763cef2SBarry Smith 10874a2ae208SSatish Balay #undef __FUNCT__ 10884a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution" 1089d8e5e3e6SSatish Balay /*@ 1090d763cef2SBarry Smith TSGetSolution - Returns the solution at the present timestep. It 1091d763cef2SBarry Smith is valid to call this routine inside the function that you are evaluating 1092d763cef2SBarry Smith in order to move to the new timestep. This vector not changed until 1093d763cef2SBarry Smith the solution at the next timestep has been calculated. 1094d763cef2SBarry Smith 1095d763cef2SBarry Smith Not Collective, but Vec returned is parallel if TS is parallel 1096d763cef2SBarry Smith 1097d763cef2SBarry Smith Input Parameter: 1098d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1099d763cef2SBarry Smith 1100d763cef2SBarry Smith Output Parameter: 1101d763cef2SBarry Smith . v - the vector containing the solution 1102d763cef2SBarry Smith 1103d763cef2SBarry Smith Level: intermediate 1104d763cef2SBarry Smith 1105d763cef2SBarry Smith .seealso: TSGetTimeStep() 1106d763cef2SBarry Smith 1107d763cef2SBarry Smith .keywords: TS, timestep, get, solution 1108d763cef2SBarry Smith @*/ 11097087cfbeSBarry Smith PetscErrorCode TSGetSolution(TS ts,Vec *v) 1110d763cef2SBarry Smith { 1111d763cef2SBarry Smith PetscFunctionBegin; 11120700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 11134482741eSBarry Smith PetscValidPointer(v,2); 11148737fe31SLisandro Dalcin *v = ts->vec_sol; 1115d763cef2SBarry Smith PetscFunctionReturn(0); 1116d763cef2SBarry Smith } 1117d763cef2SBarry Smith 1118bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */ 11194a2ae208SSatish Balay #undef __FUNCT__ 1120bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType" 1121d8e5e3e6SSatish Balay /*@ 1122bdad233fSMatthew Knepley TSSetProblemType - Sets the type of problem to be solved. 1123d763cef2SBarry Smith 1124bdad233fSMatthew Knepley Not collective 1125d763cef2SBarry Smith 1126bdad233fSMatthew Knepley Input Parameters: 1127bdad233fSMatthew Knepley + ts - The TS 1128bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 1129d763cef2SBarry Smith .vb 1130d763cef2SBarry Smith U_t = A U 1131d763cef2SBarry Smith U_t = A(t) U 1132d763cef2SBarry Smith U_t = F(t,U) 1133d763cef2SBarry Smith .ve 1134d763cef2SBarry Smith 1135d763cef2SBarry Smith Level: beginner 1136d763cef2SBarry Smith 1137bdad233fSMatthew Knepley .keywords: TS, problem type 1138bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 1139d763cef2SBarry Smith @*/ 11407087cfbeSBarry Smith PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 1141a7cc72afSBarry Smith { 11429e2a6581SJed Brown PetscErrorCode ierr; 11439e2a6581SJed Brown 1144d763cef2SBarry Smith PetscFunctionBegin; 11450700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1146bdad233fSMatthew Knepley ts->problem_type = type; 11479e2a6581SJed Brown if (type == TS_LINEAR) { 11489e2a6581SJed Brown SNES snes; 11499e2a6581SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 11509e2a6581SJed Brown ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr); 11519e2a6581SJed Brown } 1152d763cef2SBarry Smith PetscFunctionReturn(0); 1153d763cef2SBarry Smith } 1154d763cef2SBarry Smith 1155bdad233fSMatthew Knepley #undef __FUNCT__ 1156bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType" 1157bdad233fSMatthew Knepley /*@C 1158bdad233fSMatthew Knepley TSGetProblemType - Gets the type of problem to be solved. 1159bdad233fSMatthew Knepley 1160bdad233fSMatthew Knepley Not collective 1161bdad233fSMatthew Knepley 1162bdad233fSMatthew Knepley Input Parameter: 1163bdad233fSMatthew Knepley . ts - The TS 1164bdad233fSMatthew Knepley 1165bdad233fSMatthew Knepley Output Parameter: 1166bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 1167bdad233fSMatthew Knepley .vb 1168089b2837SJed Brown M U_t = A U 1169089b2837SJed Brown M(t) U_t = A(t) U 1170bdad233fSMatthew Knepley U_t = F(t,U) 1171bdad233fSMatthew Knepley .ve 1172bdad233fSMatthew Knepley 1173bdad233fSMatthew Knepley Level: beginner 1174bdad233fSMatthew Knepley 1175bdad233fSMatthew Knepley .keywords: TS, problem type 1176bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 1177bdad233fSMatthew Knepley @*/ 11787087cfbeSBarry Smith PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 1179a7cc72afSBarry Smith { 1180bdad233fSMatthew Knepley PetscFunctionBegin; 11810700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 11824482741eSBarry Smith PetscValidIntPointer(type,2); 1183bdad233fSMatthew Knepley *type = ts->problem_type; 1184bdad233fSMatthew Knepley PetscFunctionReturn(0); 1185bdad233fSMatthew Knepley } 1186d763cef2SBarry Smith 11874a2ae208SSatish Balay #undef __FUNCT__ 11884a2ae208SSatish Balay #define __FUNCT__ "TSSetUp" 1189d763cef2SBarry Smith /*@ 1190d763cef2SBarry Smith TSSetUp - Sets up the internal data structures for the later use 1191d763cef2SBarry Smith of a timestepper. 1192d763cef2SBarry Smith 1193d763cef2SBarry Smith Collective on TS 1194d763cef2SBarry Smith 1195d763cef2SBarry Smith Input Parameter: 1196d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1197d763cef2SBarry Smith 1198d763cef2SBarry Smith Notes: 1199d763cef2SBarry Smith For basic use of the TS solvers the user need not explicitly call 1200d763cef2SBarry Smith TSSetUp(), since these actions will automatically occur during 1201d763cef2SBarry Smith the call to TSStep(). However, if one wishes to control this 1202d763cef2SBarry Smith phase separately, TSSetUp() should be called after TSCreate() 1203d763cef2SBarry Smith and optional routines of the form TSSetXXX(), but before TSStep(). 1204d763cef2SBarry Smith 1205d763cef2SBarry Smith Level: advanced 1206d763cef2SBarry Smith 1207d763cef2SBarry Smith .keywords: TS, timestep, setup 1208d763cef2SBarry Smith 1209d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy() 1210d763cef2SBarry Smith @*/ 12117087cfbeSBarry Smith PetscErrorCode TSSetUp(TS ts) 1212d763cef2SBarry Smith { 1213dfbe8321SBarry Smith PetscErrorCode ierr; 1214d763cef2SBarry Smith 1215d763cef2SBarry Smith PetscFunctionBegin; 12160700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1217277b19d0SLisandro Dalcin if (ts->setupcalled) PetscFunctionReturn(0); 1218277b19d0SLisandro Dalcin 12197adad957SLisandro Dalcin if (!((PetscObject)ts)->type_name) { 12209596e0b4SJed Brown ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr); 1221d763cef2SBarry Smith } 1222a43b19c4SJed Brown if (ts->exact_final_time == PETSC_DECIDE) ts->exact_final_time = PETSC_FALSE; 1223277b19d0SLisandro Dalcin 1224277b19d0SLisandro Dalcin if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first"); 1225277b19d0SLisandro Dalcin 12261c3436cfSJed Brown ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 12271c3436cfSJed Brown 1228277b19d0SLisandro Dalcin if (ts->ops->setup) { 1229000e7ae3SMatthew Knepley ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr); 1230277b19d0SLisandro Dalcin } 1231277b19d0SLisandro Dalcin 1232277b19d0SLisandro Dalcin ts->setupcalled = PETSC_TRUE; 1233277b19d0SLisandro Dalcin PetscFunctionReturn(0); 1234277b19d0SLisandro Dalcin } 1235277b19d0SLisandro Dalcin 1236277b19d0SLisandro Dalcin #undef __FUNCT__ 1237277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset" 1238277b19d0SLisandro Dalcin /*@ 1239277b19d0SLisandro Dalcin TSReset - Resets a TS context and removes any allocated Vecs and Mats. 1240277b19d0SLisandro Dalcin 1241277b19d0SLisandro Dalcin Collective on TS 1242277b19d0SLisandro Dalcin 1243277b19d0SLisandro Dalcin Input Parameter: 1244277b19d0SLisandro Dalcin . ts - the TS context obtained from TSCreate() 1245277b19d0SLisandro Dalcin 1246277b19d0SLisandro Dalcin Level: beginner 1247277b19d0SLisandro Dalcin 1248277b19d0SLisandro Dalcin .keywords: TS, timestep, reset 1249277b19d0SLisandro Dalcin 1250277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy() 1251277b19d0SLisandro Dalcin @*/ 1252277b19d0SLisandro Dalcin PetscErrorCode TSReset(TS ts) 1253277b19d0SLisandro Dalcin { 1254277b19d0SLisandro Dalcin PetscErrorCode ierr; 1255277b19d0SLisandro Dalcin 1256277b19d0SLisandro Dalcin PetscFunctionBegin; 1257277b19d0SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1258277b19d0SLisandro Dalcin if (ts->ops->reset) { 1259277b19d0SLisandro Dalcin ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr); 1260277b19d0SLisandro Dalcin } 1261277b19d0SLisandro Dalcin if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);} 12624e684422SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 12634e684422SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1264214bc6a2SJed Brown ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr); 12656bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 126638637c2eSJed Brown ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr); 1267277b19d0SLisandro Dalcin ts->setupcalled = PETSC_FALSE; 1268d763cef2SBarry Smith PetscFunctionReturn(0); 1269d763cef2SBarry Smith } 1270d763cef2SBarry Smith 12714a2ae208SSatish Balay #undef __FUNCT__ 12724a2ae208SSatish Balay #define __FUNCT__ "TSDestroy" 1273d8e5e3e6SSatish Balay /*@ 1274d763cef2SBarry Smith TSDestroy - Destroys the timestepper context that was created 1275d763cef2SBarry Smith with TSCreate(). 1276d763cef2SBarry Smith 1277d763cef2SBarry Smith Collective on TS 1278d763cef2SBarry Smith 1279d763cef2SBarry Smith Input Parameter: 1280d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1281d763cef2SBarry Smith 1282d763cef2SBarry Smith Level: beginner 1283d763cef2SBarry Smith 1284d763cef2SBarry Smith .keywords: TS, timestepper, destroy 1285d763cef2SBarry Smith 1286d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve() 1287d763cef2SBarry Smith @*/ 12886bf464f9SBarry Smith PetscErrorCode TSDestroy(TS *ts) 1289d763cef2SBarry Smith { 12906849ba73SBarry Smith PetscErrorCode ierr; 1291d763cef2SBarry Smith 1292d763cef2SBarry Smith PetscFunctionBegin; 12936bf464f9SBarry Smith if (!*ts) PetscFunctionReturn(0); 12946bf464f9SBarry Smith PetscValidHeaderSpecific((*ts),TS_CLASSID,1); 12956bf464f9SBarry Smith if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);} 1296d763cef2SBarry Smith 12976bf464f9SBarry Smith ierr = TSReset((*ts));CHKERRQ(ierr); 1298277b19d0SLisandro Dalcin 1299be0abb6dSBarry Smith /* if memory was published with AMS then destroy it */ 13006bf464f9SBarry Smith ierr = PetscObjectDepublish((*ts));CHKERRQ(ierr); 13016bf464f9SBarry Smith if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);} 13026d4c513bSLisandro Dalcin 130384df9cb4SJed Brown ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr); 13046bf464f9SBarry Smith ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr); 13056bf464f9SBarry Smith ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr); 13066bf464f9SBarry Smith ierr = TSMonitorCancel((*ts));CHKERRQ(ierr); 13076d4c513bSLisandro Dalcin 13083b5f76d0SSean Farley ierr = PetscFree((*ts)->userops); 13093b5f76d0SSean Farley 1310a79aaaedSSatish Balay ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr); 1311d763cef2SBarry Smith PetscFunctionReturn(0); 1312d763cef2SBarry Smith } 1313d763cef2SBarry Smith 13144a2ae208SSatish Balay #undef __FUNCT__ 13154a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES" 1316d8e5e3e6SSatish Balay /*@ 1317d763cef2SBarry Smith TSGetSNES - Returns the SNES (nonlinear solver) associated with 1318d763cef2SBarry Smith a TS (timestepper) context. Valid only for nonlinear problems. 1319d763cef2SBarry Smith 1320d763cef2SBarry Smith Not Collective, but SNES is parallel if TS is parallel 1321d763cef2SBarry Smith 1322d763cef2SBarry Smith Input Parameter: 1323d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1324d763cef2SBarry Smith 1325d763cef2SBarry Smith Output Parameter: 1326d763cef2SBarry Smith . snes - the nonlinear solver context 1327d763cef2SBarry Smith 1328d763cef2SBarry Smith Notes: 1329d763cef2SBarry Smith The user can then directly manipulate the SNES context to set various 1330d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 133194b7f48cSBarry Smith KSP, KSP, and PC contexts as well. 1332d763cef2SBarry Smith 1333d763cef2SBarry Smith TSGetSNES() does not work for integrators that do not use SNES; in 1334d763cef2SBarry Smith this case TSGetSNES() returns PETSC_NULL in snes. 1335d763cef2SBarry Smith 1336d763cef2SBarry Smith Level: beginner 1337d763cef2SBarry Smith 1338d763cef2SBarry Smith .keywords: timestep, get, SNES 1339d763cef2SBarry Smith @*/ 13407087cfbeSBarry Smith PetscErrorCode TSGetSNES(TS ts,SNES *snes) 1341d763cef2SBarry Smith { 1342d372ba47SLisandro Dalcin PetscErrorCode ierr; 1343d372ba47SLisandro Dalcin 1344d763cef2SBarry Smith PetscFunctionBegin; 13450700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 13464482741eSBarry Smith PetscValidPointer(snes,2); 1347d372ba47SLisandro Dalcin if (!ts->snes) { 1348d372ba47SLisandro Dalcin ierr = SNESCreate(((PetscObject)ts)->comm,&ts->snes);CHKERRQ(ierr); 1349d372ba47SLisandro Dalcin ierr = PetscLogObjectParent(ts,ts->snes);CHKERRQ(ierr); 1350d372ba47SLisandro Dalcin ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr); 1351496e6a7aSJed Brown if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 13529e2a6581SJed Brown if (ts->problem_type == TS_LINEAR) { 13539e2a6581SJed Brown ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); 13549e2a6581SJed Brown } 1355d372ba47SLisandro Dalcin } 1356d763cef2SBarry Smith *snes = ts->snes; 1357d763cef2SBarry Smith PetscFunctionReturn(0); 1358d763cef2SBarry Smith } 1359d763cef2SBarry Smith 13604a2ae208SSatish Balay #undef __FUNCT__ 136194b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP" 1362d8e5e3e6SSatish Balay /*@ 136394b7f48cSBarry Smith TSGetKSP - Returns the KSP (linear solver) associated with 1364d763cef2SBarry Smith a TS (timestepper) context. 1365d763cef2SBarry Smith 136694b7f48cSBarry Smith Not Collective, but KSP is parallel if TS is parallel 1367d763cef2SBarry Smith 1368d763cef2SBarry Smith Input Parameter: 1369d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1370d763cef2SBarry Smith 1371d763cef2SBarry Smith Output Parameter: 137294b7f48cSBarry Smith . ksp - the nonlinear solver context 1373d763cef2SBarry Smith 1374d763cef2SBarry Smith Notes: 137594b7f48cSBarry Smith The user can then directly manipulate the KSP context to set various 1376d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 1377d763cef2SBarry Smith KSP and PC contexts as well. 1378d763cef2SBarry Smith 137994b7f48cSBarry Smith TSGetKSP() does not work for integrators that do not use KSP; 138094b7f48cSBarry Smith in this case TSGetKSP() returns PETSC_NULL in ksp. 1381d763cef2SBarry Smith 1382d763cef2SBarry Smith Level: beginner 1383d763cef2SBarry Smith 138494b7f48cSBarry Smith .keywords: timestep, get, KSP 1385d763cef2SBarry Smith @*/ 13867087cfbeSBarry Smith PetscErrorCode TSGetKSP(TS ts,KSP *ksp) 1387d763cef2SBarry Smith { 1388d372ba47SLisandro Dalcin PetscErrorCode ierr; 1389089b2837SJed Brown SNES snes; 1390d372ba47SLisandro Dalcin 1391d763cef2SBarry Smith PetscFunctionBegin; 13920700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 13934482741eSBarry Smith PetscValidPointer(ksp,2); 139417186662SBarry Smith if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first"); 1395e32f2f54SBarry Smith if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()"); 1396089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1397089b2837SJed Brown ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr); 1398d763cef2SBarry Smith PetscFunctionReturn(0); 1399d763cef2SBarry Smith } 1400d763cef2SBarry Smith 1401d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */ 1402d763cef2SBarry Smith 14034a2ae208SSatish Balay #undef __FUNCT__ 1404adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration" 1405adb62b0dSMatthew Knepley /*@ 1406adb62b0dSMatthew Knepley TSGetDuration - Gets the maximum number of timesteps to use and 1407adb62b0dSMatthew Knepley maximum time for iteration. 1408adb62b0dSMatthew Knepley 14093f9fe445SBarry Smith Not Collective 1410adb62b0dSMatthew Knepley 1411adb62b0dSMatthew Knepley Input Parameters: 1412adb62b0dSMatthew Knepley + ts - the TS context obtained from TSCreate() 1413adb62b0dSMatthew Knepley . maxsteps - maximum number of iterations to use, or PETSC_NULL 1414adb62b0dSMatthew Knepley - maxtime - final time to iterate to, or PETSC_NULL 1415adb62b0dSMatthew Knepley 1416adb62b0dSMatthew Knepley Level: intermediate 1417adb62b0dSMatthew Knepley 1418adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time 1419adb62b0dSMatthew Knepley @*/ 14207087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 1421adb62b0dSMatthew Knepley { 1422adb62b0dSMatthew Knepley PetscFunctionBegin; 14230700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1424abc0a331SBarry Smith if (maxsteps) { 14254482741eSBarry Smith PetscValidIntPointer(maxsteps,2); 1426adb62b0dSMatthew Knepley *maxsteps = ts->max_steps; 1427adb62b0dSMatthew Knepley } 1428abc0a331SBarry Smith if (maxtime) { 14294482741eSBarry Smith PetscValidScalarPointer(maxtime,3); 1430adb62b0dSMatthew Knepley *maxtime = ts->max_time; 1431adb62b0dSMatthew Knepley } 1432adb62b0dSMatthew Knepley PetscFunctionReturn(0); 1433adb62b0dSMatthew Knepley } 1434adb62b0dSMatthew Knepley 1435adb62b0dSMatthew Knepley #undef __FUNCT__ 14364a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration" 1437d763cef2SBarry Smith /*@ 1438d763cef2SBarry Smith TSSetDuration - Sets the maximum number of timesteps to use and 1439d763cef2SBarry Smith maximum time for iteration. 1440d763cef2SBarry Smith 14413f9fe445SBarry Smith Logically Collective on TS 1442d763cef2SBarry Smith 1443d763cef2SBarry Smith Input Parameters: 1444d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1445d763cef2SBarry Smith . maxsteps - maximum number of iterations to use 1446d763cef2SBarry Smith - maxtime - final time to iterate to 1447d763cef2SBarry Smith 1448d763cef2SBarry Smith Options Database Keys: 1449d763cef2SBarry Smith . -ts_max_steps <maxsteps> - Sets maxsteps 14503bca7d26SBarry Smith . -ts_final_time <maxtime> - Sets maxtime 1451d763cef2SBarry Smith 1452d763cef2SBarry Smith Notes: 1453d763cef2SBarry Smith The default maximum number of iterations is 5000. Default time is 5.0 1454d763cef2SBarry Smith 1455d763cef2SBarry Smith Level: intermediate 1456d763cef2SBarry Smith 1457d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations 1458a43b19c4SJed Brown 1459a43b19c4SJed Brown .seealso: TSSetExactFinalTime() 1460d763cef2SBarry Smith @*/ 14617087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime) 1462d763cef2SBarry Smith { 1463d763cef2SBarry Smith PetscFunctionBegin; 14640700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1465c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(ts,maxsteps,2); 1466c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,maxtime,2); 146739b7ec4bSSean Farley if (maxsteps >= 0) ts->max_steps = maxsteps; 146839b7ec4bSSean Farley if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime; 1469d763cef2SBarry Smith PetscFunctionReturn(0); 1470d763cef2SBarry Smith } 1471d763cef2SBarry Smith 14724a2ae208SSatish Balay #undef __FUNCT__ 14734a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution" 1474d763cef2SBarry Smith /*@ 1475d763cef2SBarry Smith TSSetSolution - Sets the initial solution vector 1476d763cef2SBarry Smith for use by the TS routines. 1477d763cef2SBarry Smith 14783f9fe445SBarry Smith Logically Collective on TS and Vec 1479d763cef2SBarry Smith 1480d763cef2SBarry Smith Input Parameters: 1481d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1482d763cef2SBarry Smith - x - the solution vector 1483d763cef2SBarry Smith 1484d763cef2SBarry Smith Level: beginner 1485d763cef2SBarry Smith 1486d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions 1487d763cef2SBarry Smith @*/ 14887087cfbeSBarry Smith PetscErrorCode TSSetSolution(TS ts,Vec x) 1489d763cef2SBarry Smith { 14908737fe31SLisandro Dalcin PetscErrorCode ierr; 1491496e6a7aSJed Brown DM dm; 14928737fe31SLisandro Dalcin 1493d763cef2SBarry Smith PetscFunctionBegin; 14940700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 14950700a824SBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,2); 14968737fe31SLisandro Dalcin ierr = PetscObjectReference((PetscObject)x);CHKERRQ(ierr); 14976bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 14988737fe31SLisandro Dalcin ts->vec_sol = x; 1499496e6a7aSJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1500496e6a7aSJed Brown ierr = DMShellSetGlobalVector(dm,x);CHKERRQ(ierr); 1501d763cef2SBarry Smith PetscFunctionReturn(0); 1502d763cef2SBarry Smith } 1503d763cef2SBarry Smith 1504e74ef692SMatthew Knepley #undef __FUNCT__ 1505e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep" 1506ac226902SBarry Smith /*@C 1507000e7ae3SMatthew Knepley TSSetPreStep - Sets the general-purpose function 15083f2090d5SJed Brown called once at the beginning of each time step. 1509000e7ae3SMatthew Knepley 15103f9fe445SBarry Smith Logically Collective on TS 1511000e7ae3SMatthew Knepley 1512000e7ae3SMatthew Knepley Input Parameters: 1513000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 1514000e7ae3SMatthew Knepley - func - The function 1515000e7ae3SMatthew Knepley 1516000e7ae3SMatthew Knepley Calling sequence of func: 1517000e7ae3SMatthew Knepley . func (TS ts); 1518000e7ae3SMatthew Knepley 1519000e7ae3SMatthew Knepley Level: intermediate 1520000e7ae3SMatthew Knepley 1521000e7ae3SMatthew Knepley .keywords: TS, timestep 1522000e7ae3SMatthew Knepley @*/ 15237087cfbeSBarry Smith PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS)) 1524000e7ae3SMatthew Knepley { 1525000e7ae3SMatthew Knepley PetscFunctionBegin; 15260700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1527000e7ae3SMatthew Knepley ts->ops->prestep = func; 1528000e7ae3SMatthew Knepley PetscFunctionReturn(0); 1529000e7ae3SMatthew Knepley } 1530000e7ae3SMatthew Knepley 1531e74ef692SMatthew Knepley #undef __FUNCT__ 15323f2090d5SJed Brown #define __FUNCT__ "TSPreStep" 153309ee8438SJed Brown /*@ 15343f2090d5SJed Brown TSPreStep - Runs the user-defined pre-step function. 15353f2090d5SJed Brown 15363f2090d5SJed Brown Collective on TS 15373f2090d5SJed Brown 15383f2090d5SJed Brown Input Parameters: 15393f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 15403f2090d5SJed Brown 15413f2090d5SJed Brown Notes: 15423f2090d5SJed Brown TSPreStep() is typically used within time stepping implementations, 15433f2090d5SJed Brown so most users would not generally call this routine themselves. 15443f2090d5SJed Brown 15453f2090d5SJed Brown Level: developer 15463f2090d5SJed Brown 15473f2090d5SJed Brown .keywords: TS, timestep 15483f2090d5SJed Brown @*/ 15497087cfbeSBarry Smith PetscErrorCode TSPreStep(TS ts) 15503f2090d5SJed Brown { 15513f2090d5SJed Brown PetscErrorCode ierr; 15523f2090d5SJed Brown 15533f2090d5SJed Brown PetscFunctionBegin; 15540700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 155572ac3e02SJed Brown if (ts->ops->prestep) { 15563f2090d5SJed Brown PetscStackPush("TS PreStep function"); 15573f2090d5SJed Brown ierr = (*ts->ops->prestep)(ts);CHKERRQ(ierr); 15583f2090d5SJed Brown PetscStackPop; 1559312ce896SJed Brown } 15603f2090d5SJed Brown PetscFunctionReturn(0); 15613f2090d5SJed Brown } 15623f2090d5SJed Brown 15633f2090d5SJed Brown #undef __FUNCT__ 1564e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep" 1565ac226902SBarry Smith /*@C 1566000e7ae3SMatthew Knepley TSSetPostStep - Sets the general-purpose function 15673f2090d5SJed Brown called once at the end of each time step. 1568000e7ae3SMatthew Knepley 15693f9fe445SBarry Smith Logically Collective on TS 1570000e7ae3SMatthew Knepley 1571000e7ae3SMatthew Knepley Input Parameters: 1572000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 1573000e7ae3SMatthew Knepley - func - The function 1574000e7ae3SMatthew Knepley 1575000e7ae3SMatthew Knepley Calling sequence of func: 1576000e7ae3SMatthew Knepley . func (TS ts); 1577000e7ae3SMatthew Knepley 1578000e7ae3SMatthew Knepley Level: intermediate 1579000e7ae3SMatthew Knepley 1580000e7ae3SMatthew Knepley .keywords: TS, timestep 1581000e7ae3SMatthew Knepley @*/ 15827087cfbeSBarry Smith PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS)) 1583000e7ae3SMatthew Knepley { 1584000e7ae3SMatthew Knepley PetscFunctionBegin; 15850700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1586000e7ae3SMatthew Knepley ts->ops->poststep = func; 1587000e7ae3SMatthew Knepley PetscFunctionReturn(0); 1588000e7ae3SMatthew Knepley } 1589000e7ae3SMatthew Knepley 1590e74ef692SMatthew Knepley #undef __FUNCT__ 15913f2090d5SJed Brown #define __FUNCT__ "TSPostStep" 159209ee8438SJed Brown /*@ 15933f2090d5SJed Brown TSPostStep - Runs the user-defined post-step function. 15943f2090d5SJed Brown 15953f2090d5SJed Brown Collective on TS 15963f2090d5SJed Brown 15973f2090d5SJed Brown Input Parameters: 15983f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 15993f2090d5SJed Brown 16003f2090d5SJed Brown Notes: 16013f2090d5SJed Brown TSPostStep() is typically used within time stepping implementations, 16023f2090d5SJed Brown so most users would not generally call this routine themselves. 16033f2090d5SJed Brown 16043f2090d5SJed Brown Level: developer 16053f2090d5SJed Brown 16063f2090d5SJed Brown .keywords: TS, timestep 16073f2090d5SJed Brown @*/ 16087087cfbeSBarry Smith PetscErrorCode TSPostStep(TS ts) 16093f2090d5SJed Brown { 16103f2090d5SJed Brown PetscErrorCode ierr; 16113f2090d5SJed Brown 16123f2090d5SJed Brown PetscFunctionBegin; 16130700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 161472ac3e02SJed Brown if (ts->ops->poststep) { 16153f2090d5SJed Brown PetscStackPush("TS PostStep function"); 16163f2090d5SJed Brown ierr = (*ts->ops->poststep)(ts);CHKERRQ(ierr); 16173f2090d5SJed Brown PetscStackPop; 161872ac3e02SJed Brown } 16193f2090d5SJed Brown PetscFunctionReturn(0); 16203f2090d5SJed Brown } 16213f2090d5SJed Brown 1622d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */ 1623d763cef2SBarry Smith 16244a2ae208SSatish Balay #undef __FUNCT__ 1625a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet" 1626d763cef2SBarry Smith /*@C 1627a6570f20SBarry Smith TSMonitorSet - Sets an ADDITIONAL function that is to be used at every 1628d763cef2SBarry Smith timestep to display the iteration's progress. 1629d763cef2SBarry Smith 16303f9fe445SBarry Smith Logically Collective on TS 1631d763cef2SBarry Smith 1632d763cef2SBarry Smith Input Parameters: 1633d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1634e213d8f1SJed Brown . monitor - monitoring routine 1635329f5518SBarry Smith . mctx - [optional] user-defined context for private data for the 1636b3006f0bSLois Curfman McInnes monitor routine (use PETSC_NULL if no context is desired) 1637b3006f0bSLois Curfman McInnes - monitordestroy - [optional] routine that frees monitor context 1638b3006f0bSLois Curfman McInnes (may be PETSC_NULL) 1639d763cef2SBarry Smith 1640e213d8f1SJed Brown Calling sequence of monitor: 1641e213d8f1SJed Brown $ int monitor(TS ts,PetscInt steps,PetscReal time,Vec x,void *mctx) 1642d763cef2SBarry Smith 1643d763cef2SBarry Smith + ts - the TS context 1644d763cef2SBarry Smith . steps - iteration number 16451f06c33eSBarry Smith . time - current time 1646d763cef2SBarry Smith . x - current iterate 1647d763cef2SBarry Smith - mctx - [optional] monitoring context 1648d763cef2SBarry Smith 1649d763cef2SBarry Smith Notes: 1650d763cef2SBarry Smith This routine adds an additional monitor to the list of monitors that 1651d763cef2SBarry Smith already has been loaded. 1652d763cef2SBarry Smith 1653025f1a04SBarry Smith Fortran notes: Only a single monitor function can be set for each TS object 1654025f1a04SBarry Smith 1655d763cef2SBarry Smith Level: intermediate 1656d763cef2SBarry Smith 1657d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 1658d763cef2SBarry Smith 1659a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel() 1660d763cef2SBarry Smith @*/ 1661c2efdce3SBarry Smith PetscErrorCode TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**)) 1662d763cef2SBarry Smith { 1663d763cef2SBarry Smith PetscFunctionBegin; 16640700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 166517186662SBarry Smith if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 1666d763cef2SBarry Smith ts->monitor[ts->numbermonitors] = monitor; 1667329f5518SBarry Smith ts->mdestroy[ts->numbermonitors] = mdestroy; 1668d763cef2SBarry Smith ts->monitorcontext[ts->numbermonitors++] = (void*)mctx; 1669d763cef2SBarry Smith PetscFunctionReturn(0); 1670d763cef2SBarry Smith } 1671d763cef2SBarry Smith 16724a2ae208SSatish Balay #undef __FUNCT__ 1673a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel" 1674d763cef2SBarry Smith /*@C 1675a6570f20SBarry Smith TSMonitorCancel - Clears all the monitors that have been set on a time-step object. 1676d763cef2SBarry Smith 16773f9fe445SBarry Smith Logically Collective on TS 1678d763cef2SBarry Smith 1679d763cef2SBarry Smith Input Parameters: 1680d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1681d763cef2SBarry Smith 1682d763cef2SBarry Smith Notes: 1683d763cef2SBarry Smith There is no way to remove a single, specific monitor. 1684d763cef2SBarry Smith 1685d763cef2SBarry Smith Level: intermediate 1686d763cef2SBarry Smith 1687d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 1688d763cef2SBarry Smith 1689a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet() 1690d763cef2SBarry Smith @*/ 16917087cfbeSBarry Smith PetscErrorCode TSMonitorCancel(TS ts) 1692d763cef2SBarry Smith { 1693d952e501SBarry Smith PetscErrorCode ierr; 1694d952e501SBarry Smith PetscInt i; 1695d952e501SBarry Smith 1696d763cef2SBarry Smith PetscFunctionBegin; 16970700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1698d952e501SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 1699d952e501SBarry Smith if (ts->mdestroy[i]) { 17003c4aec1bSBarry Smith ierr = (*ts->mdestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr); 1701d952e501SBarry Smith } 1702d952e501SBarry Smith } 1703d763cef2SBarry Smith ts->numbermonitors = 0; 1704d763cef2SBarry Smith PetscFunctionReturn(0); 1705d763cef2SBarry Smith } 1706d763cef2SBarry Smith 17074a2ae208SSatish Balay #undef __FUNCT__ 1708a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault" 1709d8e5e3e6SSatish Balay /*@ 1710a6570f20SBarry Smith TSMonitorDefault - Sets the Default monitor 17115516499fSSatish Balay 17125516499fSSatish Balay Level: intermediate 171341251cbbSSatish Balay 17145516499fSSatish Balay .keywords: TS, set, monitor 17155516499fSSatish Balay 171641251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet() 171741251cbbSSatish Balay @*/ 1718649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy) 1719d763cef2SBarry Smith { 1720dfbe8321SBarry Smith PetscErrorCode ierr; 1721649052a6SBarry Smith PetscViewer viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(((PetscObject)ts)->comm); 1722d132466eSBarry Smith 1723d763cef2SBarry Smith PetscFunctionBegin; 1724649052a6SBarry Smith ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 1725971832b6SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g\n",step,(double)ts->time_step,(double)ptime);CHKERRQ(ierr); 1726649052a6SBarry Smith ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 1727d763cef2SBarry Smith PetscFunctionReturn(0); 1728d763cef2SBarry Smith } 1729d763cef2SBarry Smith 17304a2ae208SSatish Balay #undef __FUNCT__ 1731cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages" 1732cd652676SJed Brown /*@ 1733cd652676SJed Brown TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available. 1734cd652676SJed Brown 1735cd652676SJed Brown Logically Collective on TS 1736cd652676SJed Brown 1737cd652676SJed Brown Input Argument: 1738cd652676SJed Brown . ts - time stepping context 1739cd652676SJed Brown 1740cd652676SJed Brown Output Argument: 1741cd652676SJed Brown . flg - PETSC_TRUE or PETSC_FALSE 1742cd652676SJed Brown 1743cd652676SJed Brown Level: intermediate 1744cd652676SJed Brown 1745cd652676SJed Brown .keywords: TS, set 1746cd652676SJed Brown 1747cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep() 1748cd652676SJed Brown @*/ 1749cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg) 1750cd652676SJed Brown { 1751cd652676SJed Brown 1752cd652676SJed Brown PetscFunctionBegin; 1753cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1754cd652676SJed Brown ts->retain_stages = flg; 1755cd652676SJed Brown PetscFunctionReturn(0); 1756cd652676SJed Brown } 1757cd652676SJed Brown 1758cd652676SJed Brown #undef __FUNCT__ 1759cd652676SJed Brown #define __FUNCT__ "TSInterpolate" 1760cd652676SJed Brown /*@ 1761cd652676SJed Brown TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval 1762cd652676SJed Brown 1763cd652676SJed Brown Collective on TS 1764cd652676SJed Brown 1765cd652676SJed Brown Input Argument: 1766cd652676SJed Brown + ts - time stepping context 1767cd652676SJed Brown - t - time to interpolate to 1768cd652676SJed Brown 1769cd652676SJed Brown Output Argument: 1770cd652676SJed Brown . X - state at given time 1771cd652676SJed Brown 1772cd652676SJed Brown Notes: 1773cd652676SJed Brown The user should call TSSetRetainStages() before taking a step in which interpolation will be requested. 1774cd652676SJed Brown 1775cd652676SJed Brown Level: intermediate 1776cd652676SJed Brown 1777cd652676SJed Brown Developer Notes: 1778cd652676SJed Brown TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints. 1779cd652676SJed Brown 1780cd652676SJed Brown .keywords: TS, set 1781cd652676SJed Brown 1782cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep() 1783cd652676SJed Brown @*/ 1784cd652676SJed Brown PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec X) 1785cd652676SJed Brown { 1786cd652676SJed Brown PetscErrorCode ierr; 1787cd652676SJed Brown 1788cd652676SJed Brown PetscFunctionBegin; 1789cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1790d8cd7023SBarry 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); 1791cd652676SJed Brown if (!ts->ops->interpolate) SETERRQ1(((PetscObject)ts)->comm,PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name); 1792cd652676SJed Brown ierr = (*ts->ops->interpolate)(ts,t,X);CHKERRQ(ierr); 1793cd652676SJed Brown PetscFunctionReturn(0); 1794cd652676SJed Brown } 1795cd652676SJed Brown 1796cd652676SJed Brown #undef __FUNCT__ 17974a2ae208SSatish Balay #define __FUNCT__ "TSStep" 1798d763cef2SBarry Smith /*@ 17996d9e5789SSean Farley TSStep - Steps one time step 1800d763cef2SBarry Smith 1801d763cef2SBarry Smith Collective on TS 1802d763cef2SBarry Smith 1803d763cef2SBarry Smith Input Parameter: 1804d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1805d763cef2SBarry Smith 18066d9e5789SSean Farley Level: intermediate 1807d763cef2SBarry Smith 1808d763cef2SBarry Smith .keywords: TS, timestep, solve 1809d763cef2SBarry Smith 18106d9e5789SSean Farley .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve() 1811d763cef2SBarry Smith @*/ 1812193ac0bcSJed Brown PetscErrorCode TSStep(TS ts) 1813d763cef2SBarry Smith { 1814362cd11cSLisandro Dalcin PetscReal ptime_prev; 1815dfbe8321SBarry Smith PetscErrorCode ierr; 1816d763cef2SBarry Smith 1817d763cef2SBarry Smith PetscFunctionBegin; 18180700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1819d405a339SMatthew Knepley ierr = TSSetUp(ts);CHKERRQ(ierr); 1820d405a339SMatthew Knepley 1821362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_ITERATING; 1822362cd11cSLisandro Dalcin 1823362cd11cSLisandro Dalcin ptime_prev = ts->ptime; 1824d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 1825193ac0bcSJed Brown ierr = (*ts->ops->step)(ts);CHKERRQ(ierr); 1826d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 1827362cd11cSLisandro Dalcin ts->time_step_prev = ts->ptime - ptime_prev; 1828362cd11cSLisandro Dalcin 1829362cd11cSLisandro Dalcin if (ts->reason < 0) { 1830f1b97656SJed Brown if (ts->errorifstepfailed) SETERRQ1(((PetscObject)ts)->comm,PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 1831362cd11cSLisandro Dalcin } else if (!ts->reason) { 1832362cd11cSLisandro Dalcin if (ts->steps >= ts->max_steps) 1833362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_ITS; 1834362cd11cSLisandro Dalcin else if (ts->ptime >= ts->max_time) 1835362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_TIME; 1836362cd11cSLisandro Dalcin } 1837362cd11cSLisandro Dalcin 1838d763cef2SBarry Smith PetscFunctionReturn(0); 1839d763cef2SBarry Smith } 1840d763cef2SBarry Smith 18414a2ae208SSatish Balay #undef __FUNCT__ 184205175c85SJed Brown #define __FUNCT__ "TSEvaluateStep" 184305175c85SJed Brown /*@ 184405175c85SJed Brown TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy. 184505175c85SJed Brown 18461c3436cfSJed Brown Collective on TS 184705175c85SJed Brown 184805175c85SJed Brown Input Arguments: 18491c3436cfSJed Brown + ts - time stepping context 18501c3436cfSJed Brown . order - desired order of accuracy 18511c3436cfSJed Brown - done - whether the step was evaluated at this order (pass PETSC_NULL to generate an error if not available) 185205175c85SJed Brown 185305175c85SJed Brown Output Arguments: 18541c3436cfSJed Brown . X - state at the end of the current step 185505175c85SJed Brown 185605175c85SJed Brown Level: advanced 185705175c85SJed Brown 1858108c343cSJed Brown Notes: 1859108c343cSJed Brown This function cannot be called until all stages have been evaluated. 1860108c343cSJed 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. 1861108c343cSJed Brown 18621c3436cfSJed Brown .seealso: TSStep(), TSAdapt 186305175c85SJed Brown @*/ 18641c3436cfSJed Brown PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec X,PetscBool *done) 186505175c85SJed Brown { 186605175c85SJed Brown PetscErrorCode ierr; 186705175c85SJed Brown 186805175c85SJed Brown PetscFunctionBegin; 186905175c85SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 187005175c85SJed Brown PetscValidType(ts,1); 187105175c85SJed Brown PetscValidHeaderSpecific(X,VEC_CLASSID,3); 18721c3436cfSJed Brown if (!ts->ops->evaluatestep) SETERRQ1(((PetscObject)ts)->comm,PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name); 18731c3436cfSJed Brown ierr = (*ts->ops->evaluatestep)(ts,order,X,done);CHKERRQ(ierr); 187405175c85SJed Brown PetscFunctionReturn(0); 187505175c85SJed Brown } 187605175c85SJed Brown 187705175c85SJed Brown #undef __FUNCT__ 18786a4d4014SLisandro Dalcin #define __FUNCT__ "TSSolve" 18796a4d4014SLisandro Dalcin /*@ 18806a4d4014SLisandro Dalcin TSSolve - Steps the requested number of timesteps. 18816a4d4014SLisandro Dalcin 18826a4d4014SLisandro Dalcin Collective on TS 18836a4d4014SLisandro Dalcin 18846a4d4014SLisandro Dalcin Input Parameter: 18856a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 1886362cd11cSLisandro Dalcin - x - the solution vector 18876a4d4014SLisandro Dalcin 18885a3a76d0SJed Brown Output Parameter: 18895a3a76d0SJed Brown . ftime - time of the state vector x upon completion 18905a3a76d0SJed Brown 18916a4d4014SLisandro Dalcin Level: beginner 18926a4d4014SLisandro Dalcin 18935a3a76d0SJed Brown Notes: 18945a3a76d0SJed Brown The final time returned by this function may be different from the time of the internally 18955a3a76d0SJed Brown held state accessible by TSGetSolution() and TSGetTime() because the method may have 18965a3a76d0SJed Brown stepped over the final time. 18975a3a76d0SJed Brown 18986a4d4014SLisandro Dalcin .keywords: TS, timestep, solve 18996a4d4014SLisandro Dalcin 19006a4d4014SLisandro Dalcin .seealso: TSCreate(), TSSetSolution(), TSStep() 19016a4d4014SLisandro Dalcin @*/ 19025a3a76d0SJed Brown PetscErrorCode TSSolve(TS ts,Vec x,PetscReal *ftime) 19036a4d4014SLisandro Dalcin { 19044d7d938eSLisandro Dalcin PetscBool flg; 19054d7d938eSLisandro Dalcin char filename[PETSC_MAX_PATH_LEN]; 19064d7d938eSLisandro Dalcin PetscViewer viewer; 19076a4d4014SLisandro Dalcin PetscErrorCode ierr; 1908f22f69f0SBarry Smith 19096a4d4014SLisandro Dalcin PetscFunctionBegin; 19100700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1911193ac0bcSJed Brown PetscValidHeaderSpecific(x,VEC_CLASSID,2); 19125a3a76d0SJed Brown if (ts->exact_final_time) { /* Need ts->vec_sol to be distinct so it is not overwritten when we interpolate at the end */ 19135a3a76d0SJed Brown if (!ts->vec_sol || x == ts->vec_sol) { 19145a3a76d0SJed Brown Vec y; 19155a3a76d0SJed Brown ierr = VecDuplicate(x,&y);CHKERRQ(ierr); 19165a3a76d0SJed Brown ierr = TSSetSolution(ts,y);CHKERRQ(ierr); 19175a3a76d0SJed Brown ierr = VecDestroy(&y);CHKERRQ(ierr); /* grant ownership */ 19185a3a76d0SJed Brown } 1919362cd11cSLisandro Dalcin ierr = VecCopy(x,ts->vec_sol);CHKERRQ(ierr); 19205a3a76d0SJed Brown } else { 1921193ac0bcSJed Brown ierr = TSSetSolution(ts,x);CHKERRQ(ierr); 19225a3a76d0SJed Brown } 1923b5d403baSSean Farley ierr = TSSetUp(ts);CHKERRQ(ierr); 19246a4d4014SLisandro Dalcin /* reset time step and iteration counters */ 1925193ac0bcSJed Brown ts->steps = 0; 1926193ac0bcSJed Brown ts->linear_its = 0; 1927193ac0bcSJed Brown ts->nonlinear_its = 0; 1928c610991cSLisandro Dalcin ts->num_snes_failures = 0; 1929c610991cSLisandro Dalcin ts->reject = 0; 1930193ac0bcSJed Brown ts->reason = TS_CONVERGED_ITERATING; 1931193ac0bcSJed Brown 1932193ac0bcSJed Brown if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 1933193ac0bcSJed Brown ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr); 19345a3a76d0SJed Brown ierr = VecCopy(ts->vec_sol,x);CHKERRQ(ierr); 1935a5b82c69SSean Farley if (ftime) *ftime = ts->ptime; 1936193ac0bcSJed Brown } else { 19376a4d4014SLisandro Dalcin /* steps the requested number of timesteps. */ 1938362cd11cSLisandro Dalcin ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 1939362cd11cSLisandro Dalcin if (ts->steps >= ts->max_steps) 1940362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_ITS; 1941362cd11cSLisandro Dalcin else if (ts->ptime >= ts->max_time) 1942362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_TIME; 1943e1a7a14fSJed Brown while (!ts->reason) { 1944193ac0bcSJed Brown ierr = TSPreStep(ts);CHKERRQ(ierr); 1945193ac0bcSJed Brown ierr = TSStep(ts);CHKERRQ(ierr); 1946193ac0bcSJed Brown ierr = TSPostStep(ts);CHKERRQ(ierr); 1947193ac0bcSJed Brown ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 1948193ac0bcSJed Brown } 1949362cd11cSLisandro Dalcin if (ts->exact_final_time && ts->ptime > ts->max_time) { 1950a43b19c4SJed Brown ierr = TSInterpolate(ts,ts->max_time,x);CHKERRQ(ierr); 19515a3a76d0SJed Brown if (ftime) *ftime = ts->max_time; 19520574a7fbSJed Brown } else { 19530574a7fbSJed Brown ierr = VecCopy(ts->vec_sol,x);CHKERRQ(ierr); 19540574a7fbSJed Brown if (ftime) *ftime = ts->ptime; 19550574a7fbSJed Brown } 1956193ac0bcSJed Brown } 19574d7d938eSLisandro Dalcin ierr = PetscOptionsGetString(((PetscObject)ts)->prefix,"-ts_view",filename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 19584d7d938eSLisandro Dalcin if (flg && !PetscPreLoadingOn) { 19594d7d938eSLisandro Dalcin ierr = PetscViewerASCIIOpen(((PetscObject)ts)->comm,filename,&viewer);CHKERRQ(ierr); 19604d7d938eSLisandro Dalcin ierr = TSView(ts,viewer);CHKERRQ(ierr); 19614d7d938eSLisandro Dalcin ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 1962193ac0bcSJed Brown } 19636a4d4014SLisandro Dalcin PetscFunctionReturn(0); 19646a4d4014SLisandro Dalcin } 19656a4d4014SLisandro Dalcin 19666a4d4014SLisandro Dalcin #undef __FUNCT__ 19674a2ae208SSatish Balay #define __FUNCT__ "TSMonitor" 1968228d79bcSJed Brown /*@ 1969228d79bcSJed Brown TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet() 1970228d79bcSJed Brown 1971228d79bcSJed Brown Collective on TS 1972228d79bcSJed Brown 1973228d79bcSJed Brown Input Parameters: 1974228d79bcSJed Brown + ts - time stepping context obtained from TSCreate() 1975228d79bcSJed Brown . step - step number that has just completed 1976228d79bcSJed Brown . ptime - model time of the state 1977228d79bcSJed Brown - x - state at the current model time 1978228d79bcSJed Brown 1979228d79bcSJed Brown Notes: 1980228d79bcSJed Brown TSMonitor() is typically used within the time stepping implementations. 1981228d79bcSJed Brown Users might call this function when using the TSStep() interface instead of TSSolve(). 1982228d79bcSJed Brown 1983228d79bcSJed Brown Level: advanced 1984228d79bcSJed Brown 1985228d79bcSJed Brown .keywords: TS, timestep 1986228d79bcSJed Brown @*/ 1987a7cc72afSBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec x) 1988d763cef2SBarry Smith { 19896849ba73SBarry Smith PetscErrorCode ierr; 1990a7cc72afSBarry Smith PetscInt i,n = ts->numbermonitors; 1991d763cef2SBarry Smith 1992d763cef2SBarry Smith PetscFunctionBegin; 1993d763cef2SBarry Smith for (i=0; i<n; i++) { 1994142b95e3SSatish Balay ierr = (*ts->monitor[i])(ts,step,ptime,x,ts->monitorcontext[i]);CHKERRQ(ierr); 1995d763cef2SBarry Smith } 1996d763cef2SBarry Smith PetscFunctionReturn(0); 1997d763cef2SBarry Smith } 1998d763cef2SBarry Smith 1999d763cef2SBarry Smith /* ------------------------------------------------------------------------*/ 2000d763cef2SBarry Smith 20014a2ae208SSatish Balay #undef __FUNCT__ 2002a6570f20SBarry Smith #define __FUNCT__ "TSMonitorLGCreate" 2003d763cef2SBarry Smith /*@C 2004a6570f20SBarry Smith TSMonitorLGCreate - Creates a line graph context for use with 2005d763cef2SBarry Smith TS to monitor convergence of preconditioned residual norms. 2006d763cef2SBarry Smith 2007d763cef2SBarry Smith Collective on TS 2008d763cef2SBarry Smith 2009d763cef2SBarry Smith Input Parameters: 2010d763cef2SBarry Smith + host - the X display to open, or null for the local machine 2011d763cef2SBarry Smith . label - the title to put in the title bar 20127c922b88SBarry Smith . x, y - the screen coordinates of the upper left coordinate of the window 2013d763cef2SBarry Smith - m, n - the screen width and height in pixels 2014d763cef2SBarry Smith 2015d763cef2SBarry Smith Output Parameter: 2016d763cef2SBarry Smith . draw - the drawing context 2017d763cef2SBarry Smith 2018d763cef2SBarry Smith Options Database Key: 2019a6570f20SBarry Smith . -ts_monitor_draw - automatically sets line graph monitor 2020d763cef2SBarry Smith 2021d763cef2SBarry Smith Notes: 2022a6570f20SBarry Smith Use TSMonitorLGDestroy() to destroy this line graph, not PetscDrawLGDestroy(). 2023d763cef2SBarry Smith 2024d763cef2SBarry Smith Level: intermediate 2025d763cef2SBarry Smith 20267c922b88SBarry Smith .keywords: TS, monitor, line graph, residual, seealso 2027d763cef2SBarry Smith 2028a6570f20SBarry Smith .seealso: TSMonitorLGDestroy(), TSMonitorSet() 20297c922b88SBarry Smith 2030d763cef2SBarry Smith @*/ 20317087cfbeSBarry Smith PetscErrorCode TSMonitorLGCreate(const char host[],const char label[],int x,int y,int m,int n,PetscDrawLG *draw) 2032d763cef2SBarry Smith { 2033b0a32e0cSBarry Smith PetscDraw win; 2034dfbe8321SBarry Smith PetscErrorCode ierr; 2035d763cef2SBarry Smith 2036d763cef2SBarry Smith PetscFunctionBegin; 2037b0a32e0cSBarry Smith ierr = PetscDrawCreate(PETSC_COMM_SELF,host,label,x,y,m,n,&win);CHKERRQ(ierr); 2038b0a32e0cSBarry Smith ierr = PetscDrawSetType(win,PETSC_DRAW_X);CHKERRQ(ierr); 2039b0a32e0cSBarry Smith ierr = PetscDrawLGCreate(win,1,draw);CHKERRQ(ierr); 2040b0a32e0cSBarry Smith ierr = PetscDrawLGIndicateDataPoints(*draw);CHKERRQ(ierr); 2041d763cef2SBarry Smith 204252e6d16bSBarry Smith ierr = PetscLogObjectParent(*draw,win);CHKERRQ(ierr); 2043d763cef2SBarry Smith PetscFunctionReturn(0); 2044d763cef2SBarry Smith } 2045d763cef2SBarry Smith 20464a2ae208SSatish Balay #undef __FUNCT__ 2047a6570f20SBarry Smith #define __FUNCT__ "TSMonitorLG" 2048a6570f20SBarry Smith PetscErrorCode TSMonitorLG(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 2049d763cef2SBarry Smith { 2050b0a32e0cSBarry Smith PetscDrawLG lg = (PetscDrawLG) monctx; 205187828ca2SBarry Smith PetscReal x,y = ptime; 2052dfbe8321SBarry Smith PetscErrorCode ierr; 2053d763cef2SBarry Smith 2054d763cef2SBarry Smith PetscFunctionBegin; 20557c922b88SBarry Smith if (!monctx) { 20567c922b88SBarry Smith MPI_Comm comm; 2057b0a32e0cSBarry Smith PetscViewer viewer; 20587c922b88SBarry Smith 20597c922b88SBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 2060b0a32e0cSBarry Smith viewer = PETSC_VIEWER_DRAW_(comm); 2061b0a32e0cSBarry Smith ierr = PetscViewerDrawGetDrawLG(viewer,0,&lg);CHKERRQ(ierr); 20627c922b88SBarry Smith } 20637c922b88SBarry Smith 2064b0a32e0cSBarry Smith if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);} 206587828ca2SBarry Smith x = (PetscReal)n; 2066b0a32e0cSBarry Smith ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr); 2067d763cef2SBarry Smith if (n < 20 || (n % 5)) { 2068b0a32e0cSBarry Smith ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr); 2069d763cef2SBarry Smith } 2070d763cef2SBarry Smith PetscFunctionReturn(0); 2071d763cef2SBarry Smith } 2072d763cef2SBarry Smith 20734a2ae208SSatish Balay #undef __FUNCT__ 2074a6570f20SBarry Smith #define __FUNCT__ "TSMonitorLGDestroy" 2075d763cef2SBarry Smith /*@C 2076a6570f20SBarry Smith TSMonitorLGDestroy - Destroys a line graph context that was created 2077a6570f20SBarry Smith with TSMonitorLGCreate(). 2078d763cef2SBarry Smith 2079b0a32e0cSBarry Smith Collective on PetscDrawLG 2080d763cef2SBarry Smith 2081d763cef2SBarry Smith Input Parameter: 2082d763cef2SBarry Smith . draw - the drawing context 2083d763cef2SBarry Smith 2084d763cef2SBarry Smith Level: intermediate 2085d763cef2SBarry Smith 2086d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy 2087d763cef2SBarry Smith 2088a6570f20SBarry Smith .seealso: TSMonitorLGCreate(), TSMonitorSet(), TSMonitorLG(); 2089d763cef2SBarry Smith @*/ 20906bf464f9SBarry Smith PetscErrorCode TSMonitorLGDestroy(PetscDrawLG *drawlg) 2091d763cef2SBarry Smith { 2092b0a32e0cSBarry Smith PetscDraw draw; 2093dfbe8321SBarry Smith PetscErrorCode ierr; 2094d763cef2SBarry Smith 2095d763cef2SBarry Smith PetscFunctionBegin; 20966bf464f9SBarry Smith ierr = PetscDrawLGGetDraw(*drawlg,&draw);CHKERRQ(ierr); 20976bf464f9SBarry Smith ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 2098b0a32e0cSBarry Smith ierr = PetscDrawLGDestroy(drawlg);CHKERRQ(ierr); 2099d763cef2SBarry Smith PetscFunctionReturn(0); 2100d763cef2SBarry Smith } 2101d763cef2SBarry Smith 21024a2ae208SSatish Balay #undef __FUNCT__ 21034a2ae208SSatish Balay #define __FUNCT__ "TSGetTime" 2104d763cef2SBarry Smith /*@ 2105d763cef2SBarry Smith TSGetTime - Gets the current time. 2106d763cef2SBarry Smith 2107d763cef2SBarry Smith Not Collective 2108d763cef2SBarry Smith 2109d763cef2SBarry Smith Input Parameter: 2110d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2111d763cef2SBarry Smith 2112d763cef2SBarry Smith Output Parameter: 2113d763cef2SBarry Smith . t - the current time 2114d763cef2SBarry Smith 2115d763cef2SBarry Smith Level: beginner 2116d763cef2SBarry Smith 2117d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 2118d763cef2SBarry Smith 2119d763cef2SBarry Smith .keywords: TS, get, time 2120d763cef2SBarry Smith @*/ 21217087cfbeSBarry Smith PetscErrorCode TSGetTime(TS ts,PetscReal* t) 2122d763cef2SBarry Smith { 2123d763cef2SBarry Smith PetscFunctionBegin; 21240700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 21254482741eSBarry Smith PetscValidDoublePointer(t,2); 2126d763cef2SBarry Smith *t = ts->ptime; 2127d763cef2SBarry Smith PetscFunctionReturn(0); 2128d763cef2SBarry Smith } 2129d763cef2SBarry Smith 21304a2ae208SSatish Balay #undef __FUNCT__ 21316a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime" 21326a4d4014SLisandro Dalcin /*@ 21336a4d4014SLisandro Dalcin TSSetTime - Allows one to reset the time. 21346a4d4014SLisandro Dalcin 21353f9fe445SBarry Smith Logically Collective on TS 21366a4d4014SLisandro Dalcin 21376a4d4014SLisandro Dalcin Input Parameters: 21386a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 21396a4d4014SLisandro Dalcin - time - the time 21406a4d4014SLisandro Dalcin 21416a4d4014SLisandro Dalcin Level: intermediate 21426a4d4014SLisandro Dalcin 21436a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration() 21446a4d4014SLisandro Dalcin 21456a4d4014SLisandro Dalcin .keywords: TS, set, time 21466a4d4014SLisandro Dalcin @*/ 21477087cfbeSBarry Smith PetscErrorCode TSSetTime(TS ts, PetscReal t) 21486a4d4014SLisandro Dalcin { 21496a4d4014SLisandro Dalcin PetscFunctionBegin; 21500700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2151c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,t,2); 21526a4d4014SLisandro Dalcin ts->ptime = t; 21536a4d4014SLisandro Dalcin PetscFunctionReturn(0); 21546a4d4014SLisandro Dalcin } 21556a4d4014SLisandro Dalcin 21566a4d4014SLisandro Dalcin #undef __FUNCT__ 21574a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix" 2158d763cef2SBarry Smith /*@C 2159d763cef2SBarry Smith TSSetOptionsPrefix - Sets the prefix used for searching for all 2160d763cef2SBarry Smith TS options in the database. 2161d763cef2SBarry Smith 21623f9fe445SBarry Smith Logically Collective on TS 2163d763cef2SBarry Smith 2164d763cef2SBarry Smith Input Parameter: 2165d763cef2SBarry Smith + ts - The TS context 2166d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 2167d763cef2SBarry Smith 2168d763cef2SBarry Smith Notes: 2169d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 2170d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 2171d763cef2SBarry Smith hyphen. 2172d763cef2SBarry Smith 2173d763cef2SBarry Smith Level: advanced 2174d763cef2SBarry Smith 2175d763cef2SBarry Smith .keywords: TS, set, options, prefix, database 2176d763cef2SBarry Smith 2177d763cef2SBarry Smith .seealso: TSSetFromOptions() 2178d763cef2SBarry Smith 2179d763cef2SBarry Smith @*/ 21807087cfbeSBarry Smith PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[]) 2181d763cef2SBarry Smith { 2182dfbe8321SBarry Smith PetscErrorCode ierr; 2183089b2837SJed Brown SNES snes; 2184d763cef2SBarry Smith 2185d763cef2SBarry Smith PetscFunctionBegin; 21860700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2187d763cef2SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 2188089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2189089b2837SJed Brown ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr); 2190d763cef2SBarry Smith PetscFunctionReturn(0); 2191d763cef2SBarry Smith } 2192d763cef2SBarry Smith 2193d763cef2SBarry Smith 21944a2ae208SSatish Balay #undef __FUNCT__ 21954a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix" 2196d763cef2SBarry Smith /*@C 2197d763cef2SBarry Smith TSAppendOptionsPrefix - Appends to the prefix used for searching for all 2198d763cef2SBarry Smith TS options in the database. 2199d763cef2SBarry Smith 22003f9fe445SBarry Smith Logically Collective on TS 2201d763cef2SBarry Smith 2202d763cef2SBarry Smith Input Parameter: 2203d763cef2SBarry Smith + ts - The TS context 2204d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 2205d763cef2SBarry Smith 2206d763cef2SBarry Smith Notes: 2207d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 2208d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 2209d763cef2SBarry Smith hyphen. 2210d763cef2SBarry Smith 2211d763cef2SBarry Smith Level: advanced 2212d763cef2SBarry Smith 2213d763cef2SBarry Smith .keywords: TS, append, options, prefix, database 2214d763cef2SBarry Smith 2215d763cef2SBarry Smith .seealso: TSGetOptionsPrefix() 2216d763cef2SBarry Smith 2217d763cef2SBarry Smith @*/ 22187087cfbeSBarry Smith PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[]) 2219d763cef2SBarry Smith { 2220dfbe8321SBarry Smith PetscErrorCode ierr; 2221089b2837SJed Brown SNES snes; 2222d763cef2SBarry Smith 2223d763cef2SBarry Smith PetscFunctionBegin; 22240700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2225d763cef2SBarry Smith ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 2226089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2227089b2837SJed Brown ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr); 2228d763cef2SBarry Smith PetscFunctionReturn(0); 2229d763cef2SBarry Smith } 2230d763cef2SBarry Smith 22314a2ae208SSatish Balay #undef __FUNCT__ 22324a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix" 2233d763cef2SBarry Smith /*@C 2234d763cef2SBarry Smith TSGetOptionsPrefix - Sets the prefix used for searching for all 2235d763cef2SBarry Smith TS options in the database. 2236d763cef2SBarry Smith 2237d763cef2SBarry Smith Not Collective 2238d763cef2SBarry Smith 2239d763cef2SBarry Smith Input Parameter: 2240d763cef2SBarry Smith . ts - The TS context 2241d763cef2SBarry Smith 2242d763cef2SBarry Smith Output Parameter: 2243d763cef2SBarry Smith . prefix - A pointer to the prefix string used 2244d763cef2SBarry Smith 2245d763cef2SBarry Smith Notes: On the fortran side, the user should pass in a string 'prifix' of 2246d763cef2SBarry Smith sufficient length to hold the prefix. 2247d763cef2SBarry Smith 2248d763cef2SBarry Smith Level: intermediate 2249d763cef2SBarry Smith 2250d763cef2SBarry Smith .keywords: TS, get, options, prefix, database 2251d763cef2SBarry Smith 2252d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix() 2253d763cef2SBarry Smith @*/ 22547087cfbeSBarry Smith PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[]) 2255d763cef2SBarry Smith { 2256dfbe8321SBarry Smith PetscErrorCode ierr; 2257d763cef2SBarry Smith 2258d763cef2SBarry Smith PetscFunctionBegin; 22590700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 22604482741eSBarry Smith PetscValidPointer(prefix,2); 2261d763cef2SBarry Smith ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 2262d763cef2SBarry Smith PetscFunctionReturn(0); 2263d763cef2SBarry Smith } 2264d763cef2SBarry Smith 22654a2ae208SSatish Balay #undef __FUNCT__ 22664a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian" 2267d763cef2SBarry Smith /*@C 2268d763cef2SBarry Smith TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 2269d763cef2SBarry Smith 2270d763cef2SBarry Smith Not Collective, but parallel objects are returned if TS is parallel 2271d763cef2SBarry Smith 2272d763cef2SBarry Smith Input Parameter: 2273d763cef2SBarry Smith . ts - The TS context obtained from TSCreate() 2274d763cef2SBarry Smith 2275d763cef2SBarry Smith Output Parameters: 2276d763cef2SBarry Smith + J - The Jacobian J of F, where U_t = F(U,t) 2277d763cef2SBarry Smith . M - The preconditioner matrix, usually the same as J 2278089b2837SJed Brown . func - Function to compute the Jacobian of the RHS 2279d763cef2SBarry Smith - ctx - User-defined context for Jacobian evaluation routine 2280d763cef2SBarry Smith 2281d763cef2SBarry Smith Notes: You can pass in PETSC_NULL for any return argument you do not need. 2282d763cef2SBarry Smith 2283d763cef2SBarry Smith Level: intermediate 2284d763cef2SBarry Smith 228526d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 2286d763cef2SBarry Smith 2287d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian 2288d763cef2SBarry Smith @*/ 2289089b2837SJed Brown PetscErrorCode TSGetRHSJacobian(TS ts,Mat *J,Mat *M,TSRHSJacobian *func,void **ctx) 2290d763cef2SBarry Smith { 2291089b2837SJed Brown PetscErrorCode ierr; 2292089b2837SJed Brown SNES snes; 2293089b2837SJed Brown 2294d763cef2SBarry Smith PetscFunctionBegin; 2295089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2296089b2837SJed Brown ierr = SNESGetJacobian(snes,J,M,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 22973b5f76d0SSean Farley if (func) *func = ts->userops->rhsjacobian; 229826d46c62SHong Zhang if (ctx) *ctx = ts->jacP; 2299d763cef2SBarry Smith PetscFunctionReturn(0); 2300d763cef2SBarry Smith } 2301d763cef2SBarry Smith 23021713a123SBarry Smith #undef __FUNCT__ 23032eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian" 23042eca1d9cSJed Brown /*@C 23052eca1d9cSJed Brown TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 23062eca1d9cSJed Brown 23072eca1d9cSJed Brown Not Collective, but parallel objects are returned if TS is parallel 23082eca1d9cSJed Brown 23092eca1d9cSJed Brown Input Parameter: 23102eca1d9cSJed Brown . ts - The TS context obtained from TSCreate() 23112eca1d9cSJed Brown 23122eca1d9cSJed Brown Output Parameters: 23132eca1d9cSJed Brown + A - The Jacobian of F(t,U,U_t) 23142eca1d9cSJed Brown . B - The preconditioner matrix, often the same as A 23152eca1d9cSJed Brown . f - The function to compute the matrices 23162eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine 23172eca1d9cSJed Brown 23182eca1d9cSJed Brown Notes: You can pass in PETSC_NULL for any return argument you do not need. 23192eca1d9cSJed Brown 23202eca1d9cSJed Brown Level: advanced 23212eca1d9cSJed Brown 23222eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 23232eca1d9cSJed Brown 23242eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian 23252eca1d9cSJed Brown @*/ 23267087cfbeSBarry Smith PetscErrorCode TSGetIJacobian(TS ts,Mat *A,Mat *B,TSIJacobian *f,void **ctx) 23272eca1d9cSJed Brown { 2328089b2837SJed Brown PetscErrorCode ierr; 2329089b2837SJed Brown SNES snes; 2330089b2837SJed Brown 23312eca1d9cSJed Brown PetscFunctionBegin; 2332089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2333089b2837SJed Brown ierr = SNESGetJacobian(snes,A,B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 23343b5f76d0SSean Farley if (f) *f = ts->userops->ijacobian; 23352eca1d9cSJed Brown if (ctx) *ctx = ts->jacP; 23362eca1d9cSJed Brown PetscFunctionReturn(0); 23372eca1d9cSJed Brown } 23382eca1d9cSJed Brown 23396083293cSBarry Smith typedef struct { 23406083293cSBarry Smith PetscViewer viewer; 23416083293cSBarry Smith Vec initialsolution; 23426083293cSBarry Smith PetscBool showinitial; 23436083293cSBarry Smith } TSMonitorSolutionCtx; 23446083293cSBarry Smith 23452eca1d9cSJed Brown #undef __FUNCT__ 2346a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSolution" 23471713a123SBarry Smith /*@C 2348a6570f20SBarry Smith TSMonitorSolution - Monitors progress of the TS solvers by calling 23491713a123SBarry Smith VecView() for the solution at each timestep 23501713a123SBarry Smith 23511713a123SBarry Smith Collective on TS 23521713a123SBarry Smith 23531713a123SBarry Smith Input Parameters: 23541713a123SBarry Smith + ts - the TS context 23551713a123SBarry Smith . step - current time-step 2356142b95e3SSatish Balay . ptime - current time 23571713a123SBarry Smith - dummy - either a viewer or PETSC_NULL 23581713a123SBarry Smith 23591713a123SBarry Smith Level: intermediate 23601713a123SBarry Smith 23611713a123SBarry Smith .keywords: TS, vector, monitor, view 23621713a123SBarry Smith 2363a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 23641713a123SBarry Smith @*/ 23657087cfbeSBarry Smith PetscErrorCode TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec x,void *dummy) 23661713a123SBarry Smith { 2367dfbe8321SBarry Smith PetscErrorCode ierr; 23686083293cSBarry Smith TSMonitorSolutionCtx *ictx = (TSMonitorSolutionCtx*)dummy; 23691713a123SBarry Smith 23701713a123SBarry Smith PetscFunctionBegin; 23716083293cSBarry Smith if (!step && ictx->showinitial) { 23726083293cSBarry Smith if (!ictx->initialsolution) { 23736083293cSBarry Smith ierr = VecDuplicate(x,&ictx->initialsolution);CHKERRQ(ierr); 23741713a123SBarry Smith } 23756083293cSBarry Smith ierr = VecCopy(x,ictx->initialsolution);CHKERRQ(ierr); 23766083293cSBarry Smith } 23776083293cSBarry Smith if (ictx->showinitial) { 23786083293cSBarry Smith PetscReal pause; 23796083293cSBarry Smith ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr); 23806083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr); 23816083293cSBarry Smith ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr); 23826083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr); 23836083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr); 23846083293cSBarry Smith } 23856083293cSBarry Smith ierr = VecView(x,ictx->viewer);CHKERRQ(ierr); 23866083293cSBarry Smith if (ictx->showinitial) { 23876083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr); 23886083293cSBarry Smith } 23891713a123SBarry Smith PetscFunctionReturn(0); 23901713a123SBarry Smith } 23911713a123SBarry Smith 23921713a123SBarry Smith 23936c699258SBarry Smith #undef __FUNCT__ 23946083293cSBarry Smith #define __FUNCT__ "TSMonitorSolutionDestroy" 23956083293cSBarry Smith /*@C 23966083293cSBarry Smith TSMonitorSolutionDestroy - Destroys the monitor context for TSMonitorSolution 23976083293cSBarry Smith 23986083293cSBarry Smith Collective on TS 23996083293cSBarry Smith 24006083293cSBarry Smith Input Parameters: 24016083293cSBarry Smith . ctx - the monitor context 24026083293cSBarry Smith 24036083293cSBarry Smith Level: intermediate 24046083293cSBarry Smith 24056083293cSBarry Smith .keywords: TS, vector, monitor, view 24066083293cSBarry Smith 24076083293cSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorSolution() 24086083293cSBarry Smith @*/ 24096083293cSBarry Smith PetscErrorCode TSMonitorSolutionDestroy(void **ctx) 24106083293cSBarry Smith { 24116083293cSBarry Smith PetscErrorCode ierr; 24126083293cSBarry Smith TSMonitorSolutionCtx *ictx = *(TSMonitorSolutionCtx**)ctx; 24136083293cSBarry Smith 24146083293cSBarry Smith PetscFunctionBegin; 24156083293cSBarry Smith ierr = PetscViewerDestroy(&ictx->viewer);CHKERRQ(ierr); 24166083293cSBarry Smith ierr = VecDestroy(&ictx->initialsolution);CHKERRQ(ierr); 24176083293cSBarry Smith ierr = PetscFree(ictx);CHKERRQ(ierr); 24186083293cSBarry Smith PetscFunctionReturn(0); 24196083293cSBarry Smith } 24206083293cSBarry Smith 24216083293cSBarry Smith #undef __FUNCT__ 24226083293cSBarry Smith #define __FUNCT__ "TSMonitorSolutionCreate" 24236083293cSBarry Smith /*@C 24246083293cSBarry Smith TSMonitorSolutionCreate - Creates the monitor context for TSMonitorSolution 24256083293cSBarry Smith 24266083293cSBarry Smith Collective on TS 24276083293cSBarry Smith 24286083293cSBarry Smith Input Parameter: 24296083293cSBarry Smith . ts - time-step context 24306083293cSBarry Smith 24316083293cSBarry Smith Output Patameter: 24326083293cSBarry Smith . ctx - the monitor context 24336083293cSBarry Smith 24346083293cSBarry Smith Level: intermediate 24356083293cSBarry Smith 24366083293cSBarry Smith .keywords: TS, vector, monitor, view 24376083293cSBarry Smith 24386083293cSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorSolution() 24396083293cSBarry Smith @*/ 24406083293cSBarry Smith PetscErrorCode TSMonitorSolutionCreate(TS ts,PetscViewer viewer,void **ctx) 24416083293cSBarry Smith { 24426083293cSBarry Smith PetscErrorCode ierr; 24436083293cSBarry Smith TSMonitorSolutionCtx *ictx; 24446083293cSBarry Smith 24456083293cSBarry Smith PetscFunctionBegin; 24466083293cSBarry Smith ierr = PetscNew(TSMonitorSolutionCtx,&ictx);CHKERRQ(ierr); 24476083293cSBarry Smith *ctx = (void*)ictx; 24486083293cSBarry Smith if (!viewer) { 24496083293cSBarry Smith viewer = PETSC_VIEWER_DRAW_(((PetscObject)ts)->comm); 24506083293cSBarry Smith } 24516083293cSBarry Smith ierr = PetscObjectReference((PetscObject)viewer);CHKERRQ(ierr); 24526083293cSBarry Smith ictx->viewer = viewer; 24536083293cSBarry Smith ictx->showinitial = PETSC_FALSE; 24546083293cSBarry Smith ierr = PetscOptionsGetBool(((PetscObject)ts)->prefix,"-ts_monitor_solution_initial",&ictx->showinitial,PETSC_NULL);CHKERRQ(ierr); 24556083293cSBarry Smith PetscFunctionReturn(0); 24566083293cSBarry Smith } 24576083293cSBarry Smith 24586083293cSBarry Smith #undef __FUNCT__ 24596c699258SBarry Smith #define __FUNCT__ "TSSetDM" 24606c699258SBarry Smith /*@ 24616c699258SBarry Smith TSSetDM - Sets the DM that may be used by some preconditioners 24626c699258SBarry Smith 24633f9fe445SBarry Smith Logically Collective on TS and DM 24646c699258SBarry Smith 24656c699258SBarry Smith Input Parameters: 24666c699258SBarry Smith + ts - the preconditioner context 24676c699258SBarry Smith - dm - the dm 24686c699258SBarry Smith 24696c699258SBarry Smith Level: intermediate 24706c699258SBarry Smith 24716c699258SBarry Smith 24726c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM() 24736c699258SBarry Smith @*/ 24747087cfbeSBarry Smith PetscErrorCode TSSetDM(TS ts,DM dm) 24756c699258SBarry Smith { 24766c699258SBarry Smith PetscErrorCode ierr; 2477089b2837SJed Brown SNES snes; 24786c699258SBarry Smith 24796c699258SBarry Smith PetscFunctionBegin; 24800700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 248170663e4aSLisandro Dalcin ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr); 24826bf464f9SBarry Smith ierr = DMDestroy(&ts->dm);CHKERRQ(ierr); 24836c699258SBarry Smith ts->dm = dm; 2484089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2485089b2837SJed Brown ierr = SNESSetDM(snes,dm);CHKERRQ(ierr); 24866c699258SBarry Smith PetscFunctionReturn(0); 24876c699258SBarry Smith } 24886c699258SBarry Smith 24896c699258SBarry Smith #undef __FUNCT__ 24906c699258SBarry Smith #define __FUNCT__ "TSGetDM" 24916c699258SBarry Smith /*@ 24926c699258SBarry Smith TSGetDM - Gets the DM that may be used by some preconditioners 24936c699258SBarry Smith 24943f9fe445SBarry Smith Not Collective 24956c699258SBarry Smith 24966c699258SBarry Smith Input Parameter: 24976c699258SBarry Smith . ts - the preconditioner context 24986c699258SBarry Smith 24996c699258SBarry Smith Output Parameter: 25006c699258SBarry Smith . dm - the dm 25016c699258SBarry Smith 25026c699258SBarry Smith Level: intermediate 25036c699258SBarry Smith 25046c699258SBarry Smith 25056c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM() 25066c699258SBarry Smith @*/ 25077087cfbeSBarry Smith PetscErrorCode TSGetDM(TS ts,DM *dm) 25086c699258SBarry Smith { 2509496e6a7aSJed Brown PetscErrorCode ierr; 2510496e6a7aSJed Brown 25116c699258SBarry Smith PetscFunctionBegin; 25120700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2513496e6a7aSJed Brown if (!ts->dm) { 2514496e6a7aSJed Brown ierr = DMShellCreate(((PetscObject)ts)->comm,&ts->dm);CHKERRQ(ierr); 2515496e6a7aSJed Brown if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 2516496e6a7aSJed Brown } 25176c699258SBarry Smith *dm = ts->dm; 25186c699258SBarry Smith PetscFunctionReturn(0); 25196c699258SBarry Smith } 25201713a123SBarry Smith 25210f5c6efeSJed Brown #undef __FUNCT__ 25220f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction" 25230f5c6efeSJed Brown /*@ 25240f5c6efeSJed Brown SNESTSFormFunction - Function to evaluate nonlinear residual 25250f5c6efeSJed Brown 25263f9fe445SBarry Smith Logically Collective on SNES 25270f5c6efeSJed Brown 25280f5c6efeSJed Brown Input Parameter: 2529d42a1c89SJed Brown + snes - nonlinear solver 25300f5c6efeSJed Brown . X - the current state at which to evaluate the residual 2531d42a1c89SJed Brown - ctx - user context, must be a TS 25320f5c6efeSJed Brown 25330f5c6efeSJed Brown Output Parameter: 25340f5c6efeSJed Brown . F - the nonlinear residual 25350f5c6efeSJed Brown 25360f5c6efeSJed Brown Notes: 25370f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 25380f5c6efeSJed Brown It is most frequently passed to MatFDColoringSetFunction(). 25390f5c6efeSJed Brown 25400f5c6efeSJed Brown Level: advanced 25410f5c6efeSJed Brown 25420f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction() 25430f5c6efeSJed Brown @*/ 25447087cfbeSBarry Smith PetscErrorCode SNESTSFormFunction(SNES snes,Vec X,Vec F,void *ctx) 25450f5c6efeSJed Brown { 25460f5c6efeSJed Brown TS ts = (TS)ctx; 25470f5c6efeSJed Brown PetscErrorCode ierr; 25480f5c6efeSJed Brown 25490f5c6efeSJed Brown PetscFunctionBegin; 25500f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 25510f5c6efeSJed Brown PetscValidHeaderSpecific(X,VEC_CLASSID,2); 25520f5c6efeSJed Brown PetscValidHeaderSpecific(F,VEC_CLASSID,3); 25530f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,4); 25540f5c6efeSJed Brown ierr = (ts->ops->snesfunction)(snes,X,F,ts);CHKERRQ(ierr); 25550f5c6efeSJed Brown PetscFunctionReturn(0); 25560f5c6efeSJed Brown } 25570f5c6efeSJed Brown 25580f5c6efeSJed Brown #undef __FUNCT__ 25590f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian" 25600f5c6efeSJed Brown /*@ 25610f5c6efeSJed Brown SNESTSFormJacobian - Function to evaluate the Jacobian 25620f5c6efeSJed Brown 25630f5c6efeSJed Brown Collective on SNES 25640f5c6efeSJed Brown 25650f5c6efeSJed Brown Input Parameter: 25660f5c6efeSJed Brown + snes - nonlinear solver 25670f5c6efeSJed Brown . X - the current state at which to evaluate the residual 25680f5c6efeSJed Brown - ctx - user context, must be a TS 25690f5c6efeSJed Brown 25700f5c6efeSJed Brown Output Parameter: 25710f5c6efeSJed Brown + A - the Jacobian 25720f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A) 25730f5c6efeSJed Brown - flag - indicates any structure change in the matrix 25740f5c6efeSJed Brown 25750f5c6efeSJed Brown Notes: 25760f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 25770f5c6efeSJed Brown 25780f5c6efeSJed Brown Level: developer 25790f5c6efeSJed Brown 25800f5c6efeSJed Brown .seealso: SNESSetJacobian() 25810f5c6efeSJed Brown @*/ 25827087cfbeSBarry Smith PetscErrorCode SNESTSFormJacobian(SNES snes,Vec X,Mat *A,Mat *B,MatStructure *flag,void *ctx) 25830f5c6efeSJed Brown { 25840f5c6efeSJed Brown TS ts = (TS)ctx; 25850f5c6efeSJed Brown PetscErrorCode ierr; 25860f5c6efeSJed Brown 25870f5c6efeSJed Brown PetscFunctionBegin; 25880f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 25890f5c6efeSJed Brown PetscValidHeaderSpecific(X,VEC_CLASSID,2); 25900f5c6efeSJed Brown PetscValidPointer(A,3); 25910f5c6efeSJed Brown PetscValidHeaderSpecific(*A,MAT_CLASSID,3); 25920f5c6efeSJed Brown PetscValidPointer(B,4); 25930f5c6efeSJed Brown PetscValidHeaderSpecific(*B,MAT_CLASSID,4); 25940f5c6efeSJed Brown PetscValidPointer(flag,5); 25950f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,6); 25960f5c6efeSJed Brown ierr = (ts->ops->snesjacobian)(snes,X,A,B,flag,ts);CHKERRQ(ierr); 25970f5c6efeSJed Brown PetscFunctionReturn(0); 25980f5c6efeSJed Brown } 2599325fc9f4SBarry Smith 26000e4ef248SJed Brown #undef __FUNCT__ 26010e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear" 26020e4ef248SJed Brown /*@C 26030e4ef248SJed Brown TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only 26040e4ef248SJed Brown 26050e4ef248SJed Brown Collective on TS 26060e4ef248SJed Brown 26070e4ef248SJed Brown Input Arguments: 26080e4ef248SJed Brown + ts - time stepping context 26090e4ef248SJed Brown . t - time at which to evaluate 26100e4ef248SJed Brown . X - state at which to evaluate 26110e4ef248SJed Brown - ctx - context 26120e4ef248SJed Brown 26130e4ef248SJed Brown Output Arguments: 26140e4ef248SJed Brown . F - right hand side 26150e4ef248SJed Brown 26160e4ef248SJed Brown Level: intermediate 26170e4ef248SJed Brown 26180e4ef248SJed Brown Notes: 26190e4ef248SJed Brown This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems. 26200e4ef248SJed Brown The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian(). 26210e4ef248SJed Brown 26220e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 26230e4ef248SJed Brown @*/ 26240e4ef248SJed Brown PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec X,Vec F,void *ctx) 26250e4ef248SJed Brown { 26260e4ef248SJed Brown PetscErrorCode ierr; 26270e4ef248SJed Brown Mat Arhs,Brhs; 26280e4ef248SJed Brown MatStructure flg2; 26290e4ef248SJed Brown 26300e4ef248SJed Brown PetscFunctionBegin; 26310e4ef248SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 26320e4ef248SJed Brown ierr = TSComputeRHSJacobian(ts,t,X,&Arhs,&Brhs,&flg2);CHKERRQ(ierr); 26330e4ef248SJed Brown ierr = MatMult(Arhs,X,F);CHKERRQ(ierr); 26340e4ef248SJed Brown PetscFunctionReturn(0); 26350e4ef248SJed Brown } 26360e4ef248SJed Brown 26370e4ef248SJed Brown #undef __FUNCT__ 26380e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant" 26390e4ef248SJed Brown /*@C 26400e4ef248SJed Brown TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 26410e4ef248SJed Brown 26420e4ef248SJed Brown Collective on TS 26430e4ef248SJed Brown 26440e4ef248SJed Brown Input Arguments: 26450e4ef248SJed Brown + ts - time stepping context 26460e4ef248SJed Brown . t - time at which to evaluate 26470e4ef248SJed Brown . X - state at which to evaluate 26480e4ef248SJed Brown - ctx - context 26490e4ef248SJed Brown 26500e4ef248SJed Brown Output Arguments: 26510e4ef248SJed Brown + A - pointer to operator 26520e4ef248SJed Brown . B - pointer to preconditioning matrix 26530e4ef248SJed Brown - flg - matrix structure flag 26540e4ef248SJed Brown 26550e4ef248SJed Brown Level: intermediate 26560e4ef248SJed Brown 26570e4ef248SJed Brown Notes: 26580e4ef248SJed Brown This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems. 26590e4ef248SJed Brown 26600e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear() 26610e4ef248SJed Brown @*/ 26620e4ef248SJed Brown PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec X,Mat *A,Mat *B,MatStructure *flg,void *ctx) 26630e4ef248SJed Brown { 26640e4ef248SJed Brown 26650e4ef248SJed Brown PetscFunctionBegin; 26660e4ef248SJed Brown *flg = SAME_PRECONDITIONER; 26670e4ef248SJed Brown PetscFunctionReturn(0); 26680e4ef248SJed Brown } 26690e4ef248SJed Brown 26700026cea9SSean Farley #undef __FUNCT__ 26710026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear" 26720026cea9SSean Farley /*@C 26730026cea9SSean Farley TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 26740026cea9SSean Farley 26750026cea9SSean Farley Collective on TS 26760026cea9SSean Farley 26770026cea9SSean Farley Input Arguments: 26780026cea9SSean Farley + ts - time stepping context 26790026cea9SSean Farley . t - time at which to evaluate 26800026cea9SSean Farley . X - state at which to evaluate 26810026cea9SSean Farley . Xdot - time derivative of state vector 26820026cea9SSean Farley - ctx - context 26830026cea9SSean Farley 26840026cea9SSean Farley Output Arguments: 26850026cea9SSean Farley . F - left hand side 26860026cea9SSean Farley 26870026cea9SSean Farley Level: intermediate 26880026cea9SSean Farley 26890026cea9SSean Farley Notes: 26900026cea9SSean 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 26910026cea9SSean Farley user is required to write their own TSComputeIFunction. 26920026cea9SSean Farley This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems. 26930026cea9SSean Farley The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian(). 26940026cea9SSean Farley 26950026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant() 26960026cea9SSean Farley @*/ 26970026cea9SSean Farley PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec X,Vec Xdot,Vec F,void *ctx) 26980026cea9SSean Farley { 26990026cea9SSean Farley PetscErrorCode ierr; 27000026cea9SSean Farley Mat A,B; 27010026cea9SSean Farley MatStructure flg2; 27020026cea9SSean Farley 27030026cea9SSean Farley PetscFunctionBegin; 27040026cea9SSean Farley ierr = TSGetIJacobian(ts,&A,&B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 27050026cea9SSean Farley ierr = TSComputeIJacobian(ts,t,X,Xdot,1.0,&A,&B,&flg2,PETSC_TRUE);CHKERRQ(ierr); 27060026cea9SSean Farley ierr = MatMult(A,Xdot,F);CHKERRQ(ierr); 27070026cea9SSean Farley PetscFunctionReturn(0); 27080026cea9SSean Farley } 27090026cea9SSean Farley 27100026cea9SSean Farley #undef __FUNCT__ 27110026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant" 27120026cea9SSean Farley /*@C 271324e94211SJed Brown TSComputeIJacobianConstant - Reuses a Jacobian that is time-independent. 27140026cea9SSean Farley 27150026cea9SSean Farley Collective on TS 27160026cea9SSean Farley 27170026cea9SSean Farley Input Arguments: 27180026cea9SSean Farley + ts - time stepping context 27190026cea9SSean Farley . t - time at which to evaluate 27200026cea9SSean Farley . X - state at which to evaluate 27210026cea9SSean Farley . Xdot - time derivative of state vector 27220026cea9SSean Farley . shift - shift to apply 27230026cea9SSean Farley - ctx - context 27240026cea9SSean Farley 27250026cea9SSean Farley Output Arguments: 27260026cea9SSean Farley + A - pointer to operator 27270026cea9SSean Farley . B - pointer to preconditioning matrix 27280026cea9SSean Farley - flg - matrix structure flag 27290026cea9SSean Farley 27300026cea9SSean Farley Level: intermediate 27310026cea9SSean Farley 27320026cea9SSean Farley Notes: 27330026cea9SSean Farley This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems. 27340026cea9SSean Farley 27350026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear() 27360026cea9SSean Farley @*/ 27370026cea9SSean Farley PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec X,Vec Xdot,PetscReal shift,Mat *A,Mat *B,MatStructure *flg,void *ctx) 27380026cea9SSean Farley { 27390026cea9SSean Farley 27400026cea9SSean Farley PetscFunctionBegin; 27410026cea9SSean Farley *flg = SAME_PRECONDITIONER; 27420026cea9SSean Farley PetscFunctionReturn(0); 27430026cea9SSean Farley } 27440026cea9SSean Farley 27454af1b03aSJed Brown 27464af1b03aSJed Brown #undef __FUNCT__ 27474af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason" 27484af1b03aSJed Brown /*@ 27494af1b03aSJed Brown TSGetConvergedReason - Gets the reason the TS iteration was stopped. 27504af1b03aSJed Brown 27514af1b03aSJed Brown Not Collective 27524af1b03aSJed Brown 27534af1b03aSJed Brown Input Parameter: 27544af1b03aSJed Brown . ts - the TS context 27554af1b03aSJed Brown 27564af1b03aSJed Brown Output Parameter: 27574af1b03aSJed Brown . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 27584af1b03aSJed Brown manual pages for the individual convergence tests for complete lists 27594af1b03aSJed Brown 27604af1b03aSJed Brown Level: intermediate 27614af1b03aSJed Brown 2762cd652676SJed Brown Notes: 2763cd652676SJed Brown Can only be called after the call to TSSolve() is complete. 27644af1b03aSJed Brown 27654af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test 27664af1b03aSJed Brown 27674af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason 27684af1b03aSJed Brown @*/ 27694af1b03aSJed Brown PetscErrorCode TSGetConvergedReason(TS ts,TSConvergedReason *reason) 27704af1b03aSJed Brown { 27714af1b03aSJed Brown PetscFunctionBegin; 27724af1b03aSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 27734af1b03aSJed Brown PetscValidPointer(reason,2); 27744af1b03aSJed Brown *reason = ts->reason; 27754af1b03aSJed Brown PetscFunctionReturn(0); 27764af1b03aSJed Brown } 27774af1b03aSJed Brown 2778fb1732b5SBarry Smith #undef __FUNCT__ 27799f67acb7SJed Brown #define __FUNCT__ "TSGetNonlinearSolveIterations" 27809f67acb7SJed Brown /*@ 278101c7e25bSJed Brown TSGetNonlinearSolveIterations - Gets the total number of linear iterations 27829f67acb7SJed Brown used by the time integrator. 27839f67acb7SJed Brown 27849f67acb7SJed Brown Not Collective 27859f67acb7SJed Brown 27869f67acb7SJed Brown Input Parameter: 27879f67acb7SJed Brown . ts - TS context 27889f67acb7SJed Brown 27899f67acb7SJed Brown Output Parameter: 27909f67acb7SJed Brown . nits - number of nonlinear iterations 27919f67acb7SJed Brown 27929f67acb7SJed Brown Notes: 27939f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 27949f67acb7SJed Brown 27959f67acb7SJed Brown Level: intermediate 27969f67acb7SJed Brown 27979f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations 27989f67acb7SJed Brown 27999f67acb7SJed Brown .seealso: TSGetLinearSolveIterations() 28009f67acb7SJed Brown @*/ 28019f67acb7SJed Brown PetscErrorCode TSGetNonlinearSolveIterations(TS ts,PetscInt *nits) 28029f67acb7SJed Brown { 28039f67acb7SJed Brown PetscFunctionBegin; 28049f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 28059f67acb7SJed Brown PetscValidIntPointer(nits,2); 28069f67acb7SJed Brown *nits = ts->nonlinear_its; 28079f67acb7SJed Brown PetscFunctionReturn(0); 28089f67acb7SJed Brown } 28099f67acb7SJed Brown 28109f67acb7SJed Brown #undef __FUNCT__ 28119f67acb7SJed Brown #define __FUNCT__ "TSGetLinearSolveIterations" 28129f67acb7SJed Brown /*@ 28139f67acb7SJed Brown TSGetLinearSolveIterations - Gets the total number of linear iterations 28149f67acb7SJed Brown used by the time integrator. 28159f67acb7SJed Brown 28169f67acb7SJed Brown Not Collective 28179f67acb7SJed Brown 28189f67acb7SJed Brown Input Parameter: 28199f67acb7SJed Brown . ts - TS context 28209f67acb7SJed Brown 28219f67acb7SJed Brown Output Parameter: 28229f67acb7SJed Brown . lits - number of linear iterations 28239f67acb7SJed Brown 28249f67acb7SJed Brown Notes: 28259f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 28269f67acb7SJed Brown 28279f67acb7SJed Brown Level: intermediate 28289f67acb7SJed Brown 28299f67acb7SJed Brown .keywords: TS, get, number, linear, iterations 28309f67acb7SJed Brown 28319f67acb7SJed Brown .seealso: TSGetNonlinearSolveIterations(), SNESGetLinearSolveIterations() 28329f67acb7SJed Brown @*/ 28339f67acb7SJed Brown PetscErrorCode TSGetLinearSolveIterations(TS ts,PetscInt *lits) 28349f67acb7SJed Brown { 28359f67acb7SJed Brown PetscFunctionBegin; 28369f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 28379f67acb7SJed Brown PetscValidIntPointer(lits,2); 28389f67acb7SJed Brown *lits = ts->linear_its; 28399f67acb7SJed Brown PetscFunctionReturn(0); 28409f67acb7SJed Brown } 28419f67acb7SJed Brown 28429f67acb7SJed Brown #undef __FUNCT__ 2843fb1732b5SBarry Smith #define __FUNCT__ "TSMonitorSolutionBinary" 2844fb1732b5SBarry Smith /*@C 2845fb1732b5SBarry Smith TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file 2846fb1732b5SBarry Smith 2847fb1732b5SBarry Smith Collective on TS 2848fb1732b5SBarry Smith 2849fb1732b5SBarry Smith Input Parameters: 2850fb1732b5SBarry Smith + ts - the TS context 2851fb1732b5SBarry Smith . step - current time-step 2852fb1732b5SBarry Smith . ptime - current time 2853ed81e22dSJed Brown . x - current state 2854fb1732b5SBarry Smith - viewer - binary viewer 2855fb1732b5SBarry Smith 2856fb1732b5SBarry Smith Level: intermediate 2857fb1732b5SBarry Smith 2858fb1732b5SBarry Smith .keywords: TS, vector, monitor, view 2859fb1732b5SBarry Smith 2860fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 2861fb1732b5SBarry Smith @*/ 2862ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec x,void *viewer) 2863fb1732b5SBarry Smith { 2864fb1732b5SBarry Smith PetscErrorCode ierr; 2865ed81e22dSJed Brown PetscViewer v = (PetscViewer)viewer; 2866fb1732b5SBarry Smith 2867fb1732b5SBarry Smith PetscFunctionBegin; 2868ed81e22dSJed Brown ierr = VecView(x,v);CHKERRQ(ierr); 2869ed81e22dSJed Brown PetscFunctionReturn(0); 2870ed81e22dSJed Brown } 2871ed81e22dSJed Brown 2872ed81e22dSJed Brown #undef __FUNCT__ 2873ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK" 2874ed81e22dSJed Brown /*@C 2875ed81e22dSJed Brown TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep. 2876ed81e22dSJed Brown 2877ed81e22dSJed Brown Collective on TS 2878ed81e22dSJed Brown 2879ed81e22dSJed Brown Input Parameters: 2880ed81e22dSJed Brown + ts - the TS context 2881ed81e22dSJed Brown . step - current time-step 2882ed81e22dSJed Brown . ptime - current time 2883ed81e22dSJed Brown . x - current state 2884ed81e22dSJed Brown - filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 2885ed81e22dSJed Brown 2886ed81e22dSJed Brown Level: intermediate 2887ed81e22dSJed Brown 2888ed81e22dSJed Brown Notes: 2889ed81e22dSJed 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. 2890ed81e22dSJed Brown These are named according to the file name template. 2891ed81e22dSJed Brown 2892ed81e22dSJed Brown This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy(). 2893ed81e22dSJed Brown 2894ed81e22dSJed Brown .keywords: TS, vector, monitor, view 2895ed81e22dSJed Brown 2896ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 2897ed81e22dSJed Brown @*/ 2898ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec x,void *filenametemplate) 2899ed81e22dSJed Brown { 2900ed81e22dSJed Brown PetscErrorCode ierr; 2901ed81e22dSJed Brown char filename[PETSC_MAX_PATH_LEN]; 2902ed81e22dSJed Brown PetscViewer viewer; 2903ed81e22dSJed Brown 2904ed81e22dSJed Brown PetscFunctionBegin; 2905ed81e22dSJed Brown ierr = PetscSNPrintf(filename,sizeof filename,(const char*)filenametemplate,step);CHKERRQ(ierr); 2906ed81e22dSJed Brown ierr = PetscViewerVTKOpen(((PetscObject)ts)->comm,filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr); 2907fb1732b5SBarry Smith ierr = VecView(x,viewer);CHKERRQ(ierr); 2908ed81e22dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 2909ed81e22dSJed Brown PetscFunctionReturn(0); 2910ed81e22dSJed Brown } 2911ed81e22dSJed Brown 2912ed81e22dSJed Brown #undef __FUNCT__ 2913ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy" 2914ed81e22dSJed Brown /*@C 2915ed81e22dSJed Brown TSMonitorSolutionVTKDestroy - Destroy context for monitoring 2916ed81e22dSJed Brown 2917ed81e22dSJed Brown Collective on TS 2918ed81e22dSJed Brown 2919ed81e22dSJed Brown Input Parameters: 2920ed81e22dSJed Brown . filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 2921ed81e22dSJed Brown 2922ed81e22dSJed Brown Level: intermediate 2923ed81e22dSJed Brown 2924ed81e22dSJed Brown Note: 2925ed81e22dSJed Brown This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK(). 2926ed81e22dSJed Brown 2927ed81e22dSJed Brown .keywords: TS, vector, monitor, view 2928ed81e22dSJed Brown 2929ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK() 2930ed81e22dSJed Brown @*/ 2931ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate) 2932ed81e22dSJed Brown { 2933ed81e22dSJed Brown PetscErrorCode ierr; 2934ed81e22dSJed Brown 2935ed81e22dSJed Brown PetscFunctionBegin; 2936ed81e22dSJed Brown ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr); 2937fb1732b5SBarry Smith PetscFunctionReturn(0); 2938fb1732b5SBarry Smith } 2939fb1732b5SBarry Smith 294084df9cb4SJed Brown #undef __FUNCT__ 294184df9cb4SJed Brown #define __FUNCT__ "TSGetAdapt" 294284df9cb4SJed Brown /*@ 294384df9cb4SJed Brown TSGetAdapt - Get the adaptive controller context for the current method 294484df9cb4SJed Brown 2945ed81e22dSJed Brown Collective on TS if controller has not been created yet 294684df9cb4SJed Brown 294784df9cb4SJed Brown Input Arguments: 2948ed81e22dSJed Brown . ts - time stepping context 294984df9cb4SJed Brown 295084df9cb4SJed Brown Output Arguments: 2951ed81e22dSJed Brown . adapt - adaptive controller 295284df9cb4SJed Brown 295384df9cb4SJed Brown Level: intermediate 295484df9cb4SJed Brown 2955ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose() 295684df9cb4SJed Brown @*/ 295784df9cb4SJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt) 295884df9cb4SJed Brown { 295984df9cb4SJed Brown PetscErrorCode ierr; 296084df9cb4SJed Brown 296184df9cb4SJed Brown PetscFunctionBegin; 296284df9cb4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 296384df9cb4SJed Brown PetscValidPointer(adapt,2); 296484df9cb4SJed Brown if (!ts->adapt) { 296584df9cb4SJed Brown ierr = TSAdaptCreate(((PetscObject)ts)->comm,&ts->adapt);CHKERRQ(ierr); 29661c3436cfSJed Brown ierr = PetscLogObjectParent(ts,ts->adapt);CHKERRQ(ierr); 29671c3436cfSJed Brown ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr); 296884df9cb4SJed Brown } 296984df9cb4SJed Brown *adapt = ts->adapt; 297084df9cb4SJed Brown PetscFunctionReturn(0); 297184df9cb4SJed Brown } 2972d6ebe24aSShri Abhyankar 2973d6ebe24aSShri Abhyankar #undef __FUNCT__ 29741c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances" 29751c3436cfSJed Brown /*@ 29761c3436cfSJed Brown TSSetTolerances - Set tolerances for local truncation error when using adaptive controller 29771c3436cfSJed Brown 29781c3436cfSJed Brown Logically Collective 29791c3436cfSJed Brown 29801c3436cfSJed Brown Input Arguments: 29811c3436cfSJed Brown + ts - time integration context 29821c3436cfSJed Brown . atol - scalar absolute tolerances, PETSC_DECIDE to leave current value 29831c3436cfSJed Brown . vatol - vector of absolute tolerances or PETSC_NULL, used in preference to atol if present 29841c3436cfSJed Brown . rtol - scalar relative tolerances, PETSC_DECIDE to leave current value 29851c3436cfSJed Brown - vrtol - vector of relative tolerances or PETSC_NULL, used in preference to atol if present 29861c3436cfSJed Brown 29871c3436cfSJed Brown Level: beginner 29881c3436cfSJed Brown 29891c3436cfSJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS() 29901c3436cfSJed Brown @*/ 29911c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol) 29921c3436cfSJed Brown { 29931c3436cfSJed Brown PetscErrorCode ierr; 29941c3436cfSJed Brown 29951c3436cfSJed Brown PetscFunctionBegin; 29961c3436cfSJed Brown if (atol != PETSC_DECIDE) ts->atol = atol; 29971c3436cfSJed Brown if (vatol) { 29981c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr); 29991c3436cfSJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 30001c3436cfSJed Brown ts->vatol = vatol; 30011c3436cfSJed Brown } 30021c3436cfSJed Brown if (rtol != PETSC_DECIDE) ts->rtol = rtol; 30031c3436cfSJed Brown if (vrtol) { 30041c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr); 30051c3436cfSJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 30061c3436cfSJed Brown ts->vrtol = vrtol; 30071c3436cfSJed Brown } 30081c3436cfSJed Brown PetscFunctionReturn(0); 30091c3436cfSJed Brown } 30101c3436cfSJed Brown 30111c3436cfSJed Brown #undef __FUNCT__ 30121c3436cfSJed Brown #define __FUNCT__ "TSErrorNormWRMS" 30131c3436cfSJed Brown /*@ 30141c3436cfSJed Brown TSErrorNormWRMS - compute a weighted norm of the difference between a vector and the current state 30151c3436cfSJed Brown 30161c3436cfSJed Brown Collective on TS 30171c3436cfSJed Brown 30181c3436cfSJed Brown Input Arguments: 30191c3436cfSJed Brown + ts - time stepping context 30201c3436cfSJed Brown - Y - state vector to be compared to ts->vec_sol 30211c3436cfSJed Brown 30221c3436cfSJed Brown Output Arguments: 30231c3436cfSJed Brown . norm - weighted norm, a value of 1.0 is considered small 30241c3436cfSJed Brown 30251c3436cfSJed Brown Level: developer 30261c3436cfSJed Brown 30271c3436cfSJed Brown .seealso: TSSetTolerances() 30281c3436cfSJed Brown @*/ 30291c3436cfSJed Brown PetscErrorCode TSErrorNormWRMS(TS ts,Vec Y,PetscReal *norm) 30301c3436cfSJed Brown { 30311c3436cfSJed Brown PetscErrorCode ierr; 30321c3436cfSJed Brown PetscInt i,n,N; 30331c3436cfSJed Brown const PetscScalar *x,*y; 30341c3436cfSJed Brown Vec X; 30351c3436cfSJed Brown PetscReal sum,gsum; 30361c3436cfSJed Brown 30371c3436cfSJed Brown PetscFunctionBegin; 30381c3436cfSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 30391c3436cfSJed Brown PetscValidHeaderSpecific(Y,VEC_CLASSID,2); 30401c3436cfSJed Brown PetscValidPointer(norm,3); 30411c3436cfSJed Brown X = ts->vec_sol; 30421c3436cfSJed Brown PetscCheckSameTypeAndComm(X,1,Y,2); 30431c3436cfSJed Brown if (X == Y) SETERRQ(((PetscObject)X)->comm,PETSC_ERR_ARG_IDN,"Y cannot be the TS solution vector"); 30441c3436cfSJed Brown 30451c3436cfSJed Brown /* This is simple to implement, just not done yet */ 30461c3436cfSJed Brown if (ts->vatol || ts->vrtol) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_SUP,"No support for vector scaling yet"); 30471c3436cfSJed Brown 30481c3436cfSJed Brown ierr = VecGetSize(X,&N);CHKERRQ(ierr); 30491c3436cfSJed Brown ierr = VecGetLocalSize(X,&n);CHKERRQ(ierr); 30501c3436cfSJed Brown ierr = VecGetArrayRead(X,&x);CHKERRQ(ierr); 30511c3436cfSJed Brown ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 30521c3436cfSJed Brown sum = 0.; 30531c3436cfSJed Brown for (i=0; i<n; i++) { 30541c3436cfSJed Brown PetscReal tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(x[i]),PetscAbsScalar(y[i])); 30551c3436cfSJed Brown sum += PetscSqr(PetscAbsScalar(y[i] - x[i]) / tol); 30561c3436cfSJed Brown } 30571c3436cfSJed Brown ierr = VecRestoreArrayRead(X,&x);CHKERRQ(ierr); 30581c3436cfSJed Brown ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 30591c3436cfSJed Brown 30601c3436cfSJed Brown ierr = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,((PetscObject)ts)->comm);CHKERRQ(ierr); 30611c3436cfSJed Brown *norm = PetscSqrtReal(gsum / N); 30621c3436cfSJed Brown if (PetscIsInfOrNanScalar(*norm)) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 30631c3436cfSJed Brown PetscFunctionReturn(0); 30641c3436cfSJed Brown } 30651c3436cfSJed Brown 30661c3436cfSJed Brown #undef __FUNCT__ 30678d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal" 30688d59e960SJed Brown /*@ 30698d59e960SJed Brown TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler 30708d59e960SJed Brown 30718d59e960SJed Brown Logically Collective on TS 30728d59e960SJed Brown 30738d59e960SJed Brown Input Arguments: 30748d59e960SJed Brown + ts - time stepping context 30758d59e960SJed Brown - cfltime - maximum stable time step if using forward Euler (value can be different on each process) 30768d59e960SJed Brown 30778d59e960SJed Brown Note: 30788d59e960SJed Brown After calling this function, the global CFL time can be obtained by calling TSGetCFLTime() 30798d59e960SJed Brown 30808d59e960SJed Brown Level: intermediate 30818d59e960SJed Brown 30828d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL 30838d59e960SJed Brown @*/ 30848d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime) 30858d59e960SJed Brown { 30868d59e960SJed Brown 30878d59e960SJed Brown PetscFunctionBegin; 30888d59e960SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 30898d59e960SJed Brown ts->cfltime_local = cfltime; 30908d59e960SJed Brown ts->cfltime = -1.; 30918d59e960SJed Brown PetscFunctionReturn(0); 30928d59e960SJed Brown } 30938d59e960SJed Brown 30948d59e960SJed Brown #undef __FUNCT__ 30958d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime" 30968d59e960SJed Brown /*@ 30978d59e960SJed Brown TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler 30988d59e960SJed Brown 30998d59e960SJed Brown Collective on TS 31008d59e960SJed Brown 31018d59e960SJed Brown Input Arguments: 31028d59e960SJed Brown . ts - time stepping context 31038d59e960SJed Brown 31048d59e960SJed Brown Output Arguments: 31058d59e960SJed Brown . cfltime - maximum stable time step for forward Euler 31068d59e960SJed Brown 31078d59e960SJed Brown Level: advanced 31088d59e960SJed Brown 31098d59e960SJed Brown .seealso: TSSetCFLTimeLocal() 31108d59e960SJed Brown @*/ 31118d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime) 31128d59e960SJed Brown { 31138d59e960SJed Brown PetscErrorCode ierr; 31148d59e960SJed Brown 31158d59e960SJed Brown PetscFunctionBegin; 31168d59e960SJed Brown if (ts->cfltime < 0) { 31178d59e960SJed Brown ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,((PetscObject)ts)->comm);CHKERRQ(ierr); 31188d59e960SJed Brown } 31198d59e960SJed Brown *cfltime = ts->cfltime; 31208d59e960SJed Brown PetscFunctionReturn(0); 31218d59e960SJed Brown } 31228d59e960SJed Brown 31238d59e960SJed Brown #undef __FUNCT__ 3124d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds" 3125d6ebe24aSShri Abhyankar /*@ 3126d6ebe24aSShri Abhyankar TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu 3127d6ebe24aSShri Abhyankar 3128d6ebe24aSShri Abhyankar Input Parameters: 3129d6ebe24aSShri Abhyankar . ts - the TS context. 3130d6ebe24aSShri Abhyankar . xl - lower bound. 3131d6ebe24aSShri Abhyankar . xu - upper bound. 3132d6ebe24aSShri Abhyankar 3133d6ebe24aSShri Abhyankar Notes: 3134d6ebe24aSShri Abhyankar If this routine is not called then the lower and upper bounds are set to 313533c0c2ddSJed Brown SNES_VI_NINF and SNES_VI_INF respectively during SNESSetUp(). 3136d6ebe24aSShri Abhyankar 31372bd2b0e6SSatish Balay Level: advanced 31382bd2b0e6SSatish Balay 3139d6ebe24aSShri Abhyankar @*/ 3140d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu) 3141d6ebe24aSShri Abhyankar { 3142d6ebe24aSShri Abhyankar PetscErrorCode ierr; 3143d6ebe24aSShri Abhyankar SNES snes; 3144d6ebe24aSShri Abhyankar 3145d6ebe24aSShri Abhyankar PetscFunctionBegin; 3146d6ebe24aSShri Abhyankar ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3147d6ebe24aSShri Abhyankar ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr); 3148d6ebe24aSShri Abhyankar PetscFunctionReturn(0); 3149d6ebe24aSShri Abhyankar } 3150d6ebe24aSShri Abhyankar 3151325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 3152c6db04a5SJed Brown #include <mex.h> 3153325fc9f4SBarry Smith 3154325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext; 3155325fc9f4SBarry Smith 3156325fc9f4SBarry Smith #undef __FUNCT__ 3157325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab" 3158325fc9f4SBarry Smith /* 3159325fc9f4SBarry Smith TSComputeFunction_Matlab - Calls the function that has been set with 3160325fc9f4SBarry Smith TSSetFunctionMatlab(). 3161325fc9f4SBarry Smith 3162325fc9f4SBarry Smith Collective on TS 3163325fc9f4SBarry Smith 3164325fc9f4SBarry Smith Input Parameters: 3165325fc9f4SBarry Smith + snes - the TS context 3166325fc9f4SBarry Smith - x - input vector 3167325fc9f4SBarry Smith 3168325fc9f4SBarry Smith Output Parameter: 3169325fc9f4SBarry Smith . y - function vector, as set by TSSetFunction() 3170325fc9f4SBarry Smith 3171325fc9f4SBarry Smith Notes: 3172325fc9f4SBarry Smith TSComputeFunction() is typically used within nonlinear solvers 3173325fc9f4SBarry Smith implementations, so most users would not generally call this routine 3174325fc9f4SBarry Smith themselves. 3175325fc9f4SBarry Smith 3176325fc9f4SBarry Smith Level: developer 3177325fc9f4SBarry Smith 3178325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 3179325fc9f4SBarry Smith 3180325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 3181325fc9f4SBarry Smith */ 31827087cfbeSBarry Smith PetscErrorCode TSComputeFunction_Matlab(TS snes,PetscReal time,Vec x,Vec xdot,Vec y, void *ctx) 3183325fc9f4SBarry Smith { 3184325fc9f4SBarry Smith PetscErrorCode ierr; 3185325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext *)ctx; 3186325fc9f4SBarry Smith int nlhs = 1,nrhs = 7; 3187325fc9f4SBarry Smith mxArray *plhs[1],*prhs[7]; 3188325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,ly = 0,ls = 0; 3189325fc9f4SBarry Smith 3190325fc9f4SBarry Smith PetscFunctionBegin; 3191325fc9f4SBarry Smith PetscValidHeaderSpecific(snes,TS_CLASSID,1); 3192325fc9f4SBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,3); 3193325fc9f4SBarry Smith PetscValidHeaderSpecific(xdot,VEC_CLASSID,4); 3194325fc9f4SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,5); 3195325fc9f4SBarry Smith PetscCheckSameComm(snes,1,x,3); 3196325fc9f4SBarry Smith PetscCheckSameComm(snes,1,y,5); 3197325fc9f4SBarry Smith 3198325fc9f4SBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 3199325fc9f4SBarry Smith ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr); 3200880f3077SBarry Smith ierr = PetscMemcpy(&lxdot,&xdot,sizeof(xdot));CHKERRQ(ierr); 3201325fc9f4SBarry Smith ierr = PetscMemcpy(&ly,&y,sizeof(x));CHKERRQ(ierr); 3202325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 3203325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar(time); 3204325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 3205325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 3206325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)ly); 3207325fc9f4SBarry Smith prhs[5] = mxCreateString(sctx->funcname); 3208325fc9f4SBarry Smith prhs[6] = sctx->ctx; 3209325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr); 3210325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 3211325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 3212325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 3213325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 3214325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 3215325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 3216325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 3217325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 3218325fc9f4SBarry Smith PetscFunctionReturn(0); 3219325fc9f4SBarry Smith } 3220325fc9f4SBarry Smith 3221325fc9f4SBarry Smith 3222325fc9f4SBarry Smith #undef __FUNCT__ 3223325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab" 3224325fc9f4SBarry Smith /* 3225325fc9f4SBarry Smith TSSetFunctionMatlab - Sets the function evaluation routine and function 3226325fc9f4SBarry Smith vector for use by the TS routines in solving ODEs 3227e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 3228325fc9f4SBarry Smith 3229325fc9f4SBarry Smith Logically Collective on TS 3230325fc9f4SBarry Smith 3231325fc9f4SBarry Smith Input Parameters: 3232325fc9f4SBarry Smith + ts - the TS context 3233325fc9f4SBarry Smith - func - function evaluation routine 3234325fc9f4SBarry Smith 3235325fc9f4SBarry Smith Calling sequence of func: 3236325fc9f4SBarry Smith $ func (TS ts,PetscReal time,Vec x,Vec xdot,Vec f,void *ctx); 3237325fc9f4SBarry Smith 3238325fc9f4SBarry Smith Level: beginner 3239325fc9f4SBarry Smith 3240325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 3241325fc9f4SBarry Smith 3242325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 3243325fc9f4SBarry Smith */ 3244cdcf91faSSean Farley PetscErrorCode TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx) 3245325fc9f4SBarry Smith { 3246325fc9f4SBarry Smith PetscErrorCode ierr; 3247325fc9f4SBarry Smith TSMatlabContext *sctx; 3248325fc9f4SBarry Smith 3249325fc9f4SBarry Smith PetscFunctionBegin; 3250325fc9f4SBarry Smith /* currently sctx is memory bleed */ 3251325fc9f4SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 3252325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 3253325fc9f4SBarry Smith /* 3254325fc9f4SBarry Smith This should work, but it doesn't 3255325fc9f4SBarry Smith sctx->ctx = ctx; 3256325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 3257325fc9f4SBarry Smith */ 3258325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 3259cdcf91faSSean Farley ierr = TSSetIFunction(ts,PETSC_NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr); 3260325fc9f4SBarry Smith PetscFunctionReturn(0); 3261325fc9f4SBarry Smith } 3262325fc9f4SBarry Smith 3263325fc9f4SBarry Smith #undef __FUNCT__ 3264325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab" 3265325fc9f4SBarry Smith /* 3266325fc9f4SBarry Smith TSComputeJacobian_Matlab - Calls the function that has been set with 3267325fc9f4SBarry Smith TSSetJacobianMatlab(). 3268325fc9f4SBarry Smith 3269325fc9f4SBarry Smith Collective on TS 3270325fc9f4SBarry Smith 3271325fc9f4SBarry Smith Input Parameters: 3272cdcf91faSSean Farley + ts - the TS context 3273325fc9f4SBarry Smith . x - input vector 3274325fc9f4SBarry Smith . A, B - the matrices 3275325fc9f4SBarry Smith - ctx - user context 3276325fc9f4SBarry Smith 3277325fc9f4SBarry Smith Output Parameter: 3278325fc9f4SBarry Smith . flag - structure of the matrix 3279325fc9f4SBarry Smith 3280325fc9f4SBarry Smith Level: developer 3281325fc9f4SBarry Smith 3282325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 3283325fc9f4SBarry Smith 3284325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 3285325fc9f4SBarry Smith @*/ 3286cdcf91faSSean Farley PetscErrorCode TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec x,Vec xdot,PetscReal shift,Mat *A,Mat *B,MatStructure *flag, void *ctx) 3287325fc9f4SBarry Smith { 3288325fc9f4SBarry Smith PetscErrorCode ierr; 3289325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext *)ctx; 3290325fc9f4SBarry Smith int nlhs = 2,nrhs = 9; 3291325fc9f4SBarry Smith mxArray *plhs[2],*prhs[9]; 3292325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0; 3293325fc9f4SBarry Smith 3294325fc9f4SBarry Smith PetscFunctionBegin; 3295cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3296325fc9f4SBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,3); 3297325fc9f4SBarry Smith 3298325fc9f4SBarry Smith /* call Matlab function in ctx with arguments x and y */ 3299325fc9f4SBarry Smith 3300cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 3301325fc9f4SBarry Smith ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr); 3302325fc9f4SBarry Smith ierr = PetscMemcpy(&lxdot,&xdot,sizeof(x));CHKERRQ(ierr); 3303325fc9f4SBarry Smith ierr = PetscMemcpy(&lA,A,sizeof(x));CHKERRQ(ierr); 3304325fc9f4SBarry Smith ierr = PetscMemcpy(&lB,B,sizeof(x));CHKERRQ(ierr); 3305325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 3306325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar((double)time); 3307325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 3308325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 3309325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)shift); 3310325fc9f4SBarry Smith prhs[5] = mxCreateDoubleScalar((double)lA); 3311325fc9f4SBarry Smith prhs[6] = mxCreateDoubleScalar((double)lB); 3312325fc9f4SBarry Smith prhs[7] = mxCreateString(sctx->funcname); 3313325fc9f4SBarry Smith prhs[8] = sctx->ctx; 3314325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr); 3315325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 3316325fc9f4SBarry Smith *flag = (MatStructure) mxGetScalar(plhs[1]);CHKERRQ(ierr); 3317325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 3318325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 3319325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 3320325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 3321325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 3322325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 3323325fc9f4SBarry Smith mxDestroyArray(prhs[6]); 3324325fc9f4SBarry Smith mxDestroyArray(prhs[7]); 3325325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 3326325fc9f4SBarry Smith mxDestroyArray(plhs[1]); 3327325fc9f4SBarry Smith PetscFunctionReturn(0); 3328325fc9f4SBarry Smith } 3329325fc9f4SBarry Smith 3330325fc9f4SBarry Smith 3331325fc9f4SBarry Smith #undef __FUNCT__ 3332325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab" 3333325fc9f4SBarry Smith /* 3334325fc9f4SBarry Smith TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 3335e3c5b3baSBarry 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 3336325fc9f4SBarry Smith 3337325fc9f4SBarry Smith Logically Collective on TS 3338325fc9f4SBarry Smith 3339325fc9f4SBarry Smith Input Parameters: 3340cdcf91faSSean Farley + ts - the TS context 3341325fc9f4SBarry Smith . A,B - Jacobian matrices 3342325fc9f4SBarry Smith . func - function evaluation routine 3343325fc9f4SBarry Smith - ctx - user context 3344325fc9f4SBarry Smith 3345325fc9f4SBarry Smith Calling sequence of func: 3346cdcf91faSSean Farley $ flag = func (TS ts,PetscReal time,Vec x,Vec xdot,Mat A,Mat B,void *ctx); 3347325fc9f4SBarry Smith 3348325fc9f4SBarry Smith 3349325fc9f4SBarry Smith Level: developer 3350325fc9f4SBarry Smith 3351325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 3352325fc9f4SBarry Smith 3353325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 3354325fc9f4SBarry Smith */ 3355cdcf91faSSean Farley PetscErrorCode TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx) 3356325fc9f4SBarry Smith { 3357325fc9f4SBarry Smith PetscErrorCode ierr; 3358325fc9f4SBarry Smith TSMatlabContext *sctx; 3359325fc9f4SBarry Smith 3360325fc9f4SBarry Smith PetscFunctionBegin; 3361325fc9f4SBarry Smith /* currently sctx is memory bleed */ 3362325fc9f4SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 3363325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 3364325fc9f4SBarry Smith /* 3365325fc9f4SBarry Smith This should work, but it doesn't 3366325fc9f4SBarry Smith sctx->ctx = ctx; 3367325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 3368325fc9f4SBarry Smith */ 3369325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 3370cdcf91faSSean Farley ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 3371325fc9f4SBarry Smith PetscFunctionReturn(0); 3372325fc9f4SBarry Smith } 3373325fc9f4SBarry Smith 3374b5b1a830SBarry Smith #undef __FUNCT__ 3375b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab" 3376b5b1a830SBarry Smith /* 3377b5b1a830SBarry Smith TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab(). 3378b5b1a830SBarry Smith 3379b5b1a830SBarry Smith Collective on TS 3380b5b1a830SBarry Smith 3381b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 3382b5b1a830SBarry Smith @*/ 3383cdcf91faSSean Farley PetscErrorCode TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec x, void *ctx) 3384b5b1a830SBarry Smith { 3385b5b1a830SBarry Smith PetscErrorCode ierr; 3386b5b1a830SBarry Smith TSMatlabContext *sctx = (TSMatlabContext *)ctx; 3387a530c242SBarry Smith int nlhs = 1,nrhs = 6; 3388b5b1a830SBarry Smith mxArray *plhs[1],*prhs[6]; 3389b5b1a830SBarry Smith long long int lx = 0,ls = 0; 3390b5b1a830SBarry Smith 3391b5b1a830SBarry Smith PetscFunctionBegin; 3392cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3393b5b1a830SBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,4); 3394b5b1a830SBarry Smith 3395cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 3396b5b1a830SBarry Smith ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr); 3397b5b1a830SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 3398b5b1a830SBarry Smith prhs[1] = mxCreateDoubleScalar((double)it); 3399b5b1a830SBarry Smith prhs[2] = mxCreateDoubleScalar((double)time); 3400b5b1a830SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lx); 3401b5b1a830SBarry Smith prhs[4] = mxCreateString(sctx->funcname); 3402b5b1a830SBarry Smith prhs[5] = sctx->ctx; 3403b5b1a830SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr); 3404b5b1a830SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 3405b5b1a830SBarry Smith mxDestroyArray(prhs[0]); 3406b5b1a830SBarry Smith mxDestroyArray(prhs[1]); 3407b5b1a830SBarry Smith mxDestroyArray(prhs[2]); 3408b5b1a830SBarry Smith mxDestroyArray(prhs[3]); 3409b5b1a830SBarry Smith mxDestroyArray(prhs[4]); 3410b5b1a830SBarry Smith mxDestroyArray(plhs[0]); 3411b5b1a830SBarry Smith PetscFunctionReturn(0); 3412b5b1a830SBarry Smith } 3413b5b1a830SBarry Smith 3414b5b1a830SBarry Smith 3415b5b1a830SBarry Smith #undef __FUNCT__ 3416b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab" 3417b5b1a830SBarry Smith /* 3418b5b1a830SBarry Smith TSMonitorSetMatlab - Sets the monitor function from Matlab 3419b5b1a830SBarry Smith 3420b5b1a830SBarry Smith Level: developer 3421b5b1a830SBarry Smith 3422b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function 3423b5b1a830SBarry Smith 3424b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 3425b5b1a830SBarry Smith */ 3426cdcf91faSSean Farley PetscErrorCode TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx) 3427b5b1a830SBarry Smith { 3428b5b1a830SBarry Smith PetscErrorCode ierr; 3429b5b1a830SBarry Smith TSMatlabContext *sctx; 3430b5b1a830SBarry Smith 3431b5b1a830SBarry Smith PetscFunctionBegin; 3432b5b1a830SBarry Smith /* currently sctx is memory bleed */ 3433b5b1a830SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 3434b5b1a830SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 3435b5b1a830SBarry Smith /* 3436b5b1a830SBarry Smith This should work, but it doesn't 3437b5b1a830SBarry Smith sctx->ctx = ctx; 3438b5b1a830SBarry Smith mexMakeArrayPersistent(sctx->ctx); 3439b5b1a830SBarry Smith */ 3440b5b1a830SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 3441cdcf91faSSean Farley ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,PETSC_NULL);CHKERRQ(ierr); 3442b5b1a830SBarry Smith PetscFunctionReturn(0); 3443b5b1a830SBarry Smith } 3444325fc9f4SBarry Smith #endif 3445