FMS 2025.01.02-dev
Flexible Modeling System
|
This module provides utility routines for the field manager. More...
Data Types | |
interface | fm_util_set_value |
Functions/Subroutines | |
subroutine, public | fm_util_check_for_bad_fields (list, good_fields, caller) |
Check for unrecognized fields in a list. | |
subroutine, public | fm_util_end_namelist (path, name, caller, check) |
Finish up processing a namelist. | |
integer function, public | fm_util_get_index_list (name, caller) |
Get the length of an element of the Field Manager tree. | |
integer function, public | fm_util_get_index_string (name, string, caller) |
Get the index of an element of a string in the Field Manager tree. | |
integer function, public | fm_util_get_integer (name, caller, index, default_value, scalar) |
Get an integer value from the Field Manager tree. | |
integer function, dimension(:), pointer, public | fm_util_get_integer_array (name, caller) |
Get an integer value from the Field Manager tree. | |
integer function, public | fm_util_get_length (name, caller) |
Get the length of an element of the Field Manager tree. | |
logical function, public | fm_util_get_logical (name, caller, index, default_value, scalar) |
Get a logical value from the Field Manager tree. | |
logical function, dimension(:), pointer, public | fm_util_get_logical_array (name, caller) |
Get a logical value from the Field Manager tree. | |
real(r8_kind) function, public | fm_util_get_real (name, caller, index, default_value, scalar) |
Get a real value from the Field Manager tree. | |
real(r8_kind) function, dimension(:), pointer, public | fm_util_get_real_array (name, caller) |
Get a real value from the Field Manager tree. | |
character(len=fm_string_len) function, public | fm_util_get_string (name, caller, index, default_value, scalar) |
Get a string value from the Field Manager tree. | |
character(len=fm_string_len) function, dimension(:), pointer, public | fm_util_get_string_array (name, caller) |
Get a string value from the Field Manager tree. | |
subroutine, public | fm_util_reset_caller |
Reset the default value for the optional "caller" variable used in many of these subroutines to blank. | |
subroutine, public | fm_util_reset_good_name_list |
Reset the default value for the optional "good_name_list" variable used in many of these subroutines to the saved value. | |
subroutine, public | fm_util_reset_no_overwrite |
Reset the default value for the optional "no_overwrite" variable used in some of these subroutines to false. | |
subroutine, public | fm_util_set_caller (caller) |
Set the default value for the optional "caller" variable used in many of these subroutines. If the argument is blank, then set the default to blank, otherwise the deault will have brackets placed around the argument. | |
subroutine, public | fm_util_set_good_name_list (good_name_list) |
Set the default value for the optional "good_name_list" variable used in many of these subroutines. | |
subroutine, public | fm_util_set_no_overwrite (no_overwrite) |
Set the default value for the optional "no_overwrite" variable used in some of these subroutines. | |
subroutine | fm_util_set_value_integer (name, ival, caller, index, append, no_create, no_overwrite, good_name_list) |
Set an integer value in the Field Manager tree. | |
subroutine | fm_util_set_value_integer_array (name, ival, length, caller, no_overwrite, good_name_list) |
Set an integer array in the Field Manager tree. | |
subroutine | fm_util_set_value_logical (name, lval, caller, index, append, no_create, no_overwrite, good_name_list) |
Set a logical value in the Field Manager tree. | |
subroutine | fm_util_set_value_logical_array (name, lval, length, caller, no_overwrite, good_name_list) |
Set a logical array in the Field Manager tree. | |
subroutine | fm_util_set_value_string (name, sval, caller, index, append, no_create, no_overwrite, good_name_list) |
Set a string value in the Field Manager tree. | |
subroutine | fm_util_set_value_string_array (name, sval, length, caller, no_overwrite, good_name_list) |
Set a string array in the Field Manager tree. | |
subroutine, public | fm_util_start_namelist (path, name, caller, no_overwrite, check) |
Start processing a namelist. | |
Variables | |
character(len=128) | default_good_name_list = ' ' |
logical | default_no_overwrite = .false. |
character(len=48), parameter | mod_name = 'fm_util_mod' |
character(len=fms_path_len) | save_current_list |
character(len=128) | save_default_caller = ' ' |
character(len=128) | save_default_good_name_list = ' ' |
logical | save_default_no_overwrite = .false. |
character(len=fms_path_len) | save_name |
character(len=fms_path_len) | save_path |
This module provides utility routines for the field manager.
Routines for error catching, reporting and termination while interfacing with the field manager.
interface fm_util_mod::fm_util_set_value |
Definition at line 111 of file fm_util.F90.
Public Member Functions | |
subroutine | fm_util_set_value_integer (name, ival, caller, index, append, no_create, no_overwrite, good_name_list) |
Set an integer value in the Field Manager tree. | |
subroutine | fm_util_set_value_integer_array (name, ival, length, caller, no_overwrite, good_name_list) |
Set an integer array in the Field Manager tree. | |
subroutine | fm_util_set_value_logical (name, lval, caller, index, append, no_create, no_overwrite, good_name_list) |
Set a logical value in the Field Manager tree. | |
subroutine | fm_util_set_value_logical_array (name, lval, length, caller, no_overwrite, good_name_list) |
Set a logical array in the Field Manager tree. | |
fm_util_set_value_real_array_r4 | |
fm_util_set_value_real_array_r8 | |
fm_util_set_value_real_r4 | |
fm_util_set_value_real_r8 | |
subroutine | fm_util_set_value_string (name, sval, caller, index, append, no_create, no_overwrite, good_name_list) |
Set a string value in the Field Manager tree. | |
subroutine | fm_util_set_value_string_array (name, sval, length, caller, no_overwrite, good_name_list) |
Set a string array in the Field Manager tree. | |
subroutine fm_util_set_value_integer | ( | character(len=*), intent(in) | name, |
integer, intent(in) | ival, | ||
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 | ||
) |
Set an integer value in the Field Manager tree.
Definition at line 2044 of file fm_util.F90.
subroutine fm_util_set_value_integer_array | ( | character(len=*), intent(in) | name, |
integer, dimension(length), intent(in) | ival, | ||
integer, intent(in) | length, | ||
character(len=*), intent(in), optional | caller, | ||
logical, intent(in), optional | no_overwrite, | ||
character(len=*), intent(in), optional | good_name_list | ||
) |
Set an integer array in the Field Manager tree.
Definition at line 1573 of file fm_util.F90.
subroutine fm_util_set_value_logical | ( | character(len=*), intent(in) | name, |
logical, intent(in) | lval, | ||
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 | ||
) |
Set a logical value in the Field Manager tree.
Definition at line 2216 of file fm_util.F90.
subroutine fm_util_set_value_logical_array | ( | character(len=*), intent(in) | name, |
logical, dimension(length), intent(in) | lval, | ||
integer, intent(in) | length, | ||
character(len=*), intent(in), optional | caller, | ||
logical, intent(in), optional | no_overwrite, | ||
character(len=*), intent(in), optional | good_name_list | ||
) |
Set a logical array in the Field Manager tree.
Definition at line 1730 of file fm_util.F90.
subroutine fm_util_set_value_string | ( | character(len=*), intent(in) | name, |
character(len=*), intent(in) | sval, | ||
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 | ||
) |
Set a string value in the Field Manager tree.
Definition at line 2387 of file fm_util.F90.
subroutine fm_util_set_value_string_array | ( | character(len=*), intent(in) | name, |
character(len=*), dimension(length), intent(in) | sval, | ||
integer, intent(in) | length, | ||
character(len=*), intent(in), optional | caller, | ||
logical, intent(in), optional | no_overwrite, | ||
character(len=*), intent(in), optional | good_name_list | ||
) |
Set a string array in the Field Manager tree.
Definition at line 1887 of file fm_util.F90.
subroutine, public fm_util_check_for_bad_fields | ( | character(len=*), intent(in) | list, |
character(len=*), dimension(:), intent(in) | good_fields, | ||
character(len=*), intent(in), optional | caller | ||
) |
Check for unrecognized fields in a list.
Definition at line 323 of file fm_util.F90.
subroutine, public 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 | ||
) |
Finish up processing a namelist.
Definition at line 2724 of file fm_util.F90.
integer function, public fm_util_get_index_list | ( | character(len=*), intent(in) | name, |
character(len=*), intent(in), optional | caller | ||
) |
Get the length of an element of the Field Manager tree.
Definition at line 658 of file fm_util.F90.
integer function, public fm_util_get_index_string | ( | character(len=*), intent(in) | name, |
character(len=*), intent(in) | string, | ||
character(len=*), intent(in), optional | caller | ||
) |
Get the index of an element of a string in the Field Manager tree.
Definition at line 554 of file fm_util.F90.
integer function, public 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 | ||
) |
Get an integer value from the Field Manager tree.
Definition at line 1112 of file fm_util.F90.
integer function, dimension(:), pointer, public fm_util_get_integer_array | ( | character(len=*), intent(in) | name, |
character(len=*), intent(in), optional | caller | ||
) |
Get an integer value from the Field Manager tree.
Definition at line 743 of file fm_util.F90.
integer function, public fm_util_get_length | ( | character(len=*), intent(in) | name, |
character(len=*), intent(in), optional | caller | ||
) |
Get the length of an element of the Field Manager tree.
Definition at line 480 of file fm_util.F90.
logical function, public 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 | ||
) |
Get a logical value from the Field Manager tree.
Definition at line 1225 of file fm_util.F90.
logical function, dimension(:), pointer, public fm_util_get_logical_array | ( | character(len=*), intent(in) | name, |
character(len=*), intent(in), optional | caller | ||
) |
Get a logical value from the Field Manager tree.
Definition at line 835 of file fm_util.F90.
real(r8_kind) function, public fm_util_get_real | ( | character(len=*), intent(in) | name, |
character(len=*), intent(in), optional | caller, | ||
integer, intent(in), optional | index, | ||
real(r8_kind), intent(in), optional | default_value, | ||
logical, intent(in), optional | scalar | ||
) |
Get a real value from the Field Manager tree.
Definition at line 1339 of file fm_util.F90.
real(r8_kind) function, dimension(:), pointer, public fm_util_get_real_array | ( | character(len=*), intent(in) | name, |
character(len=*), intent(in), optional | caller | ||
) |
Get a real value from the Field Manager tree.
Definition at line 927 of file fm_util.F90.
character(len=fm_string_len) function, public 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 | ||
) |
Get a string value from the Field Manager tree.
Definition at line 1460 of file fm_util.F90.
character(len=fm_string_len) function, dimension(:), pointer, public fm_util_get_string_array | ( | character(len=*), intent(in) | name, |
character(len=*), intent(in), optional | caller | ||
) |
Get a string value from the Field Manager tree.
Definition at line 1020 of file fm_util.F90.
subroutine, public fm_util_reset_caller |
Reset the default value for the optional "caller" variable used in many of these subroutines to blank.
Definition at line 175 of file fm_util.F90.
subroutine, public fm_util_reset_good_name_list |
Reset the default value for the optional "good_name_list" variable used in many of these subroutines to the saved value.
Definition at line 236 of file fm_util.F90.
subroutine, public fm_util_reset_no_overwrite |
Reset the default value for the optional "no_overwrite" variable used in some of these subroutines to false.
Definition at line 297 of file fm_util.F90.
subroutine, public fm_util_set_caller | ( | character(len=*), intent(in) | caller | ) |
Set the default value for the optional "caller" variable used in many of these subroutines. If the argument is blank, then set the default to blank, otherwise the deault will have brackets placed around the argument.
Definition at line 137 of file fm_util.F90.
subroutine, public fm_util_set_good_name_list | ( | character(len=*), intent(in) | good_name_list | ) |
Set the default value for the optional "good_name_list" variable used in many of these subroutines.
Definition at line 202 of file fm_util.F90.
subroutine, public fm_util_set_no_overwrite | ( | logical, intent(in) | no_overwrite | ) |
Set the default value for the optional "no_overwrite" variable used in some of these subroutines.
Definition at line 263 of file fm_util.F90.
|
private |
Set an integer value in the Field Manager tree.
Definition at line 2044 of file fm_util.F90.
|
private |
Set an integer array in the Field Manager tree.
Definition at line 1573 of file fm_util.F90.
|
private |
Set a logical value in the Field Manager tree.
Definition at line 2216 of file fm_util.F90.
|
private |
Set a logical array in the Field Manager tree.
Definition at line 1730 of file fm_util.F90.
|
private |
Set a string value in the Field Manager tree.
Definition at line 2387 of file fm_util.F90.
|
private |
Set a string array in the Field Manager tree.
Definition at line 1887 of file fm_util.F90.
subroutine, public 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 | ||
) |
Start processing a namelist.
Definition at line 2559 of file fm_util.F90.
|
private |
Definition at line 84 of file fm_util.F90.
|
private |
Definition at line 86 of file fm_util.F90.
|
private |
Definition at line 77 of file fm_util.F90.
|
private |
Definition at line 88 of file fm_util.F90.
|
private |
Definition at line 83 of file fm_util.F90.
|
private |
Definition at line 85 of file fm_util.F90.
|
private |
Definition at line 87 of file fm_util.F90.
|
private |
Definition at line 90 of file fm_util.F90.
|
private |
Definition at line 89 of file fm_util.F90.