mom_obsolete_params module reference

Methods for testing for, and list of, obsolete run-time parameters.

More…

Functions/Subroutines

find_obsolete_params()	Scans input parameter file for list obsolete parameters.
obsolete_logical()	Test for presence of obsolete LOGICAL in parameter file.
obsolete_char()	Test for presence of obsolete STRING in parameter file.
obsolete_real()	Test for presence of obsolete REAL in parameter file.
obsolete_int()	Test for presence of obsolete INTEGER in parameter file.

Detailed Description

Methods for testing for, and list of, obsolete run-time parameters.

Function/Subroutine Documentation

subroutine mom_obsolete_params/find_obsolete_params(param_file)

Scans input parameter file for list obsolete parameters.

Parameters:

param_file :: param_file [in] Structure containing parameter file data.

Call to:

mom_error_handler::mom_error obsolete_char obsolete_int obsolete_logical obsolete_real

Called from:

mom::initialize_mom

[source]

subroutine mom_obsolete_params/obsolete_logical(param_file, varname, warning_val, hint)

Test for presence of obsolete LOGICAL in parameter file.

Parameters:

• param_file :: param_file [in] Structure containing parameter file data.

• varname :: varname [in] Name of obsolete LOGICAL parameter.

• warning_val :: warning_val [in] An allowed value that causes a warning instead of an error.

• hint :: hint [in] A hint to the user about what to do.

Call to:

mom_error_handler::mom_error

Called from:

find_obsolete_params

[source]

subroutine mom_obsolete_params/obsolete_char(param_file, varname, warning_val, hint)

Test for presence of obsolete STRING in parameter file.

Parameters:

• param_file :: param_file [in] Structure containing parameter file data.

• varname :: varname [in] Name of obsolete STRING parameter.

• warning_val :: warning_val [in] An allowed value that causes a warning instead of an error.

• hint :: hint [in] A hint to the user about what to do.

Call to:

mom_error_handler::mom_error

Called from:

find_obsolete_params

[source]

subroutine mom_obsolete_params/obsolete_real(param_file, varname, warning_val, hint, only_warn)

Test for presence of obsolete REAL in parameter file.

Parameters:

• param_file :: param_file [in] Structure containing parameter file data.

• varname :: varname [in] Name of obsolete REAL parameter.

• warning_val :: warning_val [in] An allowed value that causes a warning instead of an error.

• hint :: hint [in] A hint to the user about what to do.

• only_warn :: only_warn [in] If present and true, issue warnings instead of fatal errors.

Call to:

mom_error_handler::mom_error

Called from:

find_obsolete_params

[source]

subroutine mom_obsolete_params/obsolete_int(param_file, varname, warning_val, hint)

Test for presence of obsolete INTEGER in parameter file.

Parameters:

• param_file :: param_file [in] Structure containing parameter file data.

• varname :: varname [in] Name of obsolete INTEGER parameter.

• warning_val :: warning_val [in] An allowed value that causes a warning instead of an error.

• hint :: hint [in] A hint to the user about what to do.

Call to:

mom_error_handler::mom_error

Called from:

find_obsolete_params

[source]

[source]