1 #include <petsc-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,TSType type) 45 { 46 PetscErrorCode (*r)(TS); 47 PetscBool match; 48 PetscErrorCode ierr; 49 50 PetscFunctionBegin; 51 PetscValidHeaderSpecific(ts, TS_CLASSID,1); 52 ierr = PetscObjectTypeCompare((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 ts->ops->destroy = PETSC_NULL; 60 } 61 ierr = PetscMemzero(ts->ops,sizeof(*ts->ops));CHKERRQ(ierr); 62 ts->setupcalled = PETSC_FALSE; 63 ierr = PetscObjectChangeTypeName((PetscObject)ts, type);CHKERRQ(ierr); 64 ierr = (*r)(ts);CHKERRQ(ierr); 65 #if defined(PETSC_HAVE_AMS) 66 if (PetscAMSPublishAll) { 67 ierr = PetscObjectAMSPublish((PetscObject)ts);CHKERRQ(ierr); 68 } 69 #endif 70 PetscFunctionReturn(0); 71 } 72 73 #undef __FUNCT__ 74 #define __FUNCT__ "TSGetType" 75 /*@C 76 TSGetType - Gets the TS method type (as a string). 77 78 Not Collective 79 80 Input Parameter: 81 . ts - The TS 82 83 Output Parameter: 84 . type - The name of TS method 85 86 Level: intermediate 87 88 .keywords: TS, timestepper, get, type, name 89 .seealso TSSetType() 90 @*/ 91 PetscErrorCode TSGetType(TS ts, TSType *type) 92 { 93 PetscFunctionBegin; 94 PetscValidHeaderSpecific(ts,TS_CLASSID,1); 95 PetscValidPointer(type,2); 96 *type = ((PetscObject)ts)->type_name; 97 PetscFunctionReturn(0); 98 } 99 100 /*--------------------------------------------------------------------------------------------------------------------*/ 101 102 #undef __FUNCT__ 103 #define __FUNCT__ "TSRegister" 104 /*@C 105 TSRegister - See TSRegisterDynamic() 106 107 Level: advanced 108 @*/ 109 PetscErrorCode TSRegister(const char sname[], const char path[], const char name[], PetscErrorCode (*function)(TS)) 110 { 111 char fullname[PETSC_MAX_PATH_LEN]; 112 PetscErrorCode ierr; 113 114 PetscFunctionBegin; 115 ierr = PetscStrcpy(fullname, path);CHKERRQ(ierr); 116 ierr = PetscStrcat(fullname, ":");CHKERRQ(ierr); 117 ierr = PetscStrcat(fullname, name);CHKERRQ(ierr); 118 ierr = PetscFListAdd(&TSList, sname, fullname, (void (*)(void)) function);CHKERRQ(ierr); 119 PetscFunctionReturn(0); 120 } 121 122 /*-------------------------------------------------------------------------------------------------------------------*/ 123 #undef __FUNCT__ 124 #define __FUNCT__ "TSRegisterDestroy" 125 /*@C 126 TSRegisterDestroy - Frees the list of timestepping routines that were registered by TSRegister()/TSRegisterDynamic(). 127 128 Not Collective 129 130 Level: advanced 131 132 .keywords: TS, timestepper, register, destroy 133 .seealso: TSRegister(), TSRegisterAll(), TSRegisterDynamic() 134 @*/ 135 PetscErrorCode TSRegisterDestroy(void) 136 { 137 PetscErrorCode ierr; 138 139 PetscFunctionBegin; 140 ierr = PetscFListDestroy(&TSList);CHKERRQ(ierr); 141 TSRegisterAllCalled = PETSC_FALSE; 142 PetscFunctionReturn(0); 143 } 144