petsc4py.PETSc.Random
- class petsc4py.PETSc.Random
Bases:
Object
The random number generator object.
See also
petsc.PetscRandom
Enumerations
The random number generator type.
Methods Summary
create
([comm])Create a random number generator object.
destroy
()Destroy the random number generator object.
Return the interval containing the random numbers generated.
getSeed
()Return the random number generator seed.
getType
()Return the type of the random number generator object.
getValue
()Generate a scalar random number.
Generate a real random number.
Configure the random number generator from the options database.
setInterval
(interval)Set the interval of the random number generator.
setSeed
([seed])Set the seed of random number generator.
setType
(rnd_type)Set the type of the random number generator object.
view
([viewer])View a random number generator object.
Attributes Summary
The interval of the generated random numbers.
The seed of the random number generator.
Methods Documentation
- create(comm=None)
Create a random number generator object.
Collective.
- Parameters:
comm (Comm | None) – MPI communicator, defaults to
Sys.getDefaultComm
.- Return type:
See also
Sys.getDefaultComm
,petsc.PetscRandomCreate
- destroy()
Destroy the random number generator object.
Collective.
See also
petsc.PetscRandomDestroy
Source code at petsc4py/PETSc/Random.pyx:61
- Return type:
- getInterval()
Return the interval containing the random numbers generated.
Not collective.
See also
setInterval
,petsc.PetscRandomGetInterval
- getSeed()
Return the random number generator seed.
Not collective.
See also
setSeed
,petsc.PetscRandomGetSeed
Source code at petsc4py/PETSc/Random.pyx:166
- Return type:
- getType()
Return the type of the random number generator object.
Not collective.
See also
setType
,petsc.PetscRandomGetType
Source code at petsc4py/PETSc/Random.pyx:112
- Return type:
- getValue()
Generate a scalar random number.
Not collective.
See also
petsc.PetscRandomGetValue
Source code at petsc4py/PETSc/Random.pyx:138
- Return type:
- getValueReal()
Generate a real random number.
Not collective.
See also
petsc.PetscRandomGetValueReal
Source code at petsc4py/PETSc/Random.pyx:152
- Return type:
- setFromOptions()
Configure the random number generator from the options database.
Collective.
See also
Working with PETSc options,
petsc.PetscRandomSetFromOptions
Source code at petsc4py/PETSc/Random.pyx:126
- Return type:
- setInterval(interval)
Set the interval of the random number generator.
Not collective.
See also
getInterval
,petsc.PetscRandomSetInterval
- setSeed(seed=None)
Set the seed of random number generator.
Not collective.
- Parameters:
seed (int | None) – The value for the seed. If
None
, it only seeds the generator.- Return type:
See also
getSeed
,petsc.PetscRandomSetSeed
,petsc.PetscRandomSeed
- setType(rnd_type)
Set the type of the random number generator object.
Collective.
See also
getType
,petsc.PetscRandomSetType
- view(viewer=None)
View a random number generator object.
Collective.
See also
petsc.PetscRandomView
Attributes Documentation
- interval
The interval of the generated random numbers.
- seed
The seed of the random number generator.