FV3 Bundle
fm_util_mod Module Reference

Data Types

interface  fm_util_set_value
 

Functions/Subroutines

subroutine, public fm_util_set_caller (caller)
 
subroutine, public fm_util_reset_caller
 
subroutine, public fm_util_set_good_name_list (good_name_list)
 
subroutine, public fm_util_reset_good_name_list
 
subroutine, public fm_util_set_no_overwrite (no_overwrite)
 
subroutine, public fm_util_reset_no_overwrite
 
subroutine, public fm_util_check_for_bad_fields (list, good_fields, caller)
 
integer function, public fm_util_get_length (name, caller)
 
integer function, public fm_util_get_index_string (name, string, caller)
 
integer function, public fm_util_get_index_list (name, caller)
 
integer function, dimension(:), pointer, public fm_util_get_integer_array (name, caller)
 
logical function, dimension(:), pointer, public fm_util_get_logical_array (name, caller)
 
real function, dimension(:), pointer, public fm_util_get_real_array (name, caller)
 
character(len=fm_string_len) function, dimension(:), pointer, public fm_util_get_string_array (name, caller)
 
integer function, public fm_util_get_integer (name, caller, index, default_value, scalar)
 
logical function, public fm_util_get_logical (name, caller, index, default_value, scalar)
 
real function, public fm_util_get_real (name, caller, index, default_value, scalar)
 
character(len=fm_string_len) function, public fm_util_get_string (name, caller, index, default_value, scalar)
 
subroutine, public fm_util_set_value_integer_array (name, value, length, caller, no_overwrite, good_name_list)
 
subroutine, public fm_util_set_value_logical_array (name, value, length, caller, no_overwrite, good_name_list)
 
subroutine, public fm_util_set_value_real_array (name, value, length, caller, no_overwrite, good_name_list)
 
subroutine, public fm_util_set_value_string_array (name, value, length, caller, no_overwrite, good_name_list)
 
subroutine, public fm_util_set_value_integer (name, value, caller, index, append, no_create, no_overwrite, good_name_list)
 
subroutine, public fm_util_set_value_logical (name, value, caller, index, append, no_create, no_overwrite, good_name_list)
 
subroutine, public fm_util_set_value_real (name, value, caller, index, append, no_create, no_overwrite, good_name_list)
 
subroutine, public fm_util_set_value_string (name, value, caller, index, append, no_create, no_overwrite, good_name_list)
 
subroutine, public fm_util_start_namelist (path, name, caller, no_overwrite, check)
 
subroutine, public fm_util_end_namelist (path, name, caller, check)
 

Variables

character(len=128), public fm_util_default_caller = ' '
 
character(len=48), parameter mod_name = 'fm_util_mod'
 
character(len=128) save_default_caller = ' '
 
character(len=128) default_good_name_list = ' '
 
character(len=128) save_default_good_name_list = ' '
 
logical default_no_overwrite = .false.
 
logical save_default_no_overwrite = .false.
 
character(len=fm_path_name_len) save_current_list
 
character(len=fm_path_name_len) save_path
 
character(len=fm_path_name_len) save_name
 

Function/Subroutine Documentation

◆ fm_util_check_for_bad_fields()

subroutine, public fm_util_mod::fm_util_check_for_bad_fields ( character(len=*), intent(in)  list,
character(len=*), dimension(:), intent(in)  good_fields,
character(len=*), intent(in), optional  caller 
)

Definition at line 393 of file fm_util.F90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ fm_util_end_namelist()

subroutine, public fm_util_mod::fm_util_end_namelist ( character(len=*), intent(in)  path,
character(len=*), intent(in)  name,
character(len=*), intent(in), optional  caller,
logical, intent(in), optional  check 
)

Definition at line 3249 of file fm_util.F90.

Here is the call graph for this function:

◆ fm_util_get_index_list()

integer function, public fm_util_mod::fm_util_get_index_list ( character(len=*), intent(in)  name,
character(len=*), intent(in), optional  caller 
)

Definition at line 747 of file fm_util.F90.

◆ fm_util_get_index_string()

integer function, public fm_util_mod::fm_util_get_index_string ( character(len=*), intent(in)  name,
character(len=*), intent(in)  string,
character(len=*), intent(in), optional  caller 
)

Definition at line 637 of file fm_util.F90.

Here is the caller graph for this function:

◆ fm_util_get_integer()

integer function, public fm_util_mod::fm_util_get_integer ( character(len=*), intent(in)  name,
character(len=*), intent(in), optional  caller,
integer, intent(in), optional  index,
integer, intent(in), optional  default_value,
logical, intent(in), optional  scalar 
)

Definition at line 1229 of file fm_util.F90.

◆ fm_util_get_integer_array()

integer function, dimension(:), pointer, public fm_util_mod::fm_util_get_integer_array ( character(len=*), intent(in)  name,
character(len=*), intent(in), optional  caller 
)

Definition at line 837 of file fm_util.F90.

◆ fm_util_get_length()

integer function, public fm_util_mod::fm_util_get_length ( character(len=*), intent(in)  name,
character(len=*), intent(in), optional  caller 
)

Definition at line 557 of file fm_util.F90.

◆ fm_util_get_logical()

logical function, public fm_util_mod::fm_util_get_logical ( character(len=*), intent(in)  name,
character(len=*), intent(in), optional  caller,
integer, intent(in), optional  index,
logical, intent(in), optional  default_value,
logical, intent(in), optional  scalar 
)

Definition at line 1348 of file fm_util.F90.

Here is the caller graph for this function:

◆ fm_util_get_logical_array()

logical function, dimension(:), pointer, public fm_util_mod::fm_util_get_logical_array ( character(len=*), intent(in)  name,
character(len=*), intent(in), optional  caller 
)

Definition at line 935 of file fm_util.F90.

Here is the caller graph for this function:

◆ fm_util_get_real()

real function, public fm_util_mod::fm_util_get_real ( character(len=*), intent(in)  name,
character(len=*), intent(in), optional  caller,
integer, intent(in), optional  index,
real, intent(in), optional  default_value,
logical, intent(in), optional  scalar 
)

Definition at line 1467 of file fm_util.F90.

◆ fm_util_get_real_array()

real function, dimension(:), pointer, public fm_util_mod::fm_util_get_real_array ( character(len=*), intent(in)  name,
character(len=*), intent(in), optional  caller 
)

Definition at line 1033 of file fm_util.F90.

◆ fm_util_get_string()

character(len=fm_string_len) function, public fm_util_mod::fm_util_get_string ( character(len=*), intent(in)  name,
character(len=*), intent(in), optional  caller,
integer, intent(in), optional  index,
character(len=*), intent(in), optional  default_value,
logical, intent(in), optional  scalar 
)

Definition at line 1592 of file fm_util.F90.

◆ fm_util_get_string_array()

character(len=fm_string_len) function, dimension(:), pointer, public fm_util_mod::fm_util_get_string_array ( character(len=*), intent(in)  name,
character(len=*), intent(in), optional  caller 
)

Definition at line 1131 of file fm_util.F90.

Here is the caller graph for this function:

◆ fm_util_reset_caller()

subroutine, public fm_util_mod::fm_util_reset_caller ( )

Definition at line 205 of file fm_util.F90.

Here is the caller graph for this function:

◆ fm_util_reset_good_name_list()

subroutine, public fm_util_mod::fm_util_reset_good_name_list ( )

Definition at line 282 of file fm_util.F90.

Here is the caller graph for this function:

◆ fm_util_reset_no_overwrite()

subroutine, public fm_util_mod::fm_util_reset_no_overwrite ( )

Definition at line 359 of file fm_util.F90.

Here is the caller graph for this function:

◆ fm_util_set_caller()

subroutine, public fm_util_mod::fm_util_set_caller ( character(len=*), intent(in)  caller)

Definition at line 159 of file fm_util.F90.

Here is the caller graph for this function:

◆ fm_util_set_good_name_list()

subroutine, public fm_util_mod::fm_util_set_good_name_list ( character(len=*), intent(in)  good_name_list)

Definition at line 240 of file fm_util.F90.

Here is the caller graph for this function:

◆ fm_util_set_no_overwrite()

subroutine, public fm_util_mod::fm_util_set_no_overwrite ( logical, intent(in)  no_overwrite)

Definition at line 317 of file fm_util.F90.

Here is the caller graph for this function:

◆ fm_util_set_value_integer()

subroutine, public fm_util_mod::fm_util_set_value_integer ( character(len=*), intent(in)  name,
integer, intent(in)  value,
character(len=*), intent(in), optional  caller,
integer, intent(in), optional  index,
logical, intent(in), optional  append,
logical, intent(in), optional  no_create,
logical, intent(in), optional  no_overwrite,
character(len=*), intent(in), optional  good_name_list 
)

Definition at line 2368 of file fm_util.F90.

Here is the call graph for this function:

◆ fm_util_set_value_integer_array()

subroutine, public fm_util_mod::fm_util_set_value_integer_array ( character(len=*), intent(in)  name,
integer, dimension(length), intent(in)  value,
integer, intent(in)  length,
character(len=*), intent(in), optional  caller,
logical, intent(in), optional  no_overwrite,
character(len=fm_path_name_len), intent(in), optional  good_name_list 
)

Definition at line 1711 of file fm_util.F90.

Here is the call graph for this function:

◆ fm_util_set_value_logical()

subroutine, public fm_util_mod::fm_util_set_value_logical ( character(len=*), intent(in)  name,
logical, intent(in)  value,
character(len=*), intent(in), optional  caller,
integer, intent(in), optional  index,
logical, intent(in), optional  append,
logical, intent(in), optional  no_create,
logical, intent(in), optional  no_overwrite,
character(len=*), intent(in), optional  good_name_list 
)

Definition at line 2546 of file fm_util.F90.

Here is the call graph for this function:

◆ fm_util_set_value_logical_array()

subroutine, public fm_util_mod::fm_util_set_value_logical_array ( character(len=*), intent(in)  name,
logical, dimension(length), intent(in)  value,
integer, intent(in)  length,
character(len=*), intent(in), optional  caller,
logical, intent(in), optional  no_overwrite,
character(len=fm_path_name_len), intent(in), optional  good_name_list 
)

Definition at line 1875 of file fm_util.F90.

Here is the call graph for this function:

◆ fm_util_set_value_real()

subroutine, public fm_util_mod::fm_util_set_value_real ( character(len=*), intent(in)  name,
real, intent(in)  value,
character(len=*), intent(in), optional  caller,
integer, intent(in), optional  index,
logical, intent(in), optional  append,
logical, intent(in), optional  no_create,
logical, intent(in), optional  no_overwrite,
character(len=*), intent(in), optional  good_name_list 
)

Definition at line 2724 of file fm_util.F90.

Here is the call graph for this function:

◆ fm_util_set_value_real_array()

subroutine, public fm_util_mod::fm_util_set_value_real_array ( character(len=*), intent(in)  name,
real, dimension(length), intent(in)  value,
integer, intent(in)  length,
character(len=*), intent(in), optional  caller,
logical, intent(in), optional  no_overwrite,
character(len=fm_path_name_len), intent(in), optional  good_name_list 
)

Definition at line 2039 of file fm_util.F90.

Here is the call graph for this function:

◆ fm_util_set_value_string()

subroutine, public fm_util_mod::fm_util_set_value_string ( character(len=*), intent(in)  name,
character(len=*), intent(in)  value,
character(len=*), intent(in), optional  caller,
integer, intent(in), optional  index,
logical, intent(in), optional  append,
logical, intent(in), optional  no_create,
logical, intent(in), optional  no_overwrite,
character(len=*), intent(in), optional  good_name_list 
)

Definition at line 2902 of file fm_util.F90.

Here is the call graph for this function:

◆ fm_util_set_value_string_array()

subroutine, public fm_util_mod::fm_util_set_value_string_array ( character(len=*), intent(in)  name,
character(len=*), dimension(length), intent(in)  value,
integer, intent(in)  length,
character(len=*), intent(in), optional  caller,
logical, intent(in), optional  no_overwrite,
character(len=fm_path_name_len), intent(in), optional  good_name_list 
)

Definition at line 2203 of file fm_util.F90.

Here is the call graph for this function:

◆ fm_util_start_namelist()

subroutine, public fm_util_mod::fm_util_start_namelist ( character(len=*), intent(in)  path,
character(len=*), intent(in)  name,
character(len=*), intent(in), optional  caller,
logical, intent(in), optional  no_overwrite,
logical, intent(in), optional  check 
)

Definition at line 3078 of file fm_util.F90.

Here is the call graph for this function:

Variable Documentation

◆ default_good_name_list

character(len=128) fm_util_mod::default_good_name_list = ' '
private

Definition at line 102 of file fm_util.F90.

◆ default_no_overwrite

logical fm_util_mod::default_no_overwrite = .false.
private

Definition at line 104 of file fm_util.F90.

◆ fm_util_default_caller

character(len=128), public fm_util_mod::fm_util_default_caller = ' '

Definition at line 89 of file fm_util.F90.

◆ mod_name

character(len=48), parameter fm_util_mod::mod_name = 'fm_util_mod'
private

Definition at line 95 of file fm_util.F90.

◆ save_current_list

character(len=fm_path_name_len) fm_util_mod::save_current_list
private

Definition at line 106 of file fm_util.F90.

◆ save_default_caller

character(len=128) fm_util_mod::save_default_caller = ' '
private

Definition at line 101 of file fm_util.F90.

◆ save_default_good_name_list

character(len=128) fm_util_mod::save_default_good_name_list = ' '
private

Definition at line 103 of file fm_util.F90.

◆ save_default_no_overwrite

logical fm_util_mod::save_default_no_overwrite = .false.
private

Definition at line 105 of file fm_util.F90.

◆ save_name

character(len=fm_path_name_len) fm_util_mod::save_name
private

Definition at line 108 of file fm_util.F90.

◆ save_path

character(len=fm_path_name_len) fm_util_mod::save_path
private

Definition at line 107 of file fm_util.F90.