Soil Water Balance (SWB2)
Loading...
Searching...
No Matches
data_catalog_entry Module Reference

Data Types

interface  apply_scale_and_offset
type  data_catalog_entry_t

Functions/Subroutines

subroutine nullify_pointers_sub (this)
subroutine set_keyword_sub (this, skeyword)
subroutine get_value_int_sub (this, icol, irow, ivalue)
subroutine get_value_float_sub (this, icol, irow, fvalue)
subroutine initialize_constant_int_data_object_sub (this, sdescription, iconstant)
subroutine initialize_constant_real_data_object_sub (this, sdescription, rconstant)
subroutine initialize_table_sub (this, sdescription, sdatecolumnname, svaluecolumnname, stype)
subroutine initialize_gridded_data_object_sub (this, sdescription, sfiletype, idatatype, sfilename, sproj4_string)
subroutine initialize_netcdf_data_object_sub (this, sdescription, idatatype, sfilename, sproj4_string)
subroutine getvalues_sub (this, dt)
elemental subroutine apply_scale_and_offset_float (fresult, fvalue, duserscalefactor, dusersuboffset, duseraddoffset)
elemental subroutine apply_scale_and_offset_int (iresult, ivalue, duserscalefactor, dusersuboffset, duseraddoffset)
subroutine getvalues_constant_sub (this)
subroutine getvalues_from_lookup_table (this, dt)
subroutine dump_data_structure_sub (this)
subroutine getvalues_gridded_sub (this, dt)
subroutine transform_grid_to_grid_sub (this, rx, ry)
subroutine set_constant_value_int (this, ivalue)
subroutine set_constant_value_real (this, rvalue)
subroutine set_filecount (this, ivalue, iyear)
subroutine increment_filecount (this)
subroutine reset_filecount (this)
subroutine reset_at_yearend_filecount (this, iyear)
subroutine make_filename_from_template (this, dt)
logical(c_bool) function test_for_need_to_pad_values_fn (this, dt)
subroutine getvalues_dynamic_netcdf_sub (this, dt)
subroutine minmaxmean_float (variable, varname, nodata_value)
subroutine getvalues_static_netcdf_sub (this)
subroutine put_values_to_local_netcdf_sub (this, imonth, iday, iyear)
integer(c_int) function get_source_filetype_fn (this)
subroutine set_source_proj4_string_sub (this, sproj4_string)
subroutine set_target_proj4_string_sub (this, sproj4_string)
subroutine set_do_not_allow_netcdf_grid_data_flipping_sub (this)
subroutine set_grid_flip_horizontal_sub (this)
subroutine set_grid_flip_vertical_sub (this)
subroutine set_allow_missing_files_flag_sub (this)
subroutine set_variable_order_sub (this, svariableorder)
subroutine set_scale_sub (this, dscalefactor)
subroutine set_archive_local_sub (this, lvalue)
subroutine set_x_coord_offset_sub (this, rxoffset)
subroutine set_y_coord_offset_sub (this, ryoffset)
subroutine set_coordinate_tolerance_sub (this, rcoordinatetolerance)
subroutine set_add_offset_sub (this, daddoffset)
subroutine set_sub_offset_sub (this, dsuboffset)
subroutine set_majority_filter_flag_sub (this, lusemajorityfilter)
subroutine set_missing_value_int_sub (this, imissingval)
subroutine set_missing_value_real_sub (this, rmissingval)
subroutine set_complete_spatial_coverage_flag_sub (this, lrequirecompletespatialcoverage)
subroutine set_minimum_allowable_value_int_sub (this, iminval)
subroutine set_maximum_allowable_value_int_sub (this, imaxval)
subroutine set_minimum_allowable_value_real_sub (this, rminval)
subroutine set_maximum_allowable_value_real_sub (this, rmaxval)
subroutine calc_project_boundaries_sub (this, pgrdbase)
subroutine data_gridenforcelimits_int (this, ivalues)
subroutine data_gridenforcelimits_real (this, rvalues)
subroutine data_gridhandlemissingdata_real (this, rvalues)
subroutine data_gridhandlemissingdata_int (this, ivalues)

Variables

integer(c_int), parameter, public netcdf_file_open = 27
integer(c_int), parameter, public netcdf_file_closed = 42
integer(c_int), parameter, public file_template_capitalized_monthname = 0
integer(c_int), parameter, public file_template_lowercase_monthname = 1
integer(c_int), parameter, public file_template_uppercase_monthname = 2
integer(c_int), parameter constant_grid = 0
integer(c_int), parameter static_grid = 1
integer(c_int), parameter static_netcdf_grid = 2
integer(c_int), parameter, public dynamic_grid = 3
integer(c_int), parameter dynamic_netcdf_grid = 4
integer(c_int), parameter no_grid = 5
integer(c_int), parameter table_lookup = 6
integer(c_int), parameter filetype_arc_ascii = 0
integer(c_int), parameter filetype_surfer = 1
integer(c_int), parameter filetype_netcdf = 2
integer(c_int), parameter filetype_ascii_table = 3
integer(c_int), parameter filetype_none = 4
integer(c_int), parameter, public missing_values_zero_out = 0
integer(c_int), parameter, public missing_values_replace_with_mean = 1
type(general_grid_t), pointer, public pgrd => null()

Function/Subroutine Documentation

◆ apply_scale_and_offset_float()

elemental subroutine data_catalog_entry::apply_scale_and_offset_float ( real (c_float), intent(out) fresult,
real (c_float), intent(in) fvalue,
real (c_double), intent(in) duserscalefactor,
real (c_double), intent(in) dusersuboffset,
real (c_double), intent(in) duseraddoffset )
private

Definition at line 622 of file data_catalog_entry.F90.

◆ apply_scale_and_offset_int()

elemental subroutine data_catalog_entry::apply_scale_and_offset_int ( integer (c_int), intent(out) iresult,
integer (c_int), intent(in) ivalue,
real (c_double), intent(in) duserscalefactor,
real (c_double), intent(in) dusersuboffset,
real (c_double), intent(in) duseraddoffset )
private

Definition at line 636 of file data_catalog_entry.F90.

◆ calc_project_boundaries_sub()

subroutine data_catalog_entry::calc_project_boundaries_sub ( class (data_catalog_entry_t) this,
type ( general_grid_t ), pointer pgrdbase )
private

Definition at line 2140 of file data_catalog_entry.F90.

Here is the call graph for this function:

◆ data_gridenforcelimits_int()

subroutine data_catalog_entry::data_gridenforcelimits_int ( class (data_catalog_entry_t) this,
integer (c_int), dimension(:,:) ivalues )
private

Definition at line 2221 of file data_catalog_entry.F90.

◆ data_gridenforcelimits_real()

subroutine data_catalog_entry::data_gridenforcelimits_real ( class (data_catalog_entry_t) this,
real (c_float), dimension(:,:) rvalues )
private

Definition at line 2239 of file data_catalog_entry.F90.

◆ data_gridhandlemissingdata_int()

subroutine data_catalog_entry::data_gridhandlemissingdata_int ( class (data_catalog_entry_t) this,
integer (c_int), dimension(:,:), intent(inout) ivalues )
private

Definition at line 2350 of file data_catalog_entry.F90.

◆ data_gridhandlemissingdata_real()

subroutine data_catalog_entry::data_gridhandlemissingdata_real ( class (data_catalog_entry_t) this,
real (c_float), dimension(:,:), intent(inout) rvalues )
private

Definition at line 2257 of file data_catalog_entry.F90.

◆ dump_data_structure_sub()

subroutine data_catalog_entry::dump_data_structure_sub ( class (data_catalog_entry_t) this)
private

Definition at line 797 of file data_catalog_entry.F90.

Here is the call graph for this function:

◆ get_source_filetype_fn()

integer (c_int) function data_catalog_entry::get_source_filetype_fn ( class (data_catalog_entry_t) this)
private

Definition at line 1871 of file data_catalog_entry.F90.

◆ get_value_float_sub()

subroutine data_catalog_entry::get_value_float_sub ( class (data_catalog_entry_t), intent(in) this,
integer (c_int), intent(in) icol,
integer (c_int), intent(in) irow,
real (c_float), intent(out) fvalue )
private

Definition at line 302 of file data_catalog_entry.F90.

Here is the call graph for this function:

◆ get_value_int_sub()

subroutine data_catalog_entry::get_value_int_sub ( class (data_catalog_entry_t), intent(in) this,
integer (c_int), intent(in) icol,
integer (c_int), intent(in) irow,
integer (c_int), intent(out) ivalue )
private

Definition at line 281 of file data_catalog_entry.F90.

Here is the call graph for this function:

◆ getvalues_constant_sub()

subroutine data_catalog_entry::getvalues_constant_sub ( class (data_catalog_entry_t) this)
private

Definition at line 650 of file data_catalog_entry.F90.

Here is the call graph for this function:

◆ getvalues_dynamic_netcdf_sub()

subroutine data_catalog_entry::getvalues_dynamic_netcdf_sub ( class (data_catalog_entry_t) this,
type (datetime_t), intent(in) dt )
private

Definition at line 1361 of file data_catalog_entry.F90.

Here is the call graph for this function:

◆ getvalues_from_lookup_table()

subroutine data_catalog_entry::getvalues_from_lookup_table ( class (data_catalog_entry_t) this,
type (datetime_t), intent(in) dt )
private

Definition at line 686 of file data_catalog_entry.F90.

Here is the call graph for this function:

◆ getvalues_gridded_sub()

subroutine data_catalog_entry::getvalues_gridded_sub ( class (data_catalog_entry_t) this,
type (datetime_t), optional dt )
private

Definition at line 823 of file data_catalog_entry.F90.

Here is the call graph for this function:

◆ getvalues_static_netcdf_sub()

subroutine data_catalog_entry::getvalues_static_netcdf_sub ( class (data_catalog_entry_t) this)
private

Definition at line 1685 of file data_catalog_entry.F90.

Here is the call graph for this function:

◆ getvalues_sub()

subroutine data_catalog_entry::getvalues_sub ( class (data_catalog_entry_t) this,
type (datetime_t), optional dt )
private

Now apply the user scale and offset amounts

Definition at line 555 of file data_catalog_entry.F90.

Here is the call graph for this function:

◆ increment_filecount()

subroutine data_catalog_entry::increment_filecount ( class (data_catalog_entry_t) this)
private

Definition at line 1026 of file data_catalog_entry.F90.

◆ initialize_constant_int_data_object_sub()

subroutine data_catalog_entry::initialize_constant_int_data_object_sub ( class (data_catalog_entry_t) this,
character (len=*), intent(in) sdescription,
integer (c_int), intent(in) iconstant )
private

Definition at line 323 of file data_catalog_entry.F90.

◆ initialize_constant_real_data_object_sub()

subroutine data_catalog_entry::initialize_constant_real_data_object_sub ( class (data_catalog_entry_t) this,
character (len=*), intent(in) sdescription,
real (c_float), intent(in) rconstant )
private

Definition at line 350 of file data_catalog_entry.F90.

◆ initialize_gridded_data_object_sub()

subroutine data_catalog_entry::initialize_gridded_data_object_sub ( class (data_catalog_entry_t) this,
character (len=*), intent(in) sdescription,
character (len=*), intent(in) sfiletype,
integer (c_int) idatatype,
character (len=*), intent(in) sfilename,
character (len=*), intent(in), optional sproj4_string )
private

if either a '' or '#' character is present in the filename treat it as a template, not as a normal filename.

Definition at line 420 of file data_catalog_entry.F90.

Here is the call graph for this function:

◆ initialize_netcdf_data_object_sub()

subroutine data_catalog_entry::initialize_netcdf_data_object_sub ( class (data_catalog_entry_t) this,
character (len=*), intent(in) sdescription,
integer (c_int), intent(in) idatatype,
character (len=*), intent(in) sfilename,
character (len=*), intent(in), optional sproj4_string )
private

if either a '' or '#' character is present in the filename, treat it as a template, not as a normal filename. if there is a template, the implication is that there is a series of files that will be read in successively, thus "dynamic" NetCDF

@TODO Implement a way to read variables in via "static" NetCDF grid. In other words, a NetCDF grid having no "time" dimension or variable.

Definition at line 488 of file data_catalog_entry.F90.

Here is the call graph for this function:

◆ initialize_table_sub()

subroutine data_catalog_entry::initialize_table_sub ( class (data_catalog_entry_t) this,
character (len=*), intent(in) sdescription,
character (len=*), intent(in) sdatecolumnname,
character (len=*), intent(in) svaluecolumnname,
character (len=*), intent(in) stype )
private

Definition at line 377 of file data_catalog_entry.F90.

◆ make_filename_from_template()

subroutine data_catalog_entry::make_filename_from_template ( class (data_catalog_entry_t) this,
type (datetime_t), intent(in), optional dt )
private

Definition at line 1060 of file data_catalog_entry.F90.

◆ minmaxmean_float()

subroutine data_catalog_entry::minmaxmean_float ( real (c_float), dimension(:,:) variable,
character (len=*), intent(in) varname,
real (c_float), intent(in) nodata_value )
private

Definition at line 1648 of file data_catalog_entry.F90.

◆ nullify_pointers_sub()

subroutine data_catalog_entry::nullify_pointers_sub ( class (data_catalog_entry_t) this)
private

Definition at line 251 of file data_catalog_entry.F90.

Here is the call graph for this function:

◆ put_values_to_local_netcdf_sub()

subroutine data_catalog_entry::put_values_to_local_netcdf_sub ( class (data_catalog_entry_t) this,
integer (c_int) imonth,
integer (c_int) iday,
integer (c_int) iyear )
private

Definition at line 1826 of file data_catalog_entry.F90.

Here is the call graph for this function:

◆ reset_at_yearend_filecount()

subroutine data_catalog_entry::reset_at_yearend_filecount ( class (data_catalog_entry_t) this,
integer (c_int) iyear )
private

Definition at line 1046 of file data_catalog_entry.F90.

◆ reset_filecount()

subroutine data_catalog_entry::reset_filecount ( class (data_catalog_entry_t) this)
private

Definition at line 1036 of file data_catalog_entry.F90.

◆ set_add_offset_sub()

subroutine data_catalog_entry::set_add_offset_sub ( class (data_catalog_entry_t) this,
real (c_double) daddoffset )
private

Definition at line 2030 of file data_catalog_entry.F90.

◆ set_allow_missing_files_flag_sub()

subroutine data_catalog_entry::set_allow_missing_files_flag_sub ( class (data_catalog_entry_t) this)
private

Definition at line 1954 of file data_catalog_entry.F90.

◆ set_archive_local_sub()

subroutine data_catalog_entry::set_archive_local_sub ( class (data_catalog_entry_t) this,
logical (c_bool) lvalue )
private

Definition at line 1986 of file data_catalog_entry.F90.

◆ set_complete_spatial_coverage_flag_sub()

subroutine data_catalog_entry::set_complete_spatial_coverage_flag_sub ( class (data_catalog_entry_t) this,
logical (c_bool), intent(in) lrequirecompletespatialcoverage )
private

Definition at line 2085 of file data_catalog_entry.F90.

◆ set_constant_value_int()

subroutine data_catalog_entry::set_constant_value_int ( class (data_catalog_entry_t) this,
integer (c_int) ivalue )
private

Definition at line 990 of file data_catalog_entry.F90.

◆ set_constant_value_real()

subroutine data_catalog_entry::set_constant_value_real ( class (data_catalog_entry_t) this,
real (c_float) rvalue )
private

Definition at line 1001 of file data_catalog_entry.F90.

◆ set_coordinate_tolerance_sub()

subroutine data_catalog_entry::set_coordinate_tolerance_sub ( class (data_catalog_entry_t) this,
real (c_double) rcoordinatetolerance )
private

Definition at line 2019 of file data_catalog_entry.F90.

◆ set_do_not_allow_netcdf_grid_data_flipping_sub()

subroutine data_catalog_entry::set_do_not_allow_netcdf_grid_data_flipping_sub ( class (data_catalog_entry_t) this)
private

Definition at line 1924 of file data_catalog_entry.F90.

◆ set_filecount()

subroutine data_catalog_entry::set_filecount ( class (data_catalog_entry_t) this,
integer (c_int) ivalue,
integer (c_int), optional iyear )
private

Definition at line 1012 of file data_catalog_entry.F90.

◆ set_grid_flip_horizontal_sub()

subroutine data_catalog_entry::set_grid_flip_horizontal_sub ( class (data_catalog_entry_t) this)
private

Definition at line 1934 of file data_catalog_entry.F90.

◆ set_grid_flip_vertical_sub()

subroutine data_catalog_entry::set_grid_flip_vertical_sub ( class (data_catalog_entry_t) this)
private

Definition at line 1944 of file data_catalog_entry.F90.

◆ set_keyword_sub()

subroutine data_catalog_entry::set_keyword_sub ( class (data_catalog_entry_t) this,
character (len=*), intent(in) skeyword )
private

Definition at line 270 of file data_catalog_entry.F90.

◆ set_majority_filter_flag_sub()

subroutine data_catalog_entry::set_majority_filter_flag_sub ( class (data_catalog_entry_t) this,
logical (c_bool) lusemajorityfilter )
private

Definition at line 2052 of file data_catalog_entry.F90.

◆ set_maximum_allowable_value_int_sub()

subroutine data_catalog_entry::set_maximum_allowable_value_int_sub ( class (data_catalog_entry_t) this,
integer (c_int) imaxval )
private

Definition at line 2107 of file data_catalog_entry.F90.

◆ set_maximum_allowable_value_real_sub()

subroutine data_catalog_entry::set_maximum_allowable_value_real_sub ( class (data_catalog_entry_t) this,
real (c_float) rmaxval )
private

Definition at line 2129 of file data_catalog_entry.F90.

◆ set_minimum_allowable_value_int_sub()

subroutine data_catalog_entry::set_minimum_allowable_value_int_sub ( class (data_catalog_entry_t) this,
integer (c_int) iminval )
private

Definition at line 2096 of file data_catalog_entry.F90.

◆ set_minimum_allowable_value_real_sub()

subroutine data_catalog_entry::set_minimum_allowable_value_real_sub ( class (data_catalog_entry_t) this,
real (c_float) rminval )
private

Definition at line 2118 of file data_catalog_entry.F90.

◆ set_missing_value_int_sub()

subroutine data_catalog_entry::set_missing_value_int_sub ( class (data_catalog_entry_t) this,
integer (c_int) imissingval )
private

Definition at line 2063 of file data_catalog_entry.F90.

◆ set_missing_value_real_sub()

subroutine data_catalog_entry::set_missing_value_real_sub ( class (data_catalog_entry_t) this,
integer (c_int) rmissingval )
private

Definition at line 2074 of file data_catalog_entry.F90.

◆ set_scale_sub()

subroutine data_catalog_entry::set_scale_sub ( class (data_catalog_entry_t) this,
real (c_double) dscalefactor )
private

Definition at line 1975 of file data_catalog_entry.F90.

◆ set_source_proj4_string_sub()

subroutine data_catalog_entry::set_source_proj4_string_sub ( class (data_catalog_entry_t) this,
character (len=*), optional sproj4_string )
private

Definition at line 1902 of file data_catalog_entry.F90.

◆ set_sub_offset_sub()

subroutine data_catalog_entry::set_sub_offset_sub ( class (data_catalog_entry_t) this,
real (c_double) dsuboffset )
private

Definition at line 2041 of file data_catalog_entry.F90.

◆ set_target_proj4_string_sub()

subroutine data_catalog_entry::set_target_proj4_string_sub ( class (data_catalog_entry_t) this,
character (len=*), optional sproj4_string )
private

Definition at line 1913 of file data_catalog_entry.F90.

◆ set_variable_order_sub()

subroutine data_catalog_entry::set_variable_order_sub ( class (data_catalog_entry_t) this,
character (len=*) svariableorder )
private

Definition at line 1964 of file data_catalog_entry.F90.

◆ set_x_coord_offset_sub()

subroutine data_catalog_entry::set_x_coord_offset_sub ( class (data_catalog_entry_t) this,
real (c_double) rxoffset )
private

Definition at line 1997 of file data_catalog_entry.F90.

◆ set_y_coord_offset_sub()

subroutine data_catalog_entry::set_y_coord_offset_sub ( class (data_catalog_entry_t) this,
real (c_double) ryoffset )
private

Definition at line 2008 of file data_catalog_entry.F90.

◆ test_for_need_to_pad_values_fn()

logical (c_bool) function data_catalog_entry::test_for_need_to_pad_values_fn ( class (data_catalog_entry_t) this,
type (datetime_t), intent(in) dt )
private

Definition at line 1284 of file data_catalog_entry.F90.

◆ transform_grid_to_grid_sub()

subroutine data_catalog_entry::transform_grid_to_grid_sub ( class (data_catalog_entry_t) this,
real (c_double), dimension(:), optional rx,
real (c_double), dimension(:), optional ry )
private

Definition at line 922 of file data_catalog_entry.F90.

Here is the call graph for this function:

Variable Documentation

◆ constant_grid

integer (c_int), parameter data_catalog_entry::constant_grid = 0
private

Definition at line 32 of file data_catalog_entry.F90.

◆ dynamic_grid

integer (c_int), parameter, public data_catalog_entry::dynamic_grid = 3

Definition at line 35 of file data_catalog_entry.F90.

◆ dynamic_netcdf_grid

integer (c_int), parameter data_catalog_entry::dynamic_netcdf_grid = 4
private

Definition at line 36 of file data_catalog_entry.F90.

◆ file_template_capitalized_monthname

integer (c_int), parameter, public data_catalog_entry::file_template_capitalized_monthname = 0

Definition at line 28 of file data_catalog_entry.F90.

◆ file_template_lowercase_monthname

integer (c_int), parameter, public data_catalog_entry::file_template_lowercase_monthname = 1

Definition at line 29 of file data_catalog_entry.F90.

◆ file_template_uppercase_monthname

integer (c_int), parameter, public data_catalog_entry::file_template_uppercase_monthname = 2

Definition at line 30 of file data_catalog_entry.F90.

◆ filetype_arc_ascii

integer (c_int), parameter data_catalog_entry::filetype_arc_ascii = 0
private

Definition at line 40 of file data_catalog_entry.F90.

◆ filetype_ascii_table

integer (c_int), parameter data_catalog_entry::filetype_ascii_table = 3
private

Definition at line 43 of file data_catalog_entry.F90.

◆ filetype_netcdf

integer (c_int), parameter data_catalog_entry::filetype_netcdf = 2
private

Definition at line 42 of file data_catalog_entry.F90.

◆ filetype_none

integer (c_int), parameter data_catalog_entry::filetype_none = 4
private

Definition at line 44 of file data_catalog_entry.F90.

◆ filetype_surfer

integer (c_int), parameter data_catalog_entry::filetype_surfer = 1
private

Definition at line 41 of file data_catalog_entry.F90.

◆ missing_values_replace_with_mean

integer (c_int), parameter, public data_catalog_entry::missing_values_replace_with_mean = 1

Definition at line 240 of file data_catalog_entry.F90.

◆ missing_values_zero_out

integer (c_int), parameter, public data_catalog_entry::missing_values_zero_out = 0

Definition at line 239 of file data_catalog_entry.F90.

◆ netcdf_file_closed

integer (c_int), parameter, public data_catalog_entry::netcdf_file_closed = 42

Definition at line 26 of file data_catalog_entry.F90.

◆ netcdf_file_open

integer (c_int), parameter, public data_catalog_entry::netcdf_file_open = 27

Definition at line 25 of file data_catalog_entry.F90.

◆ no_grid

integer (c_int), parameter data_catalog_entry::no_grid = 5
private

Definition at line 37 of file data_catalog_entry.F90.

◆ pgrd

type (general_grid_t), pointer, public data_catalog_entry::pgrd => null()

Definition at line 242 of file data_catalog_entry.F90.

◆ static_grid

integer (c_int), parameter data_catalog_entry::static_grid = 1
private

Definition at line 33 of file data_catalog_entry.F90.

◆ static_netcdf_grid

integer (c_int), parameter data_catalog_entry::static_netcdf_grid = 2
private

Definition at line 34 of file data_catalog_entry.F90.

◆ table_lookup

integer (c_int), parameter data_catalog_entry::table_lookup = 6
private

Definition at line 38 of file data_catalog_entry.F90.