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

Data Types

type  dict_entry_t
type  dict_t

Functions/Subroutines

subroutine add_key_sub (this, skey)
subroutine add_string_sub (this, svalue)
subroutine add_float_sub (this, fvalue)
subroutine add_integer_sub (this, ivalue)
subroutine add_double_sub (this, dvalue)
subroutine add_logical_sub (this, lvalue)
type(dict_entry_t) function, pointer get_entry_by_key_fn (this, skey)
type(dict_entry_t) function, pointer get_entry_by_index_fn (this, iindex)
type(dict_entry_t) function, pointer get_next_entry_by_key_fn (this, skey)
type(dict_entry_t) function, pointer get_next_entry_fn (this)
type(fstring_list_t) function grep_dictionary_key_names_fn (this, skey)
logical(c_bool) function key_name_already_in_use_fn (this, skey)
type(dict_entry_t) function, pointer find_dict_entry_fn (this, ssearchkey)
subroutine add_entry_to_dict_sub (this, dict_entry)
subroutine delete_entry_by_key_sub (this, skey)
subroutine get_values_as_int_sub (this, skey, ivalues, is_fatal)
subroutine get_values_as_logical_sub (this, skey, lvalues, is_fatal)
subroutine get_values_as_logical_given_list_of_keys_sub (this, slkeys, lvalues, is_fatal)
 Search through keys for a match; return logical values.
subroutine get_values_as_string_list_given_list_of_keys_sub (this, slkeys, slstring, is_fatal)
subroutine get_value_as_string_sub (this, stext, skey, iindex, is_fatal)
subroutine get_values_as_string_list_sub (this, skey, slstring, is_fatal)
subroutine get_values_as_int_given_list_of_keys_sub (this, slkeys, ivalues, is_fatal)
 Search through keys for a match; return integer values.
subroutine get_values_as_float_given_list_of_keys_sub (this, slkeys, fvalues, is_fatal)
 Search through keys for a match; return float values.
subroutine get_values_as_float_sub (this, skey, fvalues, is_fatal)
subroutine print_all_dictionary_entries_sub (this, iloglevel, sdescription, lecho)

Variables

type(dict_t), public cf_dict
type(dict_entry_t), pointer, public cf_entry

Function/Subroutine Documentation

◆ add_double_sub()

subroutine dictionary::add_double_sub ( class (dict_entry_t) this,
real (c_double), intent(in) dvalue )
private

Definition at line 154 of file dictionary.F90.

◆ add_entry_to_dict_sub()

subroutine dictionary::add_entry_to_dict_sub ( class (dict_t) this,
type (dict_entry_t), pointer dict_entry )
private

Definition at line 397 of file dictionary.F90.

Here is the call graph for this function:

◆ add_float_sub()

subroutine dictionary::add_float_sub ( class (dict_entry_t) this,
real (c_float), intent(in) fvalue )
private

Definition at line 132 of file dictionary.F90.

◆ add_integer_sub()

subroutine dictionary::add_integer_sub ( class (dict_entry_t) this,
integer (c_int), intent(in) ivalue )
private

Definition at line 143 of file dictionary.F90.

◆ add_key_sub()

subroutine dictionary::add_key_sub ( class (dict_entry_t) this,
character (len=*), intent(in) skey )
private

Definition at line 110 of file dictionary.F90.

◆ add_logical_sub()

subroutine dictionary::add_logical_sub ( class (dict_entry_t) this,
logical (c_bool), intent(in) lvalue )
private

Definition at line 165 of file dictionary.F90.

◆ add_string_sub()

subroutine dictionary::add_string_sub ( class (dict_entry_t) this,
character (len=*), intent(in) svalue )
private

Definition at line 121 of file dictionary.F90.

◆ delete_entry_by_key_sub()

subroutine dictionary::delete_entry_by_key_sub ( class (dict_t) this,
character (len=*), intent(in) skey )
private

Definition at line 460 of file dictionary.F90.

◆ find_dict_entry_fn()

type (dict_entry_t) function, pointer dictionary::find_dict_entry_fn ( class (dict_t) this,
character (len=*), intent(in) ssearchkey )
private

Definition at line 364 of file dictionary.F90.

◆ get_entry_by_index_fn()

type (dict_entry_t) function, pointer dictionary::get_entry_by_index_fn ( class (dict_t) this,
integer (c_int), intent(in) iindex )
private

Definition at line 208 of file dictionary.F90.

Here is the call graph for this function:

◆ get_entry_by_key_fn()

type (dict_entry_t) function, pointer dictionary::get_entry_by_key_fn ( class (dict_t) this,
character (len=*), intent(in) skey )
private

Definition at line 181 of file dictionary.F90.

Here is the call graph for this function:

◆ get_next_entry_by_key_fn()

type (dict_entry_t) function, pointer dictionary::get_next_entry_by_key_fn ( class (dict_t) this,
character (len=*), intent(in) skey )
private

Definition at line 245 of file dictionary.F90.

Here is the call graph for this function:

◆ get_next_entry_fn()

type (dict_entry_t) function, pointer dictionary::get_next_entry_fn ( class (dict_t) this)
private

Definition at line 273 of file dictionary.F90.

Here is the call graph for this function:

◆ get_value_as_string_sub()

subroutine dictionary::get_value_as_string_sub ( class (dict_t) this,
character(len=:), intent(out), allocatable stext,
character (len=*), intent(in), optional skey,
integer (c_int), intent(in), optional iindex,
logical (c_bool), optional is_fatal )
private

Definition at line 727 of file dictionary.F90.

◆ get_values_as_float_given_list_of_keys_sub()

subroutine dictionary::get_values_as_float_given_list_of_keys_sub ( class (dict_t) this,
type (fstring_list_t) slkeys,
real (c_float), dimension(:), intent(out), allocatable fvalues,
logical (c_bool), optional is_fatal )
private

Search through keys for a match; return float values.

THis routine allows for multiple header values to be supplied in the search for the appropriate column.

Parameters
[in]thisObject of DICT_T class.
[in]slKeysString list containing one or more possible key values to search for.
[out]fValuesFloat vector of values associated with one of the provided keys.

Definition at line 893 of file dictionary.F90.

Here is the call graph for this function:

◆ get_values_as_float_sub()

subroutine dictionary::get_values_as_float_sub ( class (dict_t) this,
character (len=*), intent(in) skey,
real (c_float), dimension(:), intent(out), allocatable fvalues,
logical (c_bool), optional is_fatal )
private

Definition at line 959 of file dictionary.F90.

Here is the call graph for this function:

◆ get_values_as_int_given_list_of_keys_sub()

subroutine dictionary::get_values_as_int_given_list_of_keys_sub ( class (dict_t) this,
type (fstring_list_t) slkeys,
integer (c_int), dimension(:), intent(out), allocatable ivalues,
logical (c_bool), optional is_fatal )
private

Search through keys for a match; return integer values.

THis routine allows for multiple header values to be supplied in the search for the appropriate column.

Parameters
[in]thisObject of DICT_T class.
[in]slKeysString list containing one or more possible key values to search for.
[out]iValuesInteger vector of values associated with one of the provided keys.

Definition at line 819 of file dictionary.F90.

Here is the call graph for this function:

◆ get_values_as_int_sub()

subroutine dictionary::get_values_as_int_sub ( class (dict_t) this,
character (len=*) skey,
integer (c_int), dimension(:), intent(out), allocatable ivalues,
logical (c_bool), optional is_fatal )
private

Definition at line 499 of file dictionary.F90.

Here is the call graph for this function:

◆ get_values_as_logical_given_list_of_keys_sub()

subroutine dictionary::get_values_as_logical_given_list_of_keys_sub ( class (dict_t) this,
type (fstring_list_t) slkeys,
logical (c_bool), dimension(:), intent(out), allocatable lvalues,
logical (c_bool), optional is_fatal )
private

Search through keys for a match; return logical values.

THis routine allows for multiple header values to be supplied in the search for the appropriate column.

Parameters
[in]thisObject of DICT_T class.
[in]slKeysString list containing one or more possible key values to search for.
[out]iValuesInteger vector of values associated with one of the provided keys.

Definition at line 606 of file dictionary.F90.

Here is the call graph for this function:

◆ get_values_as_logical_sub()

subroutine dictionary::get_values_as_logical_sub ( class (dict_t) this,
character (len=*) skey,
logical (c_bool), dimension(:), intent(out), allocatable lvalues,
logical (c_bool), optional is_fatal )
private

Definition at line 548 of file dictionary.F90.

Here is the call graph for this function:

◆ get_values_as_string_list_given_list_of_keys_sub()

subroutine dictionary::get_values_as_string_list_given_list_of_keys_sub ( class (dict_t) this,
type (fstring_list_t) slkeys,
type ( fstring_list_t ), intent(out) slstring,
logical (c_bool), optional is_fatal )
private

Definition at line 669 of file dictionary.F90.

Here is the call graph for this function:

◆ get_values_as_string_list_sub()

subroutine dictionary::get_values_as_string_list_sub ( class (dict_t) this,
character (len=*), intent(in) skey,
type (fstring_list_t), intent(out) slstring,
logical (c_bool), optional is_fatal )
private

Definition at line 765 of file dictionary.F90.

Here is the call graph for this function:

◆ grep_dictionary_key_names_fn()

type (fstring_list_t) function dictionary::grep_dictionary_key_names_fn ( class (dict_t) this,
character (len=*), intent(in) skey )
private

Definition at line 296 of file dictionary.F90.

Here is the call graph for this function:

◆ key_name_already_in_use_fn()

logical (c_bool) function dictionary::key_name_already_in_use_fn ( class (dict_t) this,
character (len=*), intent(in) skey )
private

Definition at line 324 of file dictionary.F90.

◆ print_all_dictionary_entries_sub()

subroutine dictionary::print_all_dictionary_entries_sub ( class (dict_t) this,
integer (c_int), intent(in), optional iloglevel,
character (len=*), intent(in), optional sdescription,
logical (c_bool), intent(in), optional lecho )
private

Definition at line 1008 of file dictionary.F90.

Variable Documentation

◆ cf_dict

type (dict_t), public dictionary::cf_dict

Definition at line 101 of file dictionary.F90.

◆ cf_entry

type (dict_entry_t), pointer, public dictionary::cf_entry

Definition at line 102 of file dictionary.F90.