fm_util_mod

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, public	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, public	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, public	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, public	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, public	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, public	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

Detailed Description

This module provides utility routines for the field manager.

Routines for error catching, reporting and termination while interfacing with the field manager.

Author

Richard D. Slater

---

Data Type Documentation

fm_util_mod::fm_util_set_value

interface fm_util_mod::fm_util_set_value

Definition at line 130 of file fm_util.F90.

Private 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.