comin_errhandler_types.F90

Go to the documentation of this file.

!> @file comin_errhandler_types.F90
!! @brief Common data structures for error handling.
!
!  @authors 08/2021 :: ICON Community Interface  <comin@icon-model.org>
!
!  SPDX-License-Identifier: BSD-3-Clause
!
!  See LICENSES for license information.
!  Where software is supplied by third parties, it is indicated in the
!  headers of the routines.
!
MODULE comin_errhandler_types
 
  USE iso_c_binding, ONLY: c_char, c_size_t
 
  IMPLICIT NONE
  PUBLIC
 
  !> define list of error points
  !> COMIN_ERROR_FATAL should always be the last entry
  ENUM, BIND(C)
    ENUMERATOR :: comin_success = 0,                                           &
      &           COMIN_INFO,                                                  &
      &           COMIN_WARNING,                                               &
      &           COMIN_ERROR_STATUS,                                          &
      &           COMIN_ERROR_CALLBACK_REGISTER_OUTSIDE_PRIMARYCONSTRUCTOR,    &
      &           COMIN_ERROR_CALLBACK_COMPLETE,                               &
      &           COMIN_ERROR_CALLBACK_EP_ID_UNKNOWN,                          &
      &           COMIN_ERROR_DESCRDATA_SET_FCT_GLB2LOC,                       &
      &           COMIN_ERROR_DESCRDATA_FINALIZE,                              &
      &           COMIN_ERROR_METADATA_SET_OUTSIDE_PRIMARYCONSTRUCTOR,         &
      &           COMIN_ERROR_METADATA_KEY_NOT_FOUND,                          &
      &           COMIN_ERROR_METADATA_GET_INSIDE_PRIMARYCONSTRUCTOR,          &
      &           COMIN_ERROR_SETUP_FINALIZE,                                  &
      &           COMIN_ERROR_SETUP_COMIN_ALREADY_INITIALIZED,                 &
      &           COMIN_ERROR_SETUP_ERRHANDLER_NOT_ASSOCIATED,                 &
      &           COMIN_ERROR_SETUP_ERRHANDLER_NOT_SET,                        &
      &           COMIN_ERROR_SETUP_PRECISION_TEST_FAILED,                     &
      &           COMIN_ERROR_VAR_REQUEST_AFTER_PRIMARYCONSTRUCTOR,            &
      &           COMIN_ERROR_VAR_REQUEST_EXISTS_IS_LMODEXCLUSIVE,             &
      &           COMIN_ERROR_VAR_REQUEST_EXISTS_REQUEST_LMODEXCLUSIVE,        &
      &           COMIN_ERROR_VAR_DESCRIPTOR_NOT_FOUND,                        &
      &           COMIN_ERROR_VAR_ITEM_NOT_ASSOCIATED,                         &
      &           COMIN_ERROR_FIELD_NOT_ALLOCATED,                             &
      &           COMIN_ERROR_POINTER_NOT_ASSOCIATED,                          &
      &           COMIN_ERROR_TRACER_REQUEST_NOT_FOR_ALL_DOMAINS,              &
      &           COMIN_ERROR_VAR_SYNC_DEVICE_MEM_NOT_ASSOCIATED,              &
      &           COMIN_ERROR_VAR_SYNC_HALO_NOT_ASSOCIATED,                    &
      &           COMIN_ERROR_VAR_GET_OUTSIDE_SECONDARY_CONSTRUCTOR,           &
      &           COMIN_ERROR_VAR_GET_NO_DEVICE,                               &
      &           COMIN_ERROR_VAR_GET_VARIABLE_NOT_FOUND,                      &
      &           COMIN_ERROR_VAR_GET_CONTAINER_CAN_NOT_HALO_SYNCHRONIZED,     &
      &           COMIN_ERROR_VAR_GET_IRREGULAR_VAR_CAN_NOT_HALO_SYNCHRONIZED, &
      &           COMIN_ERROR_VAR_SYNC_HALO_NOT_SUPPORTED_ZAXIS,               &
      &           COMIN_ERROR_VAR_METADATA_INCONSISTENT_TYPE,                  &
      &           COMIN_ERROR_VAR_GET_VARIABLE_WRONG_TYPE,                     &
      &           COMIN_ERROR_INDEX_OUT_OF_BOUNDS,                             &
      &           COMIN_ERROR_DESCRDATA_TIMESTEPLENGTH_NOT_SET,                &
      &           COMIN_ERROR_FATAL
  end ENUM
 
  INTERFACE
    !> In order to be C-compliant, the following interface is incompatible with ICON `finish`; it requires a wrapper function in ICON.
    SUBROUTINE comin_host_errhandler_fct(routine, text) BIND(C)
      IMPORT c_char
      CHARACTER(kind=c_char) :: routine(*)
      CHARACTER(kind=c_char) :: text(*)
    END SUBROUTINE comin_host_errhandler_fct
  END INTERFACE
 
END MODULE comin_errhandler_types