1 2 #include <../src/sys/classes/random/randomimpl.h> /*I "petscsys.h" I*/ 3 4 PetscFunctionList PetscRandomList = NULL; 5 PetscBool PetscRandomRegisterAllCalled = PETSC_FALSE; 6 7 #undef __FUNCT__ 8 #define __FUNCT__ "PetscRandomSetType" 9 /*@C 10 PetscRandomSetType - Builds a context for generating particular type of random numbers. 11 12 Collective on PetscRandom 13 14 Input Parameters: 15 + rnd - The random number generator context 16 - type - The name of the random type 17 18 Options Database Key: 19 . -random_type <type> - Sets the random type; use -help for a list 20 of available types 21 22 Notes: 23 See "petsc/include/petscsys.h" for available random types (for instance, PETSCRAND48, PETSCRAND). 24 25 Level: intermediate 26 27 .keywords: random, set, type 28 .seealso: PetscRandomGetType(), PetscRandomCreate() 29 @*/ 30 31 PetscErrorCode PetscRandomSetType(PetscRandom rnd, PetscRandomType type) 32 { 33 PetscErrorCode (*r)(PetscRandom); 34 PetscBool match; 35 PetscErrorCode ierr; 36 37 PetscFunctionBegin; 38 PetscValidHeaderSpecific(rnd, PETSC_RANDOM_CLASSID,1); 39 ierr = PetscObjectTypeCompare((PetscObject)rnd, type, &match);CHKERRQ(ierr); 40 if (match) PetscFunctionReturn(0); 41 42 ierr = PetscFunctionListFind(PetscRandomList, type,(void (**)(void)) &r);CHKERRQ(ierr); 43 if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown random type: %s", type); 44 45 if (rnd->ops->destroy) { 46 ierr = (*rnd->ops->destroy)(rnd);CHKERRQ(ierr); 47 48 rnd->ops->destroy = NULL; 49 } 50 ierr = (*r)(rnd);CHKERRQ(ierr); 51 ierr = PetscRandomSeed(rnd);CHKERRQ(ierr); 52 53 ierr = PetscObjectChangeTypeName((PetscObject)rnd, type);CHKERRQ(ierr); 54 PetscFunctionReturn(0); 55 } 56 57 #undef __FUNCT__ 58 #define __FUNCT__ "PetscRandomGetType" 59 /*@C 60 PetscRandomGetType - Gets the type name (as a string) from the PetscRandom. 61 62 Not Collective 63 64 Input Parameter: 65 . rnd - The random number generator context 66 67 Output Parameter: 68 . type - The type name 69 70 Level: intermediate 71 72 .keywords: random, get, type, name 73 .seealso: PetscRandomSetType(), PetscRandomCreate() 74 @*/ 75 PetscErrorCode PetscRandomGetType(PetscRandom rnd, PetscRandomType *type) 76 { 77 PetscFunctionBegin; 78 PetscValidHeaderSpecific(rnd, PETSC_RANDOM_CLASSID,1); 79 PetscValidPointer(type,2); 80 *type = ((PetscObject)rnd)->type_name; 81 PetscFunctionReturn(0); 82 } 83 84 #undef __FUNCT__ 85 #define __FUNCT__ "PetscRandomRegister" 86 /*@C 87 PetscRandomRegister - Adds a new PetscRandom component implementation 88 89 Not Collective 90 91 Input Parameters: 92 + name - The name of a new user-defined creation routine 93 . func_name - The name of routine to create method context 94 - create_func - The creation routine itself 95 96 Notes: 97 PetscRandomRegister() may be called multiple times to add several user-defined randome number generators 98 99 Sample usage: 100 .vb 101 PetscRandomRegister("my_rand", "MyPetscRandomtorCreate", MyPetscRandomtorCreate); 102 .ve 103 104 Then, your random type can be chosen with the procedural interface via 105 .vb 106 PetscRandomCreate(MPI_Comm, PetscRandom *); 107 PetscRandomSetType(PetscRandom,"my_random_name"); 108 .ve 109 or at runtime via the option 110 .vb 111 -random_type my_random_name 112 .ve 113 114 Notes: For an example of the code needed to interface your own random number generator see 115 src/sys/random/impls/rand/rand.c 116 117 Level: advanced 118 119 .keywords: PetscRandom, register 120 121 .seealso: PetscRandomRegisterAll(), PetscRandomRegisterDestroy(), PetscRandomRegister() 122 @*/ 123 PetscErrorCode PetscRandomRegister(const char sname[], const char name[], PetscErrorCode (*function)(PetscRandom)) 124 { 125 PetscErrorCode ierr; 126 127 PetscFunctionBegin; 128 ierr = PetscFunctionListAdd(&PetscRandomList,sname,name,(void (*)(void))function);CHKERRQ(ierr); 129 PetscFunctionReturn(0); 130 } 131 132 133 /*--------------------------------------------------------------------------------------------------------------------*/ 134 #undef __FUNCT__ 135 #define __FUNCT__ "PetscRandomRegisterDestroy" 136 /*@C 137 PetscRandomRegisterDestroy - Frees the list of Random types that were registered by PetscRandomRegister(). 138 139 Not Collective 140 141 Level: advanced 142 143 .keywords: PetscRandom, register, destroy 144 .seealso: PetscRandomRegister(), PetscRandomRegisterAll(), PetscRandomRegister() 145 @*/ 146 PetscErrorCode PetscRandomRegisterDestroy(void) 147 { 148 PetscErrorCode ierr; 149 150 PetscFunctionBegin; 151 ierr = PetscFunctionListDestroy(&PetscRandomList);CHKERRQ(ierr); 152 153 PetscRandomRegisterAllCalled = PETSC_FALSE; 154 PetscFunctionReturn(0); 155 } 156 157 #if defined(PETSC_HAVE_RAND) 158 PETSC_EXTERN PetscErrorCode PetscRandomCreate_Rand(PetscRandom); 159 #endif 160 #if defined(PETSC_HAVE_DRAND48) 161 PETSC_EXTERN PetscErrorCode PetscRandomCreate_Rand48(PetscRandom); 162 #endif 163 #if defined(PETSC_HAVE_SPRNG) 164 PETSC_EXTERN PetscErrorCode PetscRandomCreate_Sprng(PetscRandom); 165 #endif 166 167 #undef __FUNCT__ 168 #define __FUNCT__ "PetscRandomRegisterAll" 169 /*@C 170 PetscRandomRegisterAll - Registers all of the components in the PetscRandom package. 171 172 Not Collective 173 174 Level: advanced 175 176 .keywords: PetscRandom, register, all 177 .seealso: PetscRandomRegister(), PetscRandomRegisterDestroy() 178 @*/ 179 PetscErrorCode PetscRandomRegisterAll(void) 180 { 181 PetscErrorCode ierr; 182 183 PetscFunctionBegin; 184 PetscRandomRegisterAllCalled = PETSC_TRUE; 185 #if defined(PETSC_HAVE_RAND) 186 ierr = PetscRandomRegister(PETSCRAND, "PetscRandomCreate_Rand", PetscRandomCreate_Rand);CHKERRQ(ierr); 187 #endif 188 #if defined(PETSC_HAVE_DRAND48) 189 ierr = PetscRandomRegister(PETSCRAND48,"PetscRandomCreate_Rand48",PetscRandomCreate_Rand48);CHKERRQ(ierr); 190 #endif 191 #if defined(PETSC_HAVE_SPRNG) 192 ierr = PetscRandomRegister(PETSCSPRNG, "PetscRandomCreate_Sprng",PetscRandomCreate_Sprng);CHKERRQ(ierr); 193 #endif 194 PetscFunctionReturn(0); 195 } 196 197