auxerror - Man Page

Name

auxerror — Error Handling Routines

— Error Handling and Error call back routines.  

Synopsis

Functions

subroutine xerror_handler (name, info)
Error handler callback subroutine.
subroutine xerror_set_handler_c (routine)
Set a C routine as error handling callback.
subroutine xerror_set_handler_f (routine)
Set a Fortran routine as error handling callback.

Detailed Description

Error Handling and Error call back routines.

MEPACK uses a similar error handling as LAPACK. In contrast to LAPACK, the error handler in MEPACK is realized as a callback routine, which can be exchanged via passing a pointer to the new function. The callback function can either be a C or a Fortran function.

Function Documentation

subroutine xerror_handler ( name,  info)

Error handler callback subroutine.

Purpose:

  The XERROR_HANDLER subroutine is the callback function used by the sanity checks
  of the computational subroutines. It either displays an error message of 
  if an alternative error handler is set before via XERROR_SET_HANDLER_C or 
  XERROR_SET_HANDLER_F it delegates the error to this function.
See also

xerror_set_handler_c

xerror_set_handler_f

Arguments:

Parameters

NAME

           NAME is CHARACTER(*) 
           Specifies the name of the function where the error appeared.

INFO

           INFO is INTEGER 
           Specifies the error which appeared in the subroutine NAME.
Author

Martin Koehler, MPI Magdeburg

Date

January 2024

Definition at line 63 of file xerror_handler_doc.f90.

subroutine xerror_set_handler_c ( routine)

Set a C routine as error handling callback.

Purpose:

  The XERROR_SET_HANDLER_C subroutine sets the error callback in XERROR_HANDLER to 
  a C function with the following signature: 
 
      void error_handler(const char *name, int info); 
 
  where name is a 0 terminated C compatible string. In order to avoid memory leaks
  the function must return to its call or exit the whole program.
See also

xerror_handler

xerror_set_handler_f

Arguments:

Parameters

ROUTINE

           ROUTINE is an EXTERNAL SUBROUTINE 
           Specifies a C subroutine which is executed as alternative error handler.

Authors:

Author

Martin Koehler, MPI Magdeburg

Date

January 2024

Definition at line 108 of file xerror_handler_doc.f90.

subroutine xerror_set_handler_f ( routine)

Set a Fortran routine as error handling callback.

Purpose:

  The XERROR_SET_HANDLER_F subroutine sets the error callback in XERROR_HANDLER to 
  a Fortran function with the following signature: 
 
      SUBROUTINE ERROR_HANDLER(NAME, INFO) 
          CHARACTER NAME(*) 
          INTEGER INFO 
 
  where NAME is a Fortran-like string. In order to avoid memory leaks
  the function must return to its call or exit the whole program.
See also

xerror_handler

xerror_set_handler_c

Arguments:

Parameters

ROUTINE

           ROUTINE is an EXTERNAL SUBROUTINE 
           Specifies a Fortran subroutine which is executed as alternative error handler.

Authors:

Author

Martin Koehler, MPI Magdeburg

Date

January 2024

Definition at line 155 of file xerror_handler_doc.f90.

Author

Generated automatically by Doxygen for MEPACK from the source code.

Info

Fri Feb 2 2024 00:00:00 Version 1.1.1 MEPACK