1bc952696SBarry Smith 2af0996ceSBarry Smith #include <petsc/private/tsimpl.h> /*I "petscts.h" I*/ 3bc952696SBarry Smith 4bc952696SBarry Smith PetscFunctionList TSTrajectoryList = NULL; 5bc952696SBarry Smith PetscBool TSTrajectoryRegisterAllCalled = PETSC_FALSE; 6bc952696SBarry Smith PetscClassId TSTRAJECTORY_CLASSID; 7d0d044f3SHong Zhang PetscLogEvent TSTrajectory_Set, TSTrajectory_Get; 8bc952696SBarry Smith 9bc952696SBarry Smith /*@C 10bc952696SBarry Smith TSTrajectoryRegister - Adds a way of storing trajectories to the TS package 11bc952696SBarry Smith 12bc952696SBarry Smith Not Collective 13bc952696SBarry Smith 14bc952696SBarry Smith Input Parameters: 153c0fce88SHong Zhang + name - the name of a new user-defined creation routine 163c0fce88SHong Zhang - create_func - the creation routine itself 17bc952696SBarry Smith 18bc952696SBarry Smith Notes: 19bc952696SBarry Smith TSTrajectoryRegister() may be called multiple times to add several user-defined tses. 20bc952696SBarry Smith 21df5474d8SHong Zhang Level: developer 22bc952696SBarry Smith 233c0fce88SHong Zhang .keywords: TS, trajectory, timestep, register 24bc952696SBarry Smith 253c0fce88SHong Zhang .seealso: TSTrajectoryRegisterAll() 26bc952696SBarry Smith @*/ 27972caf09SHong Zhang PetscErrorCode TSTrajectoryRegister(const char sname[],PetscErrorCode (*function)(TSTrajectory,TS)) 28bc952696SBarry Smith { 29bc952696SBarry Smith PetscErrorCode ierr; 30bc952696SBarry Smith 31bc952696SBarry Smith PetscFunctionBegin; 32bc952696SBarry Smith ierr = PetscFunctionListAdd(&TSTrajectoryList,sname,function);CHKERRQ(ierr); 33bc952696SBarry Smith PetscFunctionReturn(0); 34bc952696SBarry Smith } 35bc952696SBarry Smith 36bc952696SBarry Smith PetscErrorCode TSTrajectorySet(TSTrajectory tj,TS ts,PetscInt stepnum,PetscReal time,Vec X) 37bc952696SBarry Smith { 38bc952696SBarry Smith PetscErrorCode ierr; 39bc952696SBarry Smith 40bc952696SBarry Smith PetscFunctionBegin; 41bc952696SBarry Smith if (!tj) PetscFunctionReturn(0); 42d0d044f3SHong Zhang ierr = PetscLogEventBegin(TSTrajectory_Set,tj,ts,0,0);CHKERRQ(ierr); 43bc952696SBarry Smith ierr = (*tj->ops->set)(tj,ts,stepnum,time,X);CHKERRQ(ierr); 44d0d044f3SHong Zhang ierr = PetscLogEventEnd(TSTrajectory_Set,tj,ts,0,0);CHKERRQ(ierr); 45bc952696SBarry Smith PetscFunctionReturn(0); 46bc952696SBarry Smith } 47bc952696SBarry Smith 48c679fc15SHong Zhang PetscErrorCode TSTrajectoryGet(TSTrajectory tj,TS ts,PetscInt stepnum,PetscReal *time) 49bc952696SBarry Smith { 50bc952696SBarry Smith PetscErrorCode ierr; 51bc952696SBarry Smith 52bc952696SBarry Smith PetscFunctionBegin; 53bc952696SBarry Smith if (!tj) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TS solver did not save trajectory"); 54d0d044f3SHong Zhang ierr = PetscLogEventBegin(TSTrajectory_Get,tj,ts,0,0);CHKERRQ(ierr); 55bc952696SBarry Smith ierr = (*tj->ops->get)(tj,ts,stepnum,time);CHKERRQ(ierr); 56d0d044f3SHong Zhang ierr = PetscLogEventEnd(TSTrajectory_Get,tj,ts,0,0);CHKERRQ(ierr); 57bc952696SBarry Smith PetscFunctionReturn(0); 58bc952696SBarry Smith } 59bc952696SBarry Smith 60bc952696SBarry Smith /*@C 61bc952696SBarry Smith TSTrajectoryView - Prints information about the trajectory object 62bc952696SBarry Smith 63bc952696SBarry Smith Collective on TSTrajectory 64bc952696SBarry Smith 65bc952696SBarry Smith Input Parameters: 66b1d74d50SHong Zhang + tj - the TSTrajectory context obtained from TSTrajectoryCreate() 67bc952696SBarry Smith - viewer - visualization context 68bc952696SBarry Smith 69bc952696SBarry Smith Options Database Key: 70e210cd0eSHong Zhang . -ts_trajectory_view - calls TSTrajectoryView() at end of TSAdjointStep() 71bc952696SBarry Smith 72bc952696SBarry Smith Notes: 73bc952696SBarry Smith The available visualization contexts include 74bc952696SBarry Smith + PETSC_VIEWER_STDOUT_SELF - standard output (default) 75bc952696SBarry Smith - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 76bc952696SBarry Smith output where only the first processor opens 77bc952696SBarry Smith the file. All other processors send their 78bc952696SBarry Smith data to the first processor to print. 79bc952696SBarry Smith 80bc952696SBarry Smith The user can open an alternative visualization context with 81bc952696SBarry Smith PetscViewerASCIIOpen() - output to a specified file. 82bc952696SBarry Smith 83df5474d8SHong Zhang Level: developer 84bc952696SBarry Smith 853c0fce88SHong Zhang .keywords: TS, trajectory, timestep, view 86bc952696SBarry Smith 87bc952696SBarry Smith .seealso: PetscViewerASCIIOpen() 88bc952696SBarry Smith @*/ 89b1d74d50SHong Zhang PetscErrorCode TSTrajectoryView(TSTrajectory tj,PetscViewer viewer) 90bc952696SBarry Smith { 91bc952696SBarry Smith PetscErrorCode ierr; 92bc952696SBarry Smith PetscBool iascii; 93bc952696SBarry Smith 94bc952696SBarry Smith PetscFunctionBegin; 951a5a771fSHong Zhang PetscValidHeaderSpecific(tj,TSTRAJECTORY_CLASSID,1); 96bc952696SBarry Smith if (!viewer) { 97b1d74d50SHong Zhang ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)tj),&viewer);CHKERRQ(ierr); 98bc952696SBarry Smith } 99bc952696SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 100b1d74d50SHong Zhang PetscCheckSameComm(tj,1,viewer,2); 101bc952696SBarry Smith 102bc952696SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 103bc952696SBarry Smith if (iascii) { 104b1d74d50SHong Zhang ierr = PetscObjectPrintClassNamePrefixType((PetscObject)tj,viewer);CHKERRQ(ierr); 1051a5a771fSHong Zhang ierr = PetscViewerASCIIPrintf(viewer," total number of recomputations for adjoint calculation = %D\n",tj->recomps);CHKERRQ(ierr); 10653b27ddbSHong Zhang ierr = PetscViewerASCIIPrintf(viewer," disk checkpoint reads = %D\n",tj->diskreads);CHKERRQ(ierr); 10753b27ddbSHong Zhang ierr = PetscViewerASCIIPrintf(viewer," disk checkpoint writes = %D\n",tj->diskwrites);CHKERRQ(ierr); 108b1d74d50SHong Zhang if (tj->ops->view) { 109285336bfSHong Zhang ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 110b1d74d50SHong Zhang ierr = (*tj->ops->view)(tj,viewer);CHKERRQ(ierr); 111285336bfSHong Zhang ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 112bc952696SBarry Smith } 113bc952696SBarry Smith } 114bc952696SBarry Smith PetscFunctionReturn(0); 115bc952696SBarry Smith } 116bc952696SBarry Smith 117bc952696SBarry Smith /*@C 11878fbdcc8SBarry Smith TSTrajectorySetVariableNames - Sets the name of each component in the solution vector so that it may be saved with the trajectory 11978fbdcc8SBarry Smith 12078fbdcc8SBarry Smith Collective on TSTrajectory 12178fbdcc8SBarry Smith 12278fbdcc8SBarry Smith Input Parameters: 12378fbdcc8SBarry Smith + tr - the trajectory context 12478fbdcc8SBarry Smith - names - the names of the components, final string must be NULL 12578fbdcc8SBarry Smith 12678fbdcc8SBarry Smith Level: intermediate 12778fbdcc8SBarry Smith 128*db901c5bSHong Zhang Note: Fortran interface is not possible because of the string array argument 129*db901c5bSHong Zhang 13078fbdcc8SBarry Smith .keywords: TS, TSTrajectory, vector, monitor, view 13178fbdcc8SBarry Smith 13278fbdcc8SBarry Smith .seealso: TSTrajectory, TSGetTrajectory() 13378fbdcc8SBarry Smith @*/ 13478fbdcc8SBarry Smith PetscErrorCode TSTrajectorySetVariableNames(TSTrajectory ctx,const char * const *names) 13578fbdcc8SBarry Smith { 13678fbdcc8SBarry Smith PetscErrorCode ierr; 13778fbdcc8SBarry Smith 13878fbdcc8SBarry Smith PetscFunctionBegin; 13978fbdcc8SBarry Smith ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr); 14078fbdcc8SBarry Smith ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr); 14178fbdcc8SBarry Smith PetscFunctionReturn(0); 14278fbdcc8SBarry Smith } 14378fbdcc8SBarry Smith 14478fbdcc8SBarry Smith /*@C 14508347785SBarry Smith TSTrjactorySetTransform - Solution vector will be transformed by provided function before being saved to disk 14608347785SBarry Smith 14708347785SBarry Smith Collective on TSLGCtx 14808347785SBarry Smith 14908347785SBarry Smith Input Parameters: 15008347785SBarry Smith + tj - the TSTrajectory context 15108347785SBarry Smith . transform - the transform function 15208347785SBarry Smith . destroy - function to destroy the optional context 15308347785SBarry Smith - ctx - optional context used by transform function 15408347785SBarry Smith 15508347785SBarry Smith Level: intermediate 15608347785SBarry Smith 15708347785SBarry Smith .keywords: TSTrajectory, vector, monitor, view 15808347785SBarry Smith 15908347785SBarry Smith .seealso: TSTrajectorySetVariableNames(), TSTrajectory, TSMonitorLGSetTransform() 16008347785SBarry Smith @*/ 16108347785SBarry Smith PetscErrorCode TSTrajectorySetTransform(TSTrajectory tj,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 16208347785SBarry Smith { 16308347785SBarry Smith PetscFunctionBegin; 16408347785SBarry Smith tj->transform = transform; 16508347785SBarry Smith tj->transformdestroy = destroy; 16608347785SBarry Smith tj->transformctx = tctx; 16708347785SBarry Smith PetscFunctionReturn(0); 16808347785SBarry Smith } 16908347785SBarry Smith 17008347785SBarry Smith 171*db901c5bSHong Zhang /*@ 172bc952696SBarry Smith TSTrajectoryCreate - This function creates an empty trajectory object used to store the time dependent solution of an ODE/DAE 173bc952696SBarry Smith 174bc952696SBarry Smith Collective on MPI_Comm 175bc952696SBarry Smith 176bc952696SBarry Smith Input Parameter: 1773c0fce88SHong Zhang . comm - the communicator 178bc952696SBarry Smith 179bc952696SBarry Smith Output Parameter: 1803c0fce88SHong Zhang . tj - the trajectory object 181bc952696SBarry Smith 182df5474d8SHong Zhang Level: developer 183bc952696SBarry Smith 1843c0fce88SHong Zhang Notes: Usually one does not call this routine, it is called automatically when one calls TSSetSaveTrajectory(). 185bc952696SBarry Smith 1863c0fce88SHong Zhang .keywords: TS, trajectory, create 1873c0fce88SHong Zhang 18864fc91eeSBarry Smith .seealso: TSTrajectorySetUp(), TSTrajectoryDestroy(), TSTrajectorySetType(), TSTrajectorySetVariableNames(), TSGetTrajectory(), TSTrajectorySetKeepFiles() 189bc952696SBarry Smith @*/ 190b1d74d50SHong Zhang PetscErrorCode TSTrajectoryCreate(MPI_Comm comm,TSTrajectory *tj) 191bc952696SBarry Smith { 192bc952696SBarry Smith TSTrajectory t; 193bc952696SBarry Smith PetscErrorCode ierr; 194bc952696SBarry Smith 195bc952696SBarry Smith PetscFunctionBegin; 196b1d74d50SHong Zhang PetscValidPointer(tj,2); 197b1d74d50SHong Zhang *tj = NULL; 198bc952696SBarry Smith ierr = TSInitializePackage();CHKERRQ(ierr); 199bc952696SBarry Smith 20073107ff1SLisandro Dalcin ierr = PetscHeaderCreate(t,TSTRAJECTORY_CLASSID,"TSTrajectory","Time stepping","TS",comm,TSTrajectoryDestroy,TSTrajectoryView);CHKERRQ(ierr); 20168bece0bSHong Zhang t->setupcalled = PETSC_FALSE; 20264fc91eeSBarry Smith t->keepfiles = PETSC_TRUE; 203b1d74d50SHong Zhang *tj = t; 204bc952696SBarry Smith PetscFunctionReturn(0); 205bc952696SBarry Smith } 206bc952696SBarry Smith 207bc952696SBarry Smith /*@C 208bc952696SBarry Smith TSTrajectorySetType - Sets the storage method to be used as in a trajectory 209bc952696SBarry Smith 210bc952696SBarry Smith Collective on TS 211bc952696SBarry Smith 212bc952696SBarry Smith Input Parameters: 2133c0fce88SHong Zhang + tj - the TSTrajectory context 2143c0fce88SHong Zhang . ts - the TS context 2153c0fce88SHong Zhang - type - a known method 216bc952696SBarry Smith 217bc952696SBarry Smith Options Database Command: 218e210cd0eSHong Zhang . -ts_trajectory_type <type> - Sets the method; use -help for a list of available methods (for instance, basic) 219bc952696SBarry Smith 220df5474d8SHong Zhang Level: developer 221bc952696SBarry Smith 2223c0fce88SHong Zhang .keywords: TS, trajectory, timestep, set, type 223bc952696SBarry Smith 2243c0fce88SHong Zhang .seealso: TS, TSTrajectoryCreate(), TSTrajectorySetFromOptions(), TSTrajectoryDestroy() 225bc952696SBarry Smith 226bc952696SBarry Smith @*/ 227972caf09SHong Zhang PetscErrorCode TSTrajectorySetType(TSTrajectory tj,TS ts,const TSTrajectoryType type) 228bc952696SBarry Smith { 229972caf09SHong Zhang PetscErrorCode (*r)(TSTrajectory,TS); 230bc952696SBarry Smith PetscBool match; 231bc952696SBarry Smith PetscErrorCode ierr; 232bc952696SBarry Smith 233bc952696SBarry Smith PetscFunctionBegin; 234972caf09SHong Zhang PetscValidHeaderSpecific(tj,TSTRAJECTORY_CLASSID,1); 235972caf09SHong Zhang ierr = PetscObjectTypeCompare((PetscObject)tj,type,&match);CHKERRQ(ierr); 236bc952696SBarry Smith if (match) PetscFunctionReturn(0); 237bc952696SBarry Smith 238bc952696SBarry Smith ierr = PetscFunctionListFind(TSTrajectoryList,type,&r);CHKERRQ(ierr); 239bc952696SBarry Smith if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown TSTrajectory type: %s",type); 240972caf09SHong Zhang if (tj->ops->destroy) { 241972caf09SHong Zhang ierr = (*(tj)->ops->destroy)(tj);CHKERRQ(ierr); 242bc952696SBarry Smith 243972caf09SHong Zhang tj->ops->destroy = NULL; 244bc952696SBarry Smith } 245972caf09SHong Zhang ierr = PetscMemzero(tj->ops,sizeof(*tj->ops));CHKERRQ(ierr); 246bc952696SBarry Smith 247972caf09SHong Zhang ierr = PetscObjectChangeTypeName((PetscObject)tj,type);CHKERRQ(ierr); 248972caf09SHong Zhang ierr = (*r)(tj,ts);CHKERRQ(ierr); 249bc952696SBarry Smith PetscFunctionReturn(0); 250bc952696SBarry Smith } 251bc952696SBarry Smith 252972caf09SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryCreate_Basic(TSTrajectory,TS); 253972caf09SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryCreate_Singlefile(TSTrajectory,TS); 2549a53571cSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryCreate_Memory(TSTrajectory,TS); 2552b043167SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryCreate_Visualization(TSTrajectory,TS); 256bc952696SBarry Smith 257bc952696SBarry Smith /*@C 258bc952696SBarry Smith TSTrajectoryRegisterAll - Registers all of the trajectory storage schecmes in the TS package. 259bc952696SBarry Smith 260bc952696SBarry Smith Not Collective 261bc952696SBarry Smith 262df5474d8SHong Zhang Level: developer 263bc952696SBarry Smith 2643c0fce88SHong Zhang .keywords: TS, trajectory, register, all 2653c0fce88SHong Zhang 2663c0fce88SHong Zhang .seealso: TSTrajectoryRegister() 267bc952696SBarry Smith @*/ 268bc952696SBarry Smith PetscErrorCode TSTrajectoryRegisterAll(void) 269bc952696SBarry Smith { 270bc952696SBarry Smith PetscErrorCode ierr; 271bc952696SBarry Smith 272bc952696SBarry Smith PetscFunctionBegin; 273560360afSLisandro Dalcin if (TSTrajectoryRegisterAllCalled) PetscFunctionReturn(0); 274bc952696SBarry Smith TSTrajectoryRegisterAllCalled = PETSC_TRUE; 275bc952696SBarry Smith 276bc952696SBarry Smith ierr = TSTrajectoryRegister(TSTRAJECTORYBASIC,TSTrajectoryCreate_Basic);CHKERRQ(ierr); 2771c8c567eSBarry Smith ierr = TSTrajectoryRegister(TSTRAJECTORYSINGLEFILE,TSTrajectoryCreate_Singlefile);CHKERRQ(ierr); 2789a53571cSHong Zhang ierr = TSTrajectoryRegister(TSTRAJECTORYMEMORY,TSTrajectoryCreate_Memory);CHKERRQ(ierr); 2792b043167SHong Zhang ierr = TSTrajectoryRegister(TSTRAJECTORYVISUALIZATION,TSTrajectoryCreate_Visualization);CHKERRQ(ierr); 280bc952696SBarry Smith PetscFunctionReturn(0); 281bc952696SBarry Smith } 282bc952696SBarry Smith 283bc952696SBarry Smith /*@ 284bc952696SBarry Smith TSTrajectoryDestroy - Destroys a trajectory context 285bc952696SBarry Smith 286bc952696SBarry Smith Collective on TSTrajectory 287bc952696SBarry Smith 288bc952696SBarry Smith Input Parameter: 2893c0fce88SHong Zhang . tj - the TSTrajectory context obtained from TSTrajectoryCreate() 290bc952696SBarry Smith 291df5474d8SHong Zhang Level: developer 292bc952696SBarry Smith 2933c0fce88SHong Zhang .keywords: TS, trajectory, timestep, destroy 294bc952696SBarry Smith 2953c0fce88SHong Zhang .seealso: TSTrajectoryCreate(), TSTrajectorySetUp() 296bc952696SBarry Smith @*/ 297972caf09SHong Zhang PetscErrorCode TSTrajectoryDestroy(TSTrajectory *tj) 298bc952696SBarry Smith { 299bc952696SBarry Smith PetscErrorCode ierr; 300bc952696SBarry Smith 301bc952696SBarry Smith PetscFunctionBegin; 302972caf09SHong Zhang if (!*tj) PetscFunctionReturn(0); 303972caf09SHong Zhang PetscValidHeaderSpecific((*tj),TSTRAJECTORY_CLASSID,1); 304972caf09SHong Zhang if (--((PetscObject)(*tj))->refct > 0) {*tj = 0; PetscFunctionReturn(0);} 305bc952696SBarry Smith 3067f79407eSBarry Smith if ((*tj)->transformdestroy) {ierr = (*(*tj)->transformdestroy)((*tj)->transformctx);CHKERRQ(ierr);} 307972caf09SHong Zhang if ((*tj)->ops->destroy) {ierr = (*(*tj)->ops->destroy)((*tj));CHKERRQ(ierr);} 308aced365eSHong Zhang ierr = PetscViewerDestroy(&(*tj)->monitor);CHKERRQ(ierr); 30978fbdcc8SBarry Smith ierr = PetscStrArrayDestroy(&(*tj)->names);CHKERRQ(ierr); 31064e38db7SHong Zhang ierr = PetscFree((*tj)->dirname);CHKERRQ(ierr); 31164e38db7SHong Zhang ierr = PetscFree((*tj)->filetemplate);CHKERRQ(ierr); 312972caf09SHong Zhang ierr = PetscHeaderDestroy(tj);CHKERRQ(ierr); 313bc952696SBarry Smith PetscFunctionReturn(0); 314bc952696SBarry Smith } 315bc952696SBarry Smith 316bc952696SBarry Smith /* 317772b2523SBarry Smith TSTrajectorySetTypeFromOptions_Private - Sets the type of ts from user options. 318bc952696SBarry Smith 319bc952696SBarry Smith Collective on TSTrajectory 320bc952696SBarry Smith 321bc952696SBarry Smith Input Parameter: 3223c0fce88SHong Zhang + tj - the TSTrajectory context 3233c0fce88SHong Zhang - ts - the TS context 3243c0fce88SHong Zhang 3253c0fce88SHong Zhang Options Database Keys: 3263c0fce88SHong Zhang . -ts_trajectory_type <type> - TSTRAJECTORYBASIC, TSTRAJECTORYMEMORY, TSTRAJECTORYSINGLEFILE, TSTRAJECTORYVISUALIZATION 327bc952696SBarry Smith 328df5474d8SHong Zhang Level: developer 329bc952696SBarry Smith 3303c0fce88SHong Zhang .keywords: TS, trajectory, set, options, type 3313c0fce88SHong Zhang 3323c0fce88SHong Zhang .seealso: TSTrajectorySetFromOptions(), TSTrajectorySetType() 333bc952696SBarry Smith */ 3342bfe6b3fSBarry Smith static PetscErrorCode TSTrajectorySetTypeFromOptions_Private(PetscOptionItems *PetscOptionsObject,TSTrajectory tj,TS ts) 335bc952696SBarry Smith { 336bc952696SBarry Smith PetscBool opt; 337bc952696SBarry Smith const char *defaultType; 338bc952696SBarry Smith char typeName[256]; 3399a53571cSHong Zhang PetscBool flg; 340bc952696SBarry Smith PetscErrorCode ierr; 341bc952696SBarry Smith 342bc952696SBarry Smith PetscFunctionBegin; 343b1d74d50SHong Zhang if (((PetscObject)tj)->type_name) defaultType = ((PetscObject)tj)->type_name; 344bc952696SBarry Smith else defaultType = TSTRAJECTORYBASIC; 345bc952696SBarry Smith 346560360afSLisandro Dalcin ierr = TSTrajectoryRegisterAll();CHKERRQ(ierr); 347e210cd0eSHong Zhang ierr = PetscOptionsFList("-ts_trajectory_type","TSTrajectory method","TSTrajectorySetType",TSTrajectoryList,defaultType,typeName,256,&opt);CHKERRQ(ierr); 348bc952696SBarry Smith if (opt) { 349f416af30SBarry Smith ierr = PetscStrcmp(typeName,TSTRAJECTORYMEMORY,&flg);CHKERRQ(ierr); 350972caf09SHong Zhang ierr = TSTrajectorySetType(tj,ts,typeName);CHKERRQ(ierr); 351bc952696SBarry Smith } else { 352972caf09SHong Zhang ierr = TSTrajectorySetType(tj,ts,defaultType);CHKERRQ(ierr); 353bc952696SBarry Smith } 354bc952696SBarry Smith PetscFunctionReturn(0); 355bc952696SBarry Smith } 356bc952696SBarry Smith 357ed695a29SHong Zhang /*@ 358ed695a29SHong Zhang TSTrajectorySetMonitor - Monitor the schedules generated by the checkpointing controller 359ed695a29SHong Zhang 360ed695a29SHong Zhang Collective on TSTrajectory 361ed695a29SHong Zhang 362ed695a29SHong Zhang Input Arguments: 363ed695a29SHong Zhang + tj - the TSTrajectory context 364ed695a29SHong Zhang - flg - PETSC_TRUE to active a monitor, PETSC_FALSE to disable 365ed695a29SHong Zhang 3663c0fce88SHong Zhang Options Database Keys: 367063c0c7aSHong Zhang . -ts_trajectory_monitor - print TSTrajectory information 3683c0fce88SHong Zhang 369df5474d8SHong Zhang Level: developer 370ed695a29SHong Zhang 3713c0fce88SHong Zhang .keywords: TS, trajectory, set, monitor 3723c0fce88SHong Zhang 3733c0fce88SHong Zhang .seealso: TSTrajectoryCreate(), TSTrajectoryDestroy(), TSTrajectorySetUp() 374ed695a29SHong Zhang @*/ 3752bee684fSHong Zhang PetscErrorCode TSTrajectorySetMonitor(TSTrajectory tj,PetscBool flg) 376ed695a29SHong Zhang { 377ed695a29SHong Zhang PetscErrorCode ierr; 378ed695a29SHong Zhang 379ed695a29SHong Zhang PetscFunctionBegin; 380ed695a29SHong Zhang PetscValidHeaderSpecific(tj,TSTRAJECTORY_CLASSID,1); 381ed695a29SHong Zhang PetscValidLogicalCollectiveBool(tj,flg,2); 382ed695a29SHong Zhang if (flg) { 383ed695a29SHong Zhang if (!tj->monitor) {ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)tj),"stdout",&tj->monitor);CHKERRQ(ierr);} 384ed695a29SHong Zhang } else { 385ed695a29SHong Zhang ierr = PetscViewerDestroy(&tj->monitor);CHKERRQ(ierr); 386ed695a29SHong Zhang } 387ed695a29SHong Zhang PetscFunctionReturn(0); 388ed695a29SHong Zhang } 389ed695a29SHong Zhang 390bc952696SBarry Smith /*@ 39164fc91eeSBarry Smith TSTrajectorySetKeepFiles - Keep the files generated by the TSTrajectory 39264fc91eeSBarry Smith 39364fc91eeSBarry Smith Collective on TSTrajectory 39464fc91eeSBarry Smith 39564fc91eeSBarry Smith Input Arguments: 39664fc91eeSBarry Smith + tj - the TSTrajectory context 39764fc91eeSBarry Smith - flg - PETSC_TRUE to save, PETSC_FALSE to disable 39864fc91eeSBarry Smith 39964fc91eeSBarry Smith Options Database Keys: 40064fc91eeSBarry Smith . -ts_trajectory_keep_files - have it keep the files 40164fc91eeSBarry Smith 40264fc91eeSBarry Smith Notes: By default the TSTrajectory used for adjoint computations, TSTRAJECTORYBASIC, removes the files it generates at the end of the run. This causes the files to be kept. 40364fc91eeSBarry Smith 40464fc91eeSBarry Smith Level: advanced 40564fc91eeSBarry Smith 40664fc91eeSBarry Smith .keywords: TS, trajectory, set, monitor 40764fc91eeSBarry Smith 40864fc91eeSBarry Smith .seealso: TSTrajectoryCreate(), TSTrajectoryDestroy(), TSTrajectorySetUp(), TSTrajectorySetMonitor() 40964fc91eeSBarry Smith @*/ 41064fc91eeSBarry Smith PetscErrorCode TSTrajectorySetKeepFiles(TSTrajectory tj,PetscBool flg) 41164fc91eeSBarry Smith { 41264fc91eeSBarry Smith PetscFunctionBegin; 41364fc91eeSBarry Smith PetscValidHeaderSpecific(tj,TSTRAJECTORY_CLASSID,1); 41464fc91eeSBarry Smith PetscValidLogicalCollectiveBool(tj,flg,2); 41564fc91eeSBarry Smith tj->keepfiles = flg; 41664fc91eeSBarry Smith PetscFunctionReturn(0); 41764fc91eeSBarry Smith } 41864fc91eeSBarry Smith 419*db901c5bSHong Zhang /*@C 42064e38db7SHong Zhang TSTrajectorySetDirname - Specify the name of the directory where disk checkpoints are stored. 42164e38db7SHong Zhang 42264e38db7SHong Zhang Collective on TSTrajectory 42364e38db7SHong Zhang 42464e38db7SHong Zhang Input Arguments: 42564e38db7SHong Zhang + tj - the TSTrajectory context 42664e38db7SHong Zhang - dirname - the directory name 42764e38db7SHong Zhang 42864e38db7SHong Zhang Options Database Keys: 42964e38db7SHong Zhang . -ts_trajectory_dirname - set the directory name 43064e38db7SHong Zhang 43164e38db7SHong Zhang Level: developer 43264e38db7SHong Zhang 43364e38db7SHong Zhang .keywords: TS, trajectory, set 43464e38db7SHong Zhang 43564e38db7SHong Zhang .seealso: TSTrajectorySetFiletemplate(),TSTrajectorySetUp() 43664e38db7SHong Zhang @*/ 43764e38db7SHong Zhang PetscErrorCode TSTrajectorySetDirname(TSTrajectory tj,const char dirname[]) 43864e38db7SHong Zhang { 43964e38db7SHong Zhang PetscErrorCode ierr; 44064e38db7SHong Zhang PetscFunctionBegin; 44164e38db7SHong Zhang PetscValidHeaderSpecific(tj,TSTRAJECTORY_CLASSID,1); 44264e38db7SHong Zhang ierr = PetscStrallocpy(dirname,&tj->dirname);CHKERRQ(ierr); 44364e38db7SHong Zhang PetscFunctionReturn(0); 44464e38db7SHong Zhang } 44564e38db7SHong Zhang 446*db901c5bSHong Zhang /*@C 44764e38db7SHong Zhang TSTrajectorySetFiletemplate - Specify the name template for the files storing checkpoints. 44864e38db7SHong Zhang 44964e38db7SHong Zhang Collective on TSTrajectory 45064e38db7SHong Zhang 45164e38db7SHong Zhang Input Arguments: 45264e38db7SHong Zhang + tj - the TSTrajectory context 45364e38db7SHong Zhang - filetemplate - the directory name 45464e38db7SHong Zhang 45564e38db7SHong Zhang Options Database Keys: 45664e38db7SHong Zhang . -ts_trajectory_file - set the file name template 45764e38db7SHong Zhang 45864e38db7SHong Zhang Level: developer 45964e38db7SHong Zhang 46064e38db7SHong Zhang .keywords: TS, trajectory, set 46164e38db7SHong Zhang 46264e38db7SHong Zhang .seealso: TSTrajectorySetFiletemplate(),TSTrajectorySetUp() 46364e38db7SHong Zhang @*/ 46464e38db7SHong Zhang PetscErrorCode TSTrajectorySetFiletemplate(TSTrajectory tj,const char filetemplate[]) 46564e38db7SHong Zhang { 46664e38db7SHong Zhang PetscErrorCode ierr; 46764e38db7SHong Zhang PetscFunctionBegin; 46864e38db7SHong Zhang PetscValidHeaderSpecific(tj,TSTRAJECTORY_CLASSID,1); 46964e38db7SHong Zhang ierr = PetscStrallocpy(filetemplate,&tj->filetemplate);CHKERRQ(ierr); 47064e38db7SHong Zhang PetscFunctionReturn(0); 47164e38db7SHong Zhang } 47264e38db7SHong Zhang 47364e38db7SHong Zhang /*@ 474bc952696SBarry Smith TSTrajectorySetFromOptions - Sets various TSTrajectory parameters from user options. 475bc952696SBarry Smith 476bc952696SBarry Smith Collective on TSTrajectory 477bc952696SBarry Smith 478bc952696SBarry Smith Input Parameter: 4793c0fce88SHong Zhang + tj - the TSTrajectory context obtained from TSTrajectoryCreate() 4803c0fce88SHong Zhang - ts - the TS context 481bc952696SBarry Smith 482bc952696SBarry Smith Options Database Keys: 4833c0fce88SHong Zhang + -ts_trajectory_type <type> - TSTRAJECTORYBASIC, TSTRAJECTORYMEMORY, TSTRAJECTORYSINGLEFILE, TSTRAJECTORYVISUALIZATION 48464fc91eeSBarry Smith . -ts_trajectory_keep_files <true,false> - keep the files generated by the code after the program ends. This is true by default for TSTRAJECTORYSINGLEFILE, TSTRAJECTORYVISUALIZATION 485063c0c7aSHong Zhang - -ts_trajectory_monitor - print TSTrajectory information 486bc952696SBarry Smith 487df5474d8SHong Zhang Level: developer 488bc952696SBarry Smith 48962b521acSHong Zhang Notes: This is not normally called directly by users 490bc952696SBarry Smith 4913c0fce88SHong Zhang .keywords: TS, trajectory, timestep, set, options, database 492bc952696SBarry Smith 4933c0fce88SHong Zhang .seealso: TSSetSaveTrajectory(), TSTrajectorySetUp() 494bc952696SBarry Smith @*/ 495972caf09SHong Zhang PetscErrorCode TSTrajectorySetFromOptions(TSTrajectory tj,TS ts) 496bc952696SBarry Smith { 497ed695a29SHong Zhang PetscBool set,flg; 49864e38db7SHong Zhang char dirname[PETSC_MAX_PATH_LEN],filetemplate[PETSC_MAX_PATH_LEN]; 49964e38db7SHong Zhang PetscErrorCode ierr; 500bc952696SBarry Smith 501bc952696SBarry Smith PetscFunctionBegin; 502b1d74d50SHong Zhang PetscValidHeaderSpecific(tj,TSTRAJECTORY_CLASSID,1); 503972caf09SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,2); 504b1d74d50SHong Zhang ierr = PetscObjectOptionsBegin((PetscObject)tj);CHKERRQ(ierr); 505972caf09SHong Zhang ierr = TSTrajectorySetTypeFromOptions_Private(PetscOptionsObject,tj,ts);CHKERRQ(ierr); 506ed695a29SHong Zhang ierr = PetscOptionsBool("-ts_trajectory_monitor","Print checkpointing schedules","TSTrajectorySetMonitor",tj->monitor ? PETSC_TRUE:PETSC_FALSE,&flg,&set);CHKERRQ(ierr); 507aced365eSHong Zhang if (set) {ierr = TSTrajectorySetMonitor(tj,flg);CHKERRQ(ierr);} 50864e38db7SHong Zhang 50964fc91eeSBarry Smith ierr = PetscOptionsBool("-ts_trajectory_keep_files","Keep any trajectory files generated during the run","TSTrajectorySetKeepFiles",tj->keepfiles,&flg,&set);CHKERRQ(ierr); 51064fc91eeSBarry Smith if (set) {ierr = TSTrajectorySetKeepFiles(tj,flg);CHKERRQ(ierr);} 51164e38db7SHong Zhang 51264e38db7SHong Zhang ierr = PetscOptionsString("-ts_trajectory_dirname","Directory name for TSTrajectory file","TSTrajectorySetDirname",0,dirname,PETSC_MAX_PATH_LEN-14,&set);CHKERRQ(ierr); 51364e38db7SHong Zhang if (!set) { 51464e38db7SHong Zhang ierr = PetscStrcpy(dirname,"SA-data");CHKERRQ(ierr); 51564e38db7SHong Zhang } 51664e38db7SHong Zhang ierr = TSTrajectorySetDirname(tj,dirname);CHKERRQ(ierr); 51764e38db7SHong Zhang 51864e38db7SHong Zhang ierr = PetscOptionsString("-ts_trajectory_file","Template for TSTrajectory file name, use filename-%06D.bin","TSTrajectorySetFiletemplate",0,filetemplate,PETSC_MAX_PATH_LEN,&set);CHKERRQ(ierr); 51964e38db7SHong Zhang if (set) { 52064e38db7SHong Zhang size_t len; 52164e38db7SHong Zhang const char *ptr,*ptr2; 52264e38db7SHong Zhang if (!filetemplate[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_trajectory_file requires a file name template, e.g. filename-%%06D.bin"); 52364e38db7SHong Zhang /* Do some cursory validation of the input. */ 52464e38db7SHong Zhang ierr = PetscStrstr(filetemplate,"%",(char**)&ptr);CHKERRQ(ierr); 52564e38db7SHong Zhang if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_trajectory_file requires a file name template, e.g. filename-%%06D.bin"); 52664e38db7SHong Zhang for (ptr++; ptr && *ptr; ptr++) { 52764e38db7SHong Zhang ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr); 52864e38db7SHong Zhang if (!ptr2 && (*ptr < '0' || '9' < *ptr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Invalid file template argument to -ts_trajectory_file, should look like filename-%%06D.bin"); 52964e38db7SHong Zhang if (ptr2) break; 53064e38db7SHong Zhang } 53164e38db7SHong Zhang ierr = PetscStrcat(dirname,"/");CHKERRQ(ierr); 53264e38db7SHong Zhang ierr = PetscStrlen(filetemplate,&len);CHKERRQ(ierr); 53364e38db7SHong Zhang ierr = PetscStrncat(dirname,filetemplate,PETSC_MAX_PATH_LEN-len-1);CHKERRQ(ierr); 53464e38db7SHong Zhang } else { 53564e38db7SHong Zhang ierr = PetscStrcat(dirname,"/SA-%06D.bin");CHKERRQ(ierr); 53664e38db7SHong Zhang } 53764e38db7SHong Zhang ierr = TSTrajectorySetFiletemplate(tj,dirname);CHKERRQ(ierr); 53864e38db7SHong Zhang 53964e38db7SHong Zhang /* Handle specific TSTrajectory options */ 54062b521acSHong Zhang if (tj->ops->setfromoptions) { 54162b521acSHong Zhang ierr = (*tj->ops->setfromoptions)(PetscOptionsObject,tj);CHKERRQ(ierr); 54262b521acSHong Zhang } 543bc952696SBarry Smith ierr = PetscOptionsEnd();CHKERRQ(ierr); 544bc952696SBarry Smith PetscFunctionReturn(0); 545bc952696SBarry Smith } 54668bece0bSHong Zhang 54768bece0bSHong Zhang /*@ 54868bece0bSHong Zhang TSTrajectorySetUp - Sets up the internal data structures, e.g. stacks, for the later use 54968bece0bSHong Zhang of a TS trajectory. 55068bece0bSHong Zhang 55168bece0bSHong Zhang Collective on TS 55268bece0bSHong Zhang 55368bece0bSHong Zhang Input Parameter: 5543c0fce88SHong Zhang + ts - the TS context obtained from TSCreate() 5553c0fce88SHong Zhang - tj - the TS trajectory context 55668bece0bSHong Zhang 557df5474d8SHong Zhang Level: developer 55868bece0bSHong Zhang 5593c0fce88SHong Zhang .keywords: TS, trajectory, setup 56068bece0bSHong Zhang 56168bece0bSHong Zhang .seealso: TSSetSaveTrajectory(), TSTrajectoryCreate(), TSTrajectoryDestroy() 56268bece0bSHong Zhang @*/ 56368bece0bSHong Zhang PetscErrorCode TSTrajectorySetUp(TSTrajectory tj,TS ts) 56468bece0bSHong Zhang { 56568bece0bSHong Zhang PetscErrorCode ierr; 56668bece0bSHong Zhang 56768bece0bSHong Zhang PetscFunctionBegin; 56868bece0bSHong Zhang if (!tj) PetscFunctionReturn(0); 56968bece0bSHong Zhang PetscValidHeaderSpecific(tj,TSTRAJECTORY_CLASSID,1); 57068bece0bSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,2); 57168bece0bSHong Zhang if (tj->setupcalled) PetscFunctionReturn(0); 57268bece0bSHong Zhang 57368bece0bSHong Zhang if (!((PetscObject)tj)->type_name) { 57468bece0bSHong Zhang ierr = TSTrajectorySetType(tj,ts,TSTRAJECTORYBASIC);CHKERRQ(ierr); 57568bece0bSHong Zhang } 57668bece0bSHong Zhang if (tj->ops->setup) { 57768bece0bSHong Zhang ierr = (*tj->ops->setup)(tj,ts);CHKERRQ(ierr); 57868bece0bSHong Zhang } 57968bece0bSHong Zhang 58068bece0bSHong Zhang tj->setupcalled = PETSC_TRUE; 58153b27ddbSHong Zhang 58253b27ddbSHong Zhang /* Set the counters to zero */ 5831a5a771fSHong Zhang tj->recomps = 0; 58453b27ddbSHong Zhang tj->diskreads = 0; 58553b27ddbSHong Zhang tj->diskwrites = 0; 58668bece0bSHong Zhang PetscFunctionReturn(0); 58768bece0bSHong Zhang } 588