swbstats2_support::swbstats_t Type Reference

Collaboration diagram for swbstats2_support::swbstats_t:

Public Member Functions
procedure	set_conversion_factors_sub (this)
generic	set_conversion_factors (this)
procedure	create_working_grids (this)
procedure	create_monthly_working_grids (this)
procedure	open_zonal_stats_output_file (this, filename, delimiter)
procedure	create_date_list_for_annual_statistics (this)
procedure	create_date_list_for_period_statistics (this, start_date, end_date)
procedure	create_date_list_for_monthly_statistics (this)
procedure	create_date_list_for_daily_statistics (this)
procedure	read_date_range_file (this, csv_filename, date_range_id_list, start_date_list, end_date_list)
procedure	read_zone_period_file (this, csv_filename, date_range_id_list, start_date_list, end_date_list, zonal_stats_grid_file_list)
procedure	read_comparison_period_file (this, csv_filename, date_range_id_list, start_date_list, end_date_list, comparison_grid_file_list)
procedure	get_unique_int (this, grid_values, unique_val_list)
procedure	initialize_zone_grid (this, grid_filename)
procedure	initialize_secondary_zone_grid (this, grid_filename)
procedure	initialize_comparison_grid (this, grid_filename)
procedure	calculate_slice_statistics (this, start_date, end_date, grd_sum, grd_mean, grd_var)
procedure	calculate_monthly_statistics (this, month_num, finalize)
procedure	open_output_netcdf_files (this, output_files)
procedure	close_output_netcdf_files (this, output_files)
procedure	write_stats_to_netcdf (this, output_files, start_date, end_date)
procedure	write_stats_to_arcgrid (this, output_files, start_date, end_date, date_range_string, output_file_prefix)
procedure	write_monthly_stats_to_arcgrid (this, output_files, date_range_string, output_file_prefix)
procedure	output_zonal_stats (this, start_date, end_date, values, zone_ids, unique_zone_list, delimiter, funit, zone2_ids, unique_zone2_list, comparison_values)
procedure	print_all_options (this)

Public Attributes
logical(c_bool)	dump_options_to_screen = FALSE
logical(c_bool)	write_csv = FALSE
logical(c_bool)	calc_zonal_stats = FALSE
logical(c_bool)	compare_to_obs_values = FALSE
logical(c_bool)	annualize_stats = FALSE
logical(c_bool)	report_as_volume = FALSE
logical(c_bool)	report_in_meters = FALSE
character(len=:), allocatable	output_file_prefix
character(len=:), allocatable	target_proj4_string
type(datetime_t)	data_start_date
type(datetime_t)	data_end_date
type(datetime_t)	slice_start_date
type(datetime_t)	slice_end_date
character(len=:), allocatable	slice_range_string
character(len=:), allocatable	date_range_string
integer(c_int)	calculation_time_period = CALC_PERIOD_ALL
character(len=:), allocatable	stress_period_filename
character(len=:), allocatable	comparison_period_filename
character(len=:), allocatable	zone_period_filename
character(len=:), allocatable	comparison_grid_filename
character(len=:), allocatable	zone_grid_filename
character(len=:), allocatable	zone_grid2_filename
character(len=:), allocatable	netcdf_input_filename
character(len=:), allocatable	netcdf_variable_units_string
character(len=:), allocatable	netcdf_variable_name_string
character(len=:), allocatable	filename_modifier_string
logical(c_bool)	netcdf_input_file_is_open = FALSE
logical(c_bool)	multiple_zone_grids = FALSE
logical(c_bool)	multiple_comparison_grids = FALSE
real(c_double)	comparison_grid_conversion_factor = 1.0_c_double
type(fstring_list_t)	start_date_list
type(fstring_list_t)	end_date_list
type(fstring_list_t)	date_range_id_list
type(fstring_list_t)	unique_zone_list
type(fstring_list_t)	unique_zone2_list
type(fstring_list_t)	comparison_grid_file_list
type(fstring_list_t)	zone_grid_file_list
real(c_double)	output_conversion_factor = 1.0_c_double
real(c_double)	unit_conversion_factor = 1.0_c_double
real(c_double)	grid_cell_area_sq_meters = 1.0_c_double
real(c_double)	length_conversion_factor = 1.0_c_double
type(t_netcdf4_file), pointer	ncfile_in
type(ascii_file_t)	zonal_stats_output_file
type(ascii_file_t)	whole_grid_stats_output_file
type(general_grid_t), pointer	grd_native => null()
type(general_grid_t), pointer	grd_delta => null()
type(general_grid_t), pointer	grd_delta2 => null()
type(data_catalog_entry_t), pointer	grd_zone => null()
type(data_catalog_entry_t), pointer	grd_zone2 => null()
type(data_catalog_entry_t), pointer	grd_comparison => null()

Detailed Description

Definition at line 75 of file swbstats2_support.F90.

Member Function/Subroutine Documentation

calculate_monthly_statistics()

procedure swbstats2_support::swbstats_t::calculate_monthly_statistics	(	class (swbstats_t), intent(inout)	this,
		integer (c_short), intent(in)	month_num,
		logical (c_bool), intent(in)	finalize )

Definition at line 154 of file swbstats2_support.F90.

calculate_slice_statistics()

procedure swbstats2_support::swbstats_t::calculate_slice_statistics	(	class (swbstats_t), intent(inout)	this,
		type (datetime_t), intent(inout)	start_date,
		type (datetime_t), intent(inout)	end_date,
		real (c_double), dimension(:,:), intent(inout)	grd_sum,
		real (c_double), dimension(:,:), intent(inout)	grd_mean,
		real (c_double), dimension(:,:), intent(inout)	grd_var )

Definition at line 153 of file swbstats2_support.F90.

close_output_netcdf_files()

procedure swbstats2_support::swbstats_t::close_output_netcdf_files	(	class (swbstats_t), intent(inout)	this,
		type (file_collection_t), dimension(:), intent(inout)	output_files )

Definition at line 157 of file swbstats2_support.F90.

create_date_list_for_annual_statistics()

procedure swbstats2_support::swbstats_t::create_date_list_for_annual_statistics

(

class (swbstats_t), intent(inout)

this

)

Definition at line 138 of file swbstats2_support.F90.

create_date_list_for_daily_statistics()

procedure swbstats2_support::swbstats_t::create_date_list_for_daily_statistics

(

class (swbstats_t), intent(inout)

this

)

Definition at line 141 of file swbstats2_support.F90.

create_date_list_for_monthly_statistics()

procedure swbstats2_support::swbstats_t::create_date_list_for_monthly_statistics

(

class (swbstats_t), intent(inout)

this

)

Definition at line 140 of file swbstats2_support.F90.

create_date_list_for_period_statistics()

procedure swbstats2_support::swbstats_t::create_date_list_for_period_statistics	(	class (swbstats_t), intent(inout)	this,
		type (datetime_t), intent(in)	start_date,
		type (datetime_t), intent(in)	end_date )

Definition at line 139 of file swbstats2_support.F90.

create_monthly_working_grids()

procedure swbstats2_support::swbstats_t::create_monthly_working_grids

(

class (swbstats_t), intent(inout)

this

)

Definition at line 134 of file swbstats2_support.F90.

create_working_grids()

procedure swbstats2_support::swbstats_t::create_working_grids

(

class (swbstats_t), intent(inout)

this

)

Definition at line 133 of file swbstats2_support.F90.

get_unique_int()

procedure swbstats2_support::swbstats_t::get_unique_int	(	class (swbstats_t), intent(inout)	this,
		integer (c_int), dimension(:,:), intent(in)	grid_values,
		type (fstring_list_t), intent(inout)	unique_val_list )

Definition at line 147 of file swbstats2_support.F90.

initialize_comparison_grid()

procedure swbstats2_support::swbstats_t::initialize_comparison_grid	(	class (swbstats_t), intent(inout)	this,
		character (len=*), intent(inout)	grid_filename )

Definition at line 151 of file swbstats2_support.F90.

initialize_secondary_zone_grid()

procedure swbstats2_support::swbstats_t::initialize_secondary_zone_grid	(	class (swbstats_t), intent(inout)	this,
		character (len=*), intent(inout)	grid_filename )

Definition at line 150 of file swbstats2_support.F90.

initialize_zone_grid()

procedure swbstats2_support::swbstats_t::initialize_zone_grid	(	class (swbstats_t), intent(inout)	this,
		character (len=*), intent(inout)	grid_filename )

Definition at line 149 of file swbstats2_support.F90.

open_output_netcdf_files()

procedure swbstats2_support::swbstats_t::open_output_netcdf_files	(	class (swbstats_t), intent(inout)	this,
		type (file_collection_t), dimension(:), intent(inout)	output_files )

Definition at line 156 of file swbstats2_support.F90.

open_zonal_stats_output_file()

procedure swbstats2_support::swbstats_t::open_zonal_stats_output_file	(	class (swbstats_t), intent(inout)	this,
		character (len=*)	filename,
		character (len=*), intent(in), optional	delimiter )

Definition at line 136 of file swbstats2_support.F90.

output_zonal_stats()

procedure swbstats2_support::swbstats_t::output_zonal_stats	(	class (swbstats_t), intent(inout)	this,
		type (datetime_t), intent(in)	start_date,
		type (datetime_t), intent(in)	end_date,
		real (c_double), dimension(:,:), intent(inout)	values,
		integer (c_int), dimension(:,:), intent(inout)	zone_ids,
		type (fstring_list_t), intent(inout)	unique_zone_list,
		character (len=*), intent(in), optional	delimiter,
		integer (c_int), intent(in), optional	funit,
		integer (c_int), dimension(:,:), intent(inout), optional	zone2_ids,
		type (fstring_list_t), intent(inout), optional	unique_zone2_list,
		real (c_double), dimension(:,:), intent(inout), optional	comparison_values )

Definition at line 162 of file swbstats2_support.F90.

print_all_options()

procedure swbstats2_support::swbstats_t::print_all_options

(

class (swbstats_t)

this

)

Definition at line 164 of file swbstats2_support.F90.

read_comparison_period_file()

procedure swbstats2_support::swbstats_t::read_comparison_period_file	(	class (swbstats_t), intent(inout)	this,
		character (len=*), intent(inout)	csv_filename,
		type (fstring_list_t), intent(out)	date_range_id_list,
		type (fstring_list_t), intent(out)	start_date_list,
		type (fstring_list_t), intent(out)	end_date_list,
		type (fstring_list_t), intent(out)	comparison_grid_file_list )

Definition at line 145 of file swbstats2_support.F90.

read_date_range_file()

procedure swbstats2_support::swbstats_t::read_date_range_file	(	class (swbstats_t), intent(inout)	this,
		character (len=*), intent(inout)	csv_filename,
		type (fstring_list_t), intent(out)	date_range_id_list,
		type (fstring_list_t), intent(out)	start_date_list,
		type (fstring_list_t), intent(out)	end_date_list )

Definition at line 143 of file swbstats2_support.F90.

read_zone_period_file()

procedure swbstats2_support::swbstats_t::read_zone_period_file	(	class (swbstats_t), intent(inout)	this,
		character (len=*), intent(inout)	csv_filename,
		type (fstring_list_t), intent(out)	date_range_id_list,
		type (fstring_list_t), intent(out)	start_date_list,
		type (fstring_list_t), intent(out)	end_date_list,
		type (fstring_list_t), intent(out)	zonal_stats_grid_file_list )

Definition at line 144 of file swbstats2_support.F90.

set_conversion_factors()

generic swbstats2_support::swbstats_t::set_conversion_factors

(

class (swbstats_t), intent(inout)

this

)

Definition at line 131 of file swbstats2_support.F90.

Here is the call graph for this function:

set_conversion_factors_sub()

procedure swbstats2_support::swbstats_t::set_conversion_factors_sub

(

class (swbstats_t), intent(inout)

this

)

Definition at line 130 of file swbstats2_support.F90.

write_monthly_stats_to_arcgrid()

procedure swbstats2_support::swbstats_t::write_monthly_stats_to_arcgrid	(	class (swbstats_t), intent(inout)	this,
		type (file_collection_t), dimension(:), intent(inout)	output_files,
		character (len=*), intent(in), optional	date_range_string,
		character (len=*), intent(in), optional	output_file_prefix )

Definition at line 161 of file swbstats2_support.F90.

write_stats_to_arcgrid()

procedure swbstats2_support::swbstats_t::write_stats_to_arcgrid	(	class (swbstats_t), intent(inout)	this,
		type (file_collection_t), dimension(:), intent(inout)	output_files,
		type (datetime_t), intent(inout)	start_date,
		type (datetime_t), intent(inout)	end_date,
		character (len=*), intent(in), optional	date_range_string,
		character (len=:), intent(in), optional, allocatable	output_file_prefix )

Definition at line 160 of file swbstats2_support.F90.

write_stats_to_netcdf()

procedure swbstats2_support::swbstats_t::write_stats_to_netcdf	(	class (swbstats_t), intent(inout)	this,
		type (file_collection_t), dimension(:), intent(inout)	output_files,
		type (datetime_t), intent(inout)	start_date,
		type (datetime_t), intent(inout)	end_date )

Definition at line 159 of file swbstats2_support.F90.

Member Data Documentation

annualize_stats

logical (c_bool) swbstats2_support::swbstats_t::annualize_stats = FALSE

Definition at line 80 of file swbstats2_support.F90.

calc_zonal_stats

logical (c_bool) swbstats2_support::swbstats_t::calc_zonal_stats = FALSE

Definition at line 78 of file swbstats2_support.F90.

calculation_time_period

integer (c_int) swbstats2_support::swbstats_t::calculation_time_period = CALC_PERIOD_ALL

Definition at line 91 of file swbstats2_support.F90.

compare_to_obs_values

logical (c_bool) swbstats2_support::swbstats_t::compare_to_obs_values = FALSE

Definition at line 79 of file swbstats2_support.F90.

comparison_grid_conversion_factor

real (c_double) swbstats2_support::swbstats_t::comparison_grid_conversion_factor = 1.0_c_double

Definition at line 105 of file swbstats2_support.F90.

comparison_grid_file_list

type (fstring_list_t) swbstats2_support::swbstats_t::comparison_grid_file_list

Definition at line 111 of file swbstats2_support.F90.

comparison_grid_filename

character (len=:), allocatable swbstats2_support::swbstats_t::comparison_grid_filename

Definition at line 95 of file swbstats2_support.F90.

comparison_period_filename

character (len=:), allocatable swbstats2_support::swbstats_t::comparison_period_filename

Definition at line 93 of file swbstats2_support.F90.

data_end_date

type (datetime_t) swbstats2_support::swbstats_t::data_end_date

Definition at line 86 of file swbstats2_support.F90.

data_start_date

type (datetime_t) swbstats2_support::swbstats_t::data_start_date

Definition at line 85 of file swbstats2_support.F90.

date_range_id_list

type (fstring_list_t) swbstats2_support::swbstats_t::date_range_id_list

Definition at line 108 of file swbstats2_support.F90.

date_range_string

character (len=:), allocatable swbstats2_support::swbstats_t::date_range_string

Definition at line 90 of file swbstats2_support.F90.

dump_options_to_screen

logical (c_bool) swbstats2_support::swbstats_t::dump_options_to_screen = FALSE

Definition at line 76 of file swbstats2_support.F90.

end_date_list

type (fstring_list_t) swbstats2_support::swbstats_t::end_date_list

Definition at line 107 of file swbstats2_support.F90.

filename_modifier_string

character (len=:), allocatable swbstats2_support::swbstats_t::filename_modifier_string

Definition at line 101 of file swbstats2_support.F90.

grd_comparison

type (data_catalog_entry_t), pointer swbstats2_support::swbstats_t::grd_comparison => null()

Definition at line 126 of file swbstats2_support.F90.

grd_delta

type (general_grid_t), pointer swbstats2_support::swbstats_t::grd_delta => null()

Definition at line 122 of file swbstats2_support.F90.

grd_delta2

type (general_grid_t), pointer swbstats2_support::swbstats_t::grd_delta2 => null()

Definition at line 123 of file swbstats2_support.F90.

grd_native

type (general_grid_t), pointer swbstats2_support::swbstats_t::grd_native => null()

Definition at line 121 of file swbstats2_support.F90.

grd_zone

type (data_catalog_entry_t), pointer swbstats2_support::swbstats_t::grd_zone => null()

Definition at line 124 of file swbstats2_support.F90.

grd_zone2

type (data_catalog_entry_t), pointer swbstats2_support::swbstats_t::grd_zone2 => null()

Definition at line 125 of file swbstats2_support.F90.

grid_cell_area_sq_meters

real (c_double) swbstats2_support::swbstats_t::grid_cell_area_sq_meters = 1.0_c_double

Definition at line 115 of file swbstats2_support.F90.

length_conversion_factor

real (c_double) swbstats2_support::swbstats_t::length_conversion_factor = 1.0_c_double

Definition at line 116 of file swbstats2_support.F90.

multiple_comparison_grids

logical (c_bool) swbstats2_support::swbstats_t::multiple_comparison_grids = FALSE

Definition at line 104 of file swbstats2_support.F90.

multiple_zone_grids

logical (c_bool) swbstats2_support::swbstats_t::multiple_zone_grids = FALSE

Definition at line 103 of file swbstats2_support.F90.

ncfile_in

type (t_netcdf4_file), pointer swbstats2_support::swbstats_t::ncfile_in

Definition at line 117 of file swbstats2_support.F90.

netcdf_input_file_is_open

logical (c_bool) swbstats2_support::swbstats_t::netcdf_input_file_is_open = FALSE

Definition at line 102 of file swbstats2_support.F90.

netcdf_input_filename

character (len=:), allocatable swbstats2_support::swbstats_t::netcdf_input_filename

Definition at line 98 of file swbstats2_support.F90.

netcdf_variable_name_string

character (len=:), allocatable swbstats2_support::swbstats_t::netcdf_variable_name_string

Definition at line 100 of file swbstats2_support.F90.

netcdf_variable_units_string

character (len=:), allocatable swbstats2_support::swbstats_t::netcdf_variable_units_string

Definition at line 99 of file swbstats2_support.F90.

output_conversion_factor

real (c_double) swbstats2_support::swbstats_t::output_conversion_factor = 1.0_c_double

Definition at line 113 of file swbstats2_support.F90.

output_file_prefix

character (len=:), allocatable swbstats2_support::swbstats_t::output_file_prefix

Definition at line 83 of file swbstats2_support.F90.

report_as_volume

logical (c_bool) swbstats2_support::swbstats_t::report_as_volume = FALSE

Definition at line 81 of file swbstats2_support.F90.

report_in_meters

logical (c_bool) swbstats2_support::swbstats_t::report_in_meters = FALSE

Definition at line 82 of file swbstats2_support.F90.

slice_end_date

type (datetime_t) swbstats2_support::swbstats_t::slice_end_date

Definition at line 88 of file swbstats2_support.F90.

slice_range_string

character (len=:), allocatable swbstats2_support::swbstats_t::slice_range_string

Definition at line 89 of file swbstats2_support.F90.

slice_start_date

type (datetime_t) swbstats2_support::swbstats_t::slice_start_date

Definition at line 87 of file swbstats2_support.F90.

start_date_list

type (fstring_list_t) swbstats2_support::swbstats_t::start_date_list

Definition at line 106 of file swbstats2_support.F90.

stress_period_filename

character (len=:), allocatable swbstats2_support::swbstats_t::stress_period_filename

Definition at line 92 of file swbstats2_support.F90.

target_proj4_string

character (len=:), allocatable swbstats2_support::swbstats_t::target_proj4_string

Definition at line 84 of file swbstats2_support.F90.

unique_zone2_list

type (fstring_list_t) swbstats2_support::swbstats_t::unique_zone2_list

Definition at line 110 of file swbstats2_support.F90.

unique_zone_list

type (fstring_list_t) swbstats2_support::swbstats_t::unique_zone_list

Definition at line 109 of file swbstats2_support.F90.

unit_conversion_factor

real (c_double) swbstats2_support::swbstats_t::unit_conversion_factor = 1.0_c_double

Definition at line 114 of file swbstats2_support.F90.

whole_grid_stats_output_file

type (ascii_file_t) swbstats2_support::swbstats_t::whole_grid_stats_output_file

Definition at line 119 of file swbstats2_support.F90.

write_csv

logical (c_bool) swbstats2_support::swbstats_t::write_csv = FALSE

Definition at line 77 of file swbstats2_support.F90.

zonal_stats_output_file

type (ascii_file_t) swbstats2_support::swbstats_t::zonal_stats_output_file

Definition at line 118 of file swbstats2_support.F90.

zone_grid2_filename

character (len=:), allocatable swbstats2_support::swbstats_t::zone_grid2_filename

Definition at line 97 of file swbstats2_support.F90.

zone_grid_file_list

type (fstring_list_t) swbstats2_support::swbstats_t::zone_grid_file_list

Definition at line 112 of file swbstats2_support.F90.

zone_grid_filename

character (len=:), allocatable swbstats2_support::swbstats_t::zone_grid_filename

Definition at line 96 of file swbstats2_support.F90.

zone_period_filename

character (len=:), allocatable swbstats2_support::swbstats_t::zone_period_filename

Definition at line 94 of file swbstats2_support.F90.

---

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

• swbstats2_support.F90