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

Module ocean_tpm_util_mod

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


OVERVIEW

Ocean tracer package module pointers module

This module allocates a suite of variables used in ocean_tpm


OTHER MODULES USED

field_manager_mod
fms_mod
mpp_mod
ocean_types_mod

PUBLIC INTERFACE

otpm_set_caller:
otpm_reset_caller:
otpm_set_good_name_list:
otpm_reset_good_name_list:
otpm_set_no_overwrite:
otpm_reset_no_overwrite:
otpm_check_for_bad_fields:
otpm_set_tracer_package:
otpm_get_integer_array:
otpm_get_logical_array:
otpm_get_real_array:
otpm_get_string_array:
otpm_get_integer:
otpm_get_logical:
otpm_get_real:
otpm_get_string:
otpm_set_value_integer_array:
otpm_set_value_logical_array:
otpm_set_value_real_array:
otpm_set_value_string_array:
otpm_set_value_integer:
otpm_set_value_logical:
otpm_set_value_real:
otpm_set_value_string:
set_prog_value_integer:
set_prog_value_logical:
set_prog_value_real:
set_prog_value_string:
otpm_set_prog_tracer:
otpm_set_diag_tracer:
otpm_start_namelist:
otpm_end_namelist:


PUBLIC DATA

None.


PUBLIC ROUTINES

  1. otpm_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. otpm_reset_caller

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



  3. otpm_set_good_name_list

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



  4. otpm_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. otpm_set_no_overwrite

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



  6. otpm_reset_no_overwrite

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



  7. otpm_check_for_bad_fields

    DESCRIPTION
    Check for unrecognized fields in a list



  8. otpm_set_tracer_package

    DESCRIPTION
    Set the values for a tracer package and return its index (0 on error)



  9. otpm_get_integer_array

    DESCRIPTION
    Get an integer value from the Field Manager tree.


  10. otpm_get_logical_array

    DESCRIPTION
    Get a logical value from the Field Manager tree.


  11. otpm_get_real_array

    DESCRIPTION
    Get a real value from the Field Manager tree.


  12. otpm_get_string_array

    DESCRIPTION
    Get a string value from the Field Manager tree.


  13. otpm_get_integer

    DESCRIPTION
    Get an integer value from the Field Manager tree.


  14. otpm_get_logical

    DESCRIPTION
    Get a logical value from the Field Manager tree.


  15. otpm_get_real

    DESCRIPTION
    Get a real value from the Field Manager tree.


  16. otpm_get_string

    DESCRIPTION
    Get a string value from the Field Manager tree.


  17. otpm_set_value_integer_array

    DESCRIPTION
    Set an integer array in the Field Manager tree.


  18. otpm_set_value_logical_array

    DESCRIPTION
    Set a logical array in the Field Manager tree.


  19. otpm_set_value_real_array

    DESCRIPTION
    Set a real array in the Field Manager tree.


  20. otpm_set_value_string_array

    DESCRIPTION
    Set a string array in the Field Manager tree.


  21. otpm_set_value_integer

    DESCRIPTION
    Set an integer value in the Field Manager tree.


  22. otpm_set_value_logical

    DESCRIPTION
    Set a logical value in the Field Manager tree.


  23. otpm_set_value_real

    DESCRIPTION
    Set a real value in the Field Manager tree.


  24. otpm_set_value_string

    DESCRIPTION
    Set a string value in the Field Manager tree.


  25. set_prog_value_integer

    DESCRIPTION
    Set an integer value for a prognostic tracer element in the Field Manager tree.


  26. set_prog_value_logical

    DESCRIPTION
    Set a logical value for a prognostic tracer element in the Field Manager tree.


  27. set_prog_value_real

    DESCRIPTION
    Set a real value for a prognostic tracer element in the Field Manager tree.


  28. set_prog_value_string

    DESCRIPTION
    Set a string value for a prognostic tracer element in the Field Manager tree.


  29. otpm_set_prog_tracer

    DESCRIPTION
    Set the values for a prog tracer and return its index (0 on error)


  30. otpm_set_diag_tracer

    DESCRIPTION
    Set the values for a diag tracer and return its index (0 on error)


  31. otpm_start_namelist

    DESCRIPTION
    Set the values for a diag tracer and return its index (0 on error)


  32. otpm_end_namelist

    DESCRIPTION
    Set the values for a diag tracer and return its index (0 on error)



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