version 0.6.0
Logging

Functions

subroutine mod_display_banner::display_banner ()
 Notus banner display routine.
 
subroutine mod_notus_log::notus_log (message, depth, type, processor_rank)
 Log message. More...
 
subroutine mod_notus_log::notus_log_skip_line (type, processor_rank)
 Skip a line in the log. More...
 
subroutine mod_notus_log::notus_log_double (message, double, depth, type, processor_rank)
 Log message with a floating point number. More...
 

Variables

integer, parameter mod_notus_log::notus_log_length = 132
 Maximal length of a log message.
 
integer, parameter mod_notus_log::notus_log_solver_status_length = 61
 Maximal length of a solver log message.
 
logical mod_notus_log::log_has_color = .true.
 Output color.
 

Detailed Description

Function Documentation

◆ notus_log()

subroutine mod_notus_log::notus_log ( character(len=*), intent(in)  message,
integer, intent(in)  depth,
integer, intent(in), optional  type,
integer, intent(in), optional  processor_rank 
)

By default, the routine log the message to the standard or error output.

The log messages are classified by depth and type:

  • The depth argument creates a hierarchy between messages. A message of depth n is related to a message of depth n-1.
  • The type argument defines the type of the message. There are 4 types of messages:
    • notus_log_normal: Normal message (default)
    • notus_log_highlight_information: Normal message but want to highlight for ease of reading standard output file
    • notus_log_warning: Should be used for warning messages (use standard output)
    • notus_log_critical: Should be used for critical messages (use standard error output)
    • notus_log_error: Used for fatal error messages (used by stop_notus routine)
Parameters
[in]messageMessage to log
[in]depthDepth in the hierarchy of messages
[in]typeMessage type: normal, warning, critical or error (default: normal)
[in]processor_rankProcessor that send the message (default: 0)

◆ notus_log_double()

subroutine mod_notus_log::notus_log_double ( character(len=*), intent(in)  message,
double precision, intent(in)  double,
integer, intent(in)  depth,
integer, intent(in), optional  type,
integer, intent(in), optional  processor_rank 
)

Output: <message><double>

All spaces from the float are trimmed out.

By default, the routine log the message to the standard or error output.

The log messages are classified by depth and type:

  • The depth argument creates a hierarchy between messages. A message of depth n is related to a message of depth n-1.
  • The type argument defines the type of the message. There are 4 types of messages:
    • notus_log_normal: Normal message (default)
    • notus_log_highlight_information: Normal message but want to highlight for ease of reading standard output file
    • notus_log_warning: Should be used for warning messages (use standard output)
    • notus_log_critical: Should be used for critical messages (use standard error output)
    • notus_log_error: Used for fatal error messages (used by stop_notus routine)
Parameters
[in]messageMessage to log
[in]doubleFloating point number in double precision
[in]depthDepth in the hierarchy of messages
[in]typeMessage type: normal, warning, critical or error (default: normal)
[in]processor_rankProcessor that send the message (default: 0)

◆ notus_log_skip_line()

subroutine mod_notus_log::notus_log_skip_line ( integer, intent(in), optional  type,
integer, intent(in), optional  processor_rank 
)

The log messages are classified by type:

  • The type argument defines the type of the message. There are 4 types of messages:
    • notus_log_normal: Normal message (default)
    • notus_log_highlight_information: Normal message but want to highlight for ease of reading standard output file
    • notus_log_warning: Should be used for warning messages (use standard output)
    • notus_log_critical: Should be used for critical messages (use standard error output)
    • notus_log_error: Used for fatal error messages (used by stop_notus routine)
Parameters
[in]typeMessage type: normal, warning, critical or error (default: normal)
[in]processor_rankProcessor that send the message (default: 0)