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,&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 - create_func - The creation routine itself 94 95 Notes: 96 PetscRandomRegister() may be called multiple times to add several user-defined randome number generators 97 98 Sample usage: 99 .vb 100 PetscRandomRegister("my_rand", MyPetscRandomtorCreate); 101 .ve 102 103 Then, your random type can be chosen with the procedural interface via 104 .vb 105 PetscRandomCreate(MPI_Comm, PetscRandom *); 106 PetscRandomSetType(PetscRandom,"my_random_name"); 107 .ve 108 or at runtime via the option 109 .vb 110 -random_type my_random_name 111 .ve 112 113 Notes: For an example of the code needed to interface your own random number generator see 114 src/sys/random/impls/rand/rand.c 115 116 Level: advanced 117 118 .keywords: PetscRandom, register 119 120 .seealso: PetscRandomRegisterAll(), PetscRandomRegisterDestroy(), PetscRandomRegister() 121 @*/ 122 PetscErrorCode PetscRandomRegister(const char sname[], PetscErrorCode (*function)(PetscRandom)) 123 { 124 PetscErrorCode ierr; 125 126 PetscFunctionBegin; 127 ierr = PetscFunctionListAdd(&PetscRandomList,sname,function);CHKERRQ(ierr); 128 PetscFunctionReturn(0); 129 } 130 131 #if defined(PETSC_HAVE_RAND) 132 PETSC_EXTERN PetscErrorCode PetscRandomCreate_Rand(PetscRandom); 133 #endif 134 #if defined(PETSC_HAVE_DRAND48) 135 PETSC_EXTERN PetscErrorCode PetscRandomCreate_Rand48(PetscRandom); 136 #endif 137 #if defined(PETSC_HAVE_SPRNG) 138 PETSC_EXTERN PetscErrorCode PetscRandomCreate_Sprng(PetscRandom); 139 #endif 140 141 #undef __FUNCT__ 142 #define __FUNCT__ "PetscRandomRegisterAll" 143 /*@C 144 PetscRandomRegisterAll - Registers all of the components in the PetscRandom package. 145 146 Not Collective 147 148 Level: advanced 149 150 .keywords: PetscRandom, register, all 151 .seealso: PetscRandomRegister(), PetscRandomRegisterDestroy() 152 @*/ 153 PetscErrorCode PetscRandomRegisterAll(void) 154 { 155 PetscErrorCode ierr; 156 157 PetscFunctionBegin; 158 PetscRandomRegisterAllCalled = PETSC_TRUE; 159 #if defined(PETSC_HAVE_RAND) 160 ierr = PetscRandomRegister(PETSCRAND, PetscRandomCreate_Rand);CHKERRQ(ierr); 161 #endif 162 #if defined(PETSC_HAVE_DRAND48) 163 ierr = PetscRandomRegister(PETSCRAND48,PetscRandomCreate_Rand48);CHKERRQ(ierr); 164 #endif 165 #if defined(PETSC_HAVE_SPRNG) 166 ierr = PetscRandomRegister(PETSCSPRNG, PetscRandomCreate_Sprng);CHKERRQ(ierr); 167 #endif 168 PetscFunctionReturn(0); 169 } 170 171