namespace mom_error_handler

Overview

Routines for error handling and I/O management. More…

namespace mom_error_handler {

// global functions

logical function, public is_root_pe();
subroutine, public mom_mesg(message message, verb verb, all_print all_print);
subroutine, public mom_error(level level, message message, all_print all_print);
subroutine, public mom_set_verbosity(verb verb);
integer function, public mom_get_verbosity();
logical function, public mom_verbose_enough(verb verb);
logical function, public calltree_showquery();
subroutine, public calltree_enter(mesg mesg, n n);
subroutine, public calltree_leave(mesg mesg);
subroutine, public calltree_waypoint(mesg mesg, n n);
subroutine, public assert(logical_arg logical_arg, msg msg);

} // namespace mom_error_handler

Detailed Documentation

Routines for error handling and I/O management.

Global Functions

logical function, public is_root_pe()

This returns .true. if the current PE is the root PE.

subroutine, public mom_mesg(message message, verb verb, all_print all_print)

This provides a convenient interface for writing an informative comment.

Parameters:

message	A message to write out
verb	A level of verbosity for this message
all_print	If present and true, any PEs are able to write this message.

subroutine, public mom_error(level level, message message, all_print all_print)

This provides a convenient interface for writing an mpp_error message with run-time filter based on a verbosity.

Parameters:

level	The verbosity level of this message
message	A message to write out
all_print	If present and true, any PEs are able to write this message.

subroutine, public mom_set_verbosity(verb verb)

This subroutine sets the level of verbosity filtering MOM error messages.

Parameters:

verb	A level of verbosity to set

integer function, public mom_get_verbosity()

This subroutine gets the level of verbosity filtering MOM error messages.

logical function, public mom_verbose_enough(verb verb)

This tests whether the level of verbosity filtering MOM error messages is sufficient to write a message of verbosity level verb.

Parameters:

verb	A level of verbosity to test

logical function, public calltree_showquery()

Returns True, if the verbosity>=6 indicating to show the call tree.

subroutine, public calltree_enter(mesg mesg, n n)

Writes a message about entering a subroutine if call tree reporting is active.

Parameters:

mesg	Message to write
n	An optional integer to write at end of message

subroutine, public calltree_leave(mesg mesg)

Writes a message about leaving a subroutine if call tree reporting is active.

Parameters:

mesg	Message to write

subroutine, public calltree_waypoint(mesg mesg, n n)

Writes a message about reaching a milestone if call tree reporting is active.

Parameters:

mesg	Message to write
n	An optional integer to write at end of message

subroutine, public assert(logical_arg logical_arg, msg msg)

Issues a FATAL error if the assertion fails, i.e. the first argument is false.

Parameters:

logical_arg	If false causes a FATAL error
msg	Message to issue in case of failed assertion