histogram_data Module Reference

Module to control what variables are used to generate rank histograms. More...

Public Member Functions
subroutine	load_histogram_data
	subroutine to read from variables_hist.dat which holds the variables to be used to make the rank histograms More...
subroutine	kill_histogram_data
	subroutine to clean up arrays used in rank histograms More...

Public Attributes
integer, dimension(:), allocatable	rank_hist_list
integer, dimension(:), allocatable	rank_hist_nums
integer	rhl_n
integer	rhn_n

Detailed Description

Module to control what variables are used to generate rank histograms.

Definition at line 29 of file histogram.f90.

Member Function/Subroutine Documentation

subroutine histogram_data::kill_histogram_data

(

)

subroutine to clean up arrays used in rank histograms

Definition at line 135 of file histogram.f90.

subroutine histogram_data::load_histogram_data

(

)

subroutine to read from variables_hist.dat which holds the variables to be used to make the rank histograms

In order for histograms to be output, the file "variables_hist.dat" must contain the following infomation:

• rhn_n – the number of different rank histograms to be output
• the numbers of variables to be included in each rank histogram
• the index of the state vector for each different variable in each different rank histogram, grouped by the different histograms

So as an example, suppose we wanted to produce 3 rank histograms, the first relating to the 10th, and 16th variables in the state vector, the second containing the 1st, 2nd, 56th and 98th variables of the state vector and the final rank histogram relating to the 6th, 11th, 19th, 45th and 32nd variables. Then variables_hist.dat would look as follows:

 3
 2
 4
 5
 10
 16
 1
 2
 56
 98
 6
 11
 19
 45
 32

Definition at line 73 of file histogram.f90.

Member Data Documentation

integer, dimension(:), allocatable histogram_data::rank_hist_list

Definition at line 30 of file histogram.f90.

integer, dimension(:), allocatable histogram_data::rank_hist_nums

Definition at line 31 of file histogram.f90.

integer histogram_data::rhl_n

Definition at line 32 of file histogram.f90.

integer histogram_data::rhn_n

Definition at line 32 of file histogram.f90.

---

The documentation for this module was generated from the following file:

• src/utils/histogram.f90