random_numbers_mod

Generic module to wrap random number generators. More...

Data Types
interface	getrandomnumbers
	Returns scalar, 1 or 2 D random real numbers. More...
interface	initializerandomnumberstream
	Initializes stream for generating random numbers. More...
type	randomnumberstream
	Type to hold a stream of randomly generated numbers. More...

Functions/Subroutines
integer function, dimension(8), public	constructseed (i, j, time, perm)
	Constructs a unique seed from grid cell index and model date/time The perm is supplied we generate a different seed by circularly shifting the bits of the seed - this is useful if we want to create more than one seed for a given column and model date/time. Note that abs(perm) must be <= the number of bits used to represent the default integer (likely 32)
type(randomnumberstream) function	initializerandomnumberstream_s (seed)
	Initialization.
type(randomnumberstream) function	initializerandomnumberstream_v (seed)

Detailed Description

Generic module to wrap random number generators.

The module defines a type that identifies the particular stream of random numbers, and has procedures for initializing it and getting real numbers in the range 0 to 1. This version uses the Mersenne Twister to generate random numbers on [0, 1].

---

Data Type Documentation

random_numbers_mod::getrandomnumbers

interface random_numbers_mod::getrandomnumbers

Returns scalar, 1 or 2 D random real numbers.

Parameters

	stream	randomNumberStream to generate from
[out]	number	output number(s)

Definition at line 50 of file random_numbers.F90.

Public Member Functions
	get_random_number_0d_r4
	get_random_number_0d_r8
	get_random_number_1d_r4
	get_random_number_1d_r8
	get_random_number_2d_r4
	get_random_number_2d_r8

random_numbers_mod::initializerandomnumberstream

interface random_numbers_mod::initializerandomnumberstream

Initializes stream for generating random numbers.

Definition at line 58 of file random_numbers.F90.

Public Member Functions
type(randomnumberstream) function	initializerandomnumberstream_s (seed)
	Initialization.
type(randomnumberstream) function	initializerandomnumberstream_v (seed)

Member Function/Subroutine Documentation

initializerandomnumberstream_s()

type(randomnumberstream) function initializerandomnumberstream_s

(

integer, intent(in)

seed

)

Initialization.

Definition at line 72 of file random_numbers.F90.

initializerandomnumberstream_v()

type(randomnumberstream) function initializerandomnumberstream_v

(

integer, dimension(:), intent(in)

seed

)

Definition at line 80 of file random_numbers.F90.

random_numbers_mod::randomnumberstream

type random_numbers_mod::randomnumberstream

Type to hold a stream of randomly generated numbers.

Definition at line 41 of file random_numbers.F90.

Collaboration diagram for randomnumberstream:

Public Attributes
type(randomnumbersequence)	thenumbers

Member Data Documentation

thenumbers

type(randomnumbersequence) thenumbers

Definition at line 42 of file random_numbers.F90.

Function/Subroutine Documentation

constructseed()

integer function, dimension(8), public constructseed	(	integer, intent(in)	i,
		integer, intent(in)	j,
		type(time_type), intent(in)	time,
		integer, intent(in), optional	perm
	)

Constructs a unique seed from grid cell index and model date/time The perm is supplied we generate a different seed by circularly shifting the bits of the seed - this is useful if we want to create more than one seed for a given column and model date/time. Note that abs(perm) must be <= the number of bits used to represent the default integer (likely 32)

Definition at line 94 of file random_numbers.F90.

initializerandomnumberstream_s()

type(randomnumberstream) function initializerandomnumberstream_s ( integer, intent(in)  seed )

private

Initialization.

Definition at line 72 of file random_numbers.F90.

initializerandomnumberstream_v()

type(randomnumberstream) function initializerandomnumberstream_v ( integer, dimension(:), intent(in)  seed )

private

Definition at line 80 of file random_numbers.F90.