PUBLIC INTERFACE ~ PUBLIC DATA ~ PUBLIC ROUTINES ~ NAMELIST ~ DIAGNOSTIC FIELDS ~ ERROR MESSAGES ~ REFERENCES ~ NOTES

## Module fm_util_mod

Contact: Richard D. Slater
Reviewers: John P. Dunne
Change History: WebCVS Log

#### OVERVIEW

Utility routines for the field manager

This module provides utility routines for the field manager. Basically, it provides for error catching, reporting and termination while interfacing with the field manager.

#### OTHER MODULES USED

    field_manager_mod
              fms_mod
              mpp_mod

#### PUBLIC INTERFACE

fm_util_set_caller:
fm_util_reset_caller:
fm_util_set_good_name_list:
fm_util_reset_good_name_list:
fm_util_set_no_overwrite:
fm_util_reset_no_overwrite:
fm_util_check_for_bad_fields:
fm_util_get_length:
fm_util_get_index_string:
fm_util_get_index_list:
fm_util_get_integer_array:
fm_util_get_logical_array:
fm_util_get_real_array:
fm_util_get_string_array:
fm_util_get_integer:
fm_util_get_logical:
fm_util_get_real:
fm_util_get_string:
fm_util_set_value_integer_array:
fm_util_set_value_logical_array:
fm_util_set_value_real_array:
fm_util_set_value_string_array:
fm_util_set_value_integer:
fm_util_set_value_logical:
fm_util_set_value_real:
fm_util_set_value_string:
fm_util_start_namelist:
fm_util_end_namelist:

#### PUBLIC DATA

None.

#### PUBLIC ROUTINES

1. #### fm_util_set_caller

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

2. #### fm_util_reset_caller

   DESCRIPTION
     Reset the default value for the optional "caller" variable used in many of these subroutines to blank.

3. #### fm_util_set_good_name_list

   DESCRIPTION
     Set the default value for the optional "good_name_list" variable used in many of these subroutines.

4. #### fm_util_reset_good_name_list

   DESCRIPTION
     Reset the default value for the optional "good_name_list" variable used in many of these subroutines to the saved value.

5. #### fm_util_set_no_overwrite

   DESCRIPTION
     Set the default value for the optional "no_overwrite" variable used in some of these subroutines.

6. #### fm_util_reset_no_overwrite

   DESCRIPTION
     Reset the default value for the optional "no_overwrite" variable used in some of these subroutines to false.

7. #### fm_util_check_for_bad_fields

   DESCRIPTION
     Check for unrecognized fields in a list

8. #### fm_util_get_length

   DESCRIPTION
     Get the length of an element of the Field Manager tree

9. #### fm_util_get_index_string

   DESCRIPTION
     Get the length of an element of the Field Manager tree

10. #### fm_util_get_index_list

    DESCRIPTION
      Get the length of an element of the Field Manager tree

11. #### fm_util_get_integer_array

    DESCRIPTION
      Get an integer value from the Field Manager tree.

12. #### fm_util_get_logical_array

    DESCRIPTION
      Get a logical value from the Field Manager tree.

13. #### fm_util_get_real_array

    DESCRIPTION
      Get a real value from the Field Manager tree.

14. #### fm_util_get_string_array

    DESCRIPTION
      Get a string value from the Field Manager tree.

15. #### fm_util_get_integer

    DESCRIPTION
      Get an integer value from the Field Manager tree.

16. #### fm_util_get_logical

    DESCRIPTION
      Get a logical value from the Field Manager tree.

17. #### fm_util_get_real

    DESCRIPTION
      Get a real value from the Field Manager tree.

18. #### fm_util_get_string

    DESCRIPTION
      Get a string value from the Field Manager tree.

19. #### fm_util_set_value_integer_array

    DESCRIPTION
      Set an integer array in the Field Manager tree.

20. #### fm_util_set_value_logical_array

    DESCRIPTION
      Set a logical array in the Field Manager tree.

21. #### fm_util_set_value_real_array

    DESCRIPTION
      Set a real array in the Field Manager tree.

22. #### fm_util_set_value_string_array

    DESCRIPTION
      Set a string array in the Field Manager tree.

23. #### fm_util_set_value_integer

    DESCRIPTION
      Set an integer value in the Field Manager tree.

24. #### fm_util_set_value_logical

    DESCRIPTION
      Set a logical value in the Field Manager tree.

25. #### fm_util_set_value_real

    DESCRIPTION
      Set a real value in the Field Manager tree.

26. #### fm_util_set_value_string

    DESCRIPTION
      Set a string value in the Field Manager tree.

27. #### fm_util_start_namelist

    DESCRIPTION
      Start processing a namelist

28. #### fm_util_end_namelist

    DESCRIPTION
      Finish up processing a namelist

#### DATA SETS

None.

#### ERROR MESSAGES

None.

#### REFERENCES

None.

#### COMPILER SPECIFICS

None.

#### PRECOMPILER OPTIONS

None.

#### LOADER OPTIONS

None.

#### TEST PROGRAM

None.

#### KNOWN BUGS

None.

#### NOTES

None.

#### FUTURE PLANS

None.

top