Detailed Description

Routines for error handling and I/O management.

Functions/Subroutines
logical function, public	is_root_pe ()
	This returns .true. if the current PE is the root PE.

subroutine, public	mom_mesg (message, verb, all_print)
	This provides a convenient interface for writing an informative comment. More...

subroutine, public	mom_error (level, message, all_print)
	This provides a convenient interface for writing an mpp_error message with run-time filter based on a verbosity. More...

subroutine, public	mom_set_verbosity (verb)
	This subroutine sets the level of verbosity filtering MOM error messages. More...

integer function, public	mom_get_verbosity ()
	This subroutine gets the level of verbosity filtering MOM error messages.

logical function, public	mom_verbose_enough (verb)
	This tests whether the level of verbosity filtering MOM error messages is sufficient to write a message of verbosity level verb. More...

logical function, public	calltree_showquery ()
	Returns True, if the verbosity>=6 indicating to show the call tree.

subroutine, public	calltree_enter (mesg, n)
	Writes a message about entering a subroutine if call tree reporting is active. More...

subroutine, public	calltree_leave (mesg)
	Writes a message about leaving a subroutine if call tree reporting is active. More...

subroutine, public	calltree_waypoint (mesg, n)
	Writes a message about reaching a milestone if call tree reporting is active. More...

subroutine, public	assert (logical_arg, msg)
	Issues a FATAL error if the assertion fails, i.e. the first argument is false. More...

Variables
integer	verbosity = 6
	Verbosity level: 0 - FATAL messages only 1 - FATAL + WARNING messages only 2 - FATAL + WARNING + NOTE messages only [default] 3 - above + informational 4 - 5 - 6 - above + call tree 7 - 8 - 9 - anything and everything (also set with DEBUG=True)

integer	calltreeindentlevel = 0
	The level of calling within the call tree.

Function/Subroutine Documentation

◆ assert()

subroutine, public mom_error_handler::assert	(	logical, intent(in)	logical_arg,
		character(len=*), intent(in)	msg
	)

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

Parameters

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

Definition at line 182 of file MOM_error_handler.F90.

   logical, intent(in) :: logical_arg !< If false causes a FATAL error
   character(len=*), intent(in) :: msg !< Message to issue in case of failed assertion
  
   if (.not. logical_arg) then
     call mom_error(fatal, msg)
   endif
  

◆ calltree_enter()

subroutine, public mom_error_handler::calltree_enter	(	character(len=*), intent(in)	mesg,
		integer, intent(in), optional	n
	)

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

Parameters

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

Definition at line 130 of file MOM_error_handler.F90.

   character(len=*),  intent(in) :: mesg !< Message to write
   integer, optional, intent(in) :: n !< An optional integer to write at end of message
   ! Local variables
   character(len=8) :: nAsString
   calltreeindentlevel = calltreeindentlevel + 1
   if (verbosity<6) return
   if (is_root_pe()) then
     nasstring = ''
     if (present(n)) then
       write(nasstring(1:8),'(i8)') n
       call mpp_error(note, 'callTree: '// &
         repeat('   ',calltreeindentlevel-1)//'loop '//trim(mesg)//trim(nasstring))
     else
       call mpp_error(note, 'callTree: '// &
         repeat('   ',calltreeindentlevel-1)//'---> '//trim(mesg))
     endif
   endif

◆ calltree_leave()

subroutine, public mom_error_handler::calltree_leave ( character(len=*) mesg )

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

Parameters

mesg	Message to write

Definition at line 151 of file MOM_error_handler.F90.

   character(len=*) :: mesg !< Message to write
   if (calltreeindentlevel<1) write(0,*) 'callTree_leave: error callTreeIndentLevel=',calltreeindentlevel,trim(mesg)
   calltreeindentlevel = calltreeindentlevel - 1
   if (verbosity<6) return
   if (is_root_pe()) call mpp_error(note, 'callTree: '// &
         repeat('   ',calltreeindentlevel)//'<--- '//trim(mesg))

◆ calltree_waypoint()

subroutine, public mom_error_handler::calltree_waypoint	(	character(len=*), intent(in)	mesg,
		integer, intent(in), optional	n
	)

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

Parameters

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

Definition at line 161 of file MOM_error_handler.F90.

   character(len=*),  intent(in) :: mesg !< Message to write
   integer, optional, intent(in) :: n !< An optional integer to write at end of message
   ! Local variables
   character(len=8) :: nAsString
   if (calltreeindentlevel<0) write(0,*) 'callTree_waypoint: error callTreeIndentLevel=',calltreeindentlevel,trim(mesg)
   if (verbosity<6) return
   if (is_root_pe()) then
     nasstring = ''
     if (present(n)) then
       write(nasstring(1:8),'(i8)') n
       call mpp_error(note, 'callTree: '// &
         repeat('   ',calltreeindentlevel)//'loop '//trim(mesg)//trim(nasstring))
     else
       call mpp_error(note, 'callTree: '// &
         repeat('   ',calltreeindentlevel)//'o '//trim(mesg))
     endif
   endif

◆ mom_error()

subroutine, public mom_error_handler::mom_error	(	integer, intent(in)	level,
		character(len=*), intent(in)	message,
		logical, intent(in), optional	all_print
	)

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

Parameters

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

Definition at line 72 of file MOM_error_handler.F90.

   integer,           intent(in) :: level !< The verbosity level of this message
   character(len=*),  intent(in) :: message !< A message to write out
   logical, optional, intent(in) :: all_print !< If present and true, any PEs are
                                              !! able to write this message.
   ! This provides a convenient interface for writing an mpp_error message
   ! with run-time filter based on a verbosity.
   logical :: write_msg
  
   write_msg = is_root_pe()
   if (present(all_print)) write_msg = write_msg .or. all_print
  
   select case (level)
     case (note)
       if (write_msg.and.verbosity>=2) call mpp_error(note, message)
     case (warning)
       if (write_msg.and.verbosity>=1) call mpp_error(warning, message)
     case (fatal)
       if (verbosity>=0) call mpp_error(fatal, message)
     case default
       call mpp_error(level, message)
   end select

◆ mom_mesg()

subroutine, public mom_error_handler::mom_mesg	(	character(len=*), intent(in)	message,
		integer, intent(in), optional	verb,
		logical, intent(in), optional	all_print
	)

This provides a convenient interface for writing an informative comment.

Parameters

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

Definition at line 53 of file MOM_error_handler.F90.

   character(len=*), intent(in)  :: message !< A message to write out
   integer, optional, intent(in) :: verb !< A level of verbosity for this message
   logical, optional, intent(in) :: all_print !< If present and true, any PEs are
                                              !! able to write this message.
   ! This provides a convenient interface for writing an informative comment.
   integer :: verb_msg
   logical :: write_msg
  
   write_msg = is_root_pe()
   if (present(all_print)) write_msg = write_msg .or. all_print
  
   verb_msg = 2 ; if (present(verb)) verb_msg = verb
   if (write_msg .and. (verbosity >= verb_msg)) call mpp_error(note, message)
  

◆ mom_set_verbosity()

subroutine, public mom_error_handler::mom_set_verbosity ( integer, intent(in) verb )

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

Parameters

[in] verb A level of verbosity to set

Definition at line 97 of file MOM_error_handler.F90.

   integer, intent(in) :: verb !< A level of verbosity to set
   character(len=80) :: msg
   if (verb>0 .and. verb<10) then
     verbosity=verb
   else
     write(msg(1:80),'("Attempt to set verbosity outside of range (0-9). verb=",I0)') verb
     call mom_error(fatal,msg)
   endif

◆ mom_verbose_enough()

logical function, public mom_error_handler::mom_verbose_enough ( integer, intent(in) verb )

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

Parameters

[in] verb A level of verbosity to test

Definition at line 116 of file MOM_error_handler.F90.

   integer, intent(in) :: verb !< A level of verbosity to test
   logical :: MOM_verbose_enough
   mom_verbose_enough = (verbosity >= verb)

Detailed Description

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ assert()

◆ calltree_enter()

◆ calltree_leave()

◆ calltree_waypoint()

◆ mom_error()

◆ mom_mesg()

◆ mom_set_verbosity()

◆ mom_verbose_enough()