1 #include <private/tsimpl.h> /*I "petscts.h" I*/ 2 3 PetscFList TSList = PETSC_NULL; 4 PetscBool TSRegisterAllCalled = PETSC_FALSE; 5 6 #undef __FUNCT__ 7 #define __FUNCT__ "TSSetType" 8 /*@C 9 TSSetType - Sets the method for the timestepping solver. 10 11 Collective on TS 12 13 Input Parameters: 14 + ts - The TS context 15 - type - A known method 16 17 Options Database Command: 18 . -ts_type <type> - Sets the method; use -help for a list of available methods (for instance, euler) 19 20 Notes: 21 See "petsc/include/petscts.h" for available methods (for instance) 22 + TSEULER - Euler 23 . TSSUNDIALS - SUNDIALS interface 24 . TSBEULER - Backward Euler 25 - TSPSEUDO - Pseudo-timestepping 26 27 Normally, it is best to use the TSSetFromOptions() command and 28 then set the TS type from the options database rather than by using 29 this routine. Using the options database provides the user with 30 maximum flexibility in evaluating the many different solvers. 31 The TSSetType() routine is provided for those situations where it 32 is necessary to set the timestepping solver independently of the 33 command line or options database. This might be the case, for example, 34 when the choice of solver changes during the execution of the 35 program, and the user's application is taking responsibility for 36 choosing the appropriate method. In other words, this routine is 37 not for beginners. 38 39 Level: intermediate 40 41 .keywords: TS, set, type 42 43 @*/ 44 PetscErrorCode TSSetType(TS ts,const TSType type) 45 { 46 PetscErrorCode (*r)(TS); 47 PetscBool match; 48 PetscErrorCode ierr; 49 50 PetscFunctionBegin; 51 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 52 ierr = PetscTypeCompare((PetscObject) ts, type, &match);CHKERRQ(ierr); 53 if (match) PetscFunctionReturn(0); 54 55 ierr = PetscFListFind( TSList,((PetscObject)ts)->comm, type,PETSC_TRUE, (void (**)(void)) &r);CHKERRQ(ierr); 56 if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown TS type: %s", type); 57 if (ts->ops->destroy) { 58 ierr = (*(ts)->ops->destroy)(ts);CHKERRQ(ierr); 59 } 60 ts->setupcalled = PETSC_FALSE; 61 ierr = PetscObjectChangeTypeName((PetscObject)ts, type);CHKERRQ(ierr); 62 ierr = (*r)(ts);CHKERRQ(ierr); 63 #if defined(PETSC_HAVE_AMS) 64 if (PetscAMSPublishAll) { 65 ierr = PetscObjectAMSPublish((PetscObject)ts);CHKERRQ(ierr); 66 } 67 #endif 68 PetscFunctionReturn(0); 69 } 70 71 #undef __FUNCT__ 72 #define __FUNCT__ "TSGetType" 73 /*@C 74 TSGetType - Gets the TS method type (as a string). 75 76 Not Collective 77 78 Input Parameter: 79 . ts - The TS 80 81 Output Parameter: 82 . type - The name of TS method 83 84 Level: intermediate 85 86 .keywords: TS, timestepper, get, type, name 87 .seealso TSSetType() 88 @*/ 89 PetscErrorCode TSGetType(TS ts, const TSType *type) 90 { 91 PetscFunctionBegin; 92 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 93 PetscValidPointer(type,2); 94 *type = ((PetscObject)ts)->type_name; 95 PetscFunctionReturn(0); 96 } 97 98 /*--------------------------------------------------------------------------------------------------------------------*/ 99 100 #undef __FUNCT__ 101 #define __FUNCT__ "TSRegister" 102 /*@C 103 TSRegister - See TSRegisterDynamic() 104 105 Level: advanced 106 @*/ 107 PetscErrorCode TSRegister(const char sname[], const char path[], const char name[], PetscErrorCode (*function)(TS)) 108 { 109 char fullname[PETSC_MAX_PATH_LEN]; 110 PetscErrorCode ierr; 111 112 PetscFunctionBegin; 113 ierr = PetscStrcpy(fullname, path);CHKERRQ(ierr); 114 ierr = PetscStrcat(fullname, ":");CHKERRQ(ierr); 115 ierr = PetscStrcat(fullname, name);CHKERRQ(ierr); 116 ierr = PetscFListAdd(&TSList, sname, fullname, (void (*)(void)) function);CHKERRQ(ierr); 117 PetscFunctionReturn(0); 118 } 119 120 /*-------------------------------------------------------------------------------------------------------------------*/ 121 #undef __FUNCT__ 122 #define __FUNCT__ "TSRegisterDestroy" 123 /*@C 124 TSRegisterDestroy - Frees the list of timestepping routines that were registered by TSRegister()/TSRegisterDynamic(). 125 126 Not Collective 127 128 Level: advanced 129 130 .keywords: TS, timestepper, register, destroy 131 .seealso: TSRegister(), TSRegisterAll(), TSRegisterDynamic() 132 @*/ 133 PetscErrorCode TSRegisterDestroy(void) 134 { 135 PetscErrorCode ierr; 136 137 PetscFunctionBegin; 138 ierr = PetscFListDestroy(&TSList);CHKERRQ(ierr); 139 TSRegisterAllCalled = PETSC_FALSE; 140 PetscFunctionReturn(0); 141 } 142