namespace mom_obsolete_params

Overview

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

namespace mom_obsolete_params {

// global functions

subroutine, public find_obsolete_params(param_file param_file);

subroutine, public obsolete_logical(
    param_file param_file,
    varname varname,
    warning_val warning_val,
    hint hint
    );

subroutine, public obsolete_char(param_file param_file, varname varname, hint hint);

subroutine, public obsolete_real(
    param_file param_file,
    varname varname,
    warning_val warning_val,
    hint hint
    );

subroutine, public obsolete_int(
    param_file param_file,
    varname varname,
    warning_val warning_val,
    hint hint
    );

} // namespace mom_obsolete_params

Detailed Documentation

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

Global Functions

subroutine, public find_obsolete_params(param_file param_file)

Scans input parameter file for list obsolete parameters.

Parameters:

param_file

Structure containing parameter file data.

subroutine, public obsolete_logical(
    param_file param_file,
    varname varname,
    warning_val warning_val,
    hint hint
    )

Test for presence of obsolete LOGICAL in parameter file.

Parameters:

param_file	Structure containing parameter file data.
varname	Name of obsolete LOGICAL parameter.
warning_val	An allowed value that causes a warning instead of an error.
hint	A hint to the user about what to do.

subroutine, public obsolete_char(
    param_file param_file,
    varname varname,
    hint hint
    )

Test for presence of obsolete STRING in parameter file.

Parameters:

param_file	Structure containing parameter file data.
varname	Name of obsolete STRING parameter.
hint	A hint to the user about what to do.

subroutine, public obsolete_real(
    param_file param_file,
    varname varname,
    warning_val warning_val,
    hint hint
    )

Test for presence of obsolete REAL in parameter file.

Parameters:

param_file	Structure containing parameter file data.
varname	Name of obsolete REAL parameter.
warning_val	An allowed value that causes a warning instead of an error.
hint	A hint to the user about what to do.

subroutine, public obsolete_int(
    param_file param_file,
    varname varname,
    warning_val warning_val,
    hint hint
    )

Test for presence of obsolete INTEGER in parameter file.

Parameters:

param_file	Structure containing parameter file data.
varname	Name of obsolete INTEGER parameter.
warning_val	An allowed value that causes a warning instead of an error.
hint	A hint to the user about what to do.