mom_obsolete_diagnostics module reference

Provides a mechanism for recording diagnostic variables that are no longer valid, along with their replacement name if appropriate.

More…

Functions/Subroutines

register_obsolete_diagnostics()

Scan through the diag_table searching for obsolete parameters and issue informational messages and optionallly a FATAL error.

diag_found()

Determines whether an obsolete parameter appears in the diag_table.

Detailed Description

Provides a mechanism for recording diagnostic variables that are no longer valid, along with their replacement name if appropriate.

Function/Subroutine Documentation

subroutine mom_obsolete_diagnostics/register_obsolete_diagnostics(param_file, diag)

Scan through the diag_table searching for obsolete parameters and issue informational messages and optionallly a FATAL error.

Parameters:

  • param_file :: [in] The parameter file handle.

  • diag :: [in] A structure used to control diagnostics.

Call to:

diag_found mom_error_handler::mom_error

Called from:

mom::initialize_mom

function mom_obsolete_diagnostics/diag_found(diag, varName, newVarName) [logical]

Determines whether an obsolete parameter appears in the diag_table.

Parameters:

  • diag :: [in] A structure used to control diagnostics.

  • varname :: [in] The obsolete diagnostic name

  • newvarname :: [in] The valid name of this diagnostic

Call to:

mom_diag_mediator::found_in_diagtable mom_error_handler::mom_error

Called from:

register_obsolete_diagnostics