siesta_error.f90

!*******************************************************************************
!
!  Note separating the Doxygen comment block here so detailed decription is
!  found in the Module not the file.
!
!*******************************************************************************
      MODULE siesta_error
      USE v3_utilities, ONLY: assert
      USE shared_data, Only: lrecon
 
      IMPLICIT NONE
 
!*******************************************************************************
!  module parameters
!*******************************************************************************
      INTEGER, PARAMETER :: siesta_error_no_error   = 0
 
!  Bit positions for the various error conditions.
      INTEGER, PARAMETER :: siesta_error_assert     = 0
      INTEGER, PARAMETER :: siesta_error_block_tri  = 1
      INTEGER, PARAMETER :: siesta_error_general    = 2
      INTEGER, PARAMETER :: siesta_error_allocation = 3
      INTEGER, PARAMETER :: siesta_error_io         = 4
 
!*******************************************************************************
!  module variables.
!*******************************************************************************
      INTEGER :: siesta_error_state = siesta_error_no_error
 
      CONTAINS
!*******************************************************************************
!  SETTER SUBROUTINES
!*******************************************************************************
!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
      SUBROUTINE siesta_error_set_error(error_code, message)
      USE descriptor_mod, ONLY: iam
 
      IMPLICIT NONE
 
!  Declare Arguments
      INTEGER, INTENT(in)           :: error_code
      CHARACTER (len=*), INTENT(in) :: message
 
!  Start of executable code.
      siesta_error_state = ibset(siesta_error_state, error_code)
 
      CALL assert(lrecon, message)
      IF (iam .EQ. 0) WRITE (*,*) trim(message)
 
      END SUBROUTINE
 
!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
      SUBROUTINE siesta_error_clear_error(error_code)
 
      IMPLICIT NONE
 
!  Declare Arguments
      INTEGER, INTENT(in) :: error_code
 
!  Start of executable code.
      siesta_error_state = ibclr(siesta_error_state, error_code)
 
      END SUBROUTINE
 
!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
      SUBROUTINE siesta_error_clear_all
 
      IMPLICIT NONE
 
!  Start of executable code.
      siesta_error_state = siesta_error_no_error
 
      END SUBROUTINE
 
      END MODULE