comin_errhandler_constants.F90

Go to the documentation of this file.

 
!
!  @authors 09/2023 :: ICON Community Interface  <icon@dwd.de>
!
!  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_constants
 
  IMPLICIT NONE
 
  PUBLIC
#include "comin_global.inc"
 
  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_PLUGIN_INIT_COMIN_VERSION,                       &
      &           COMIN_ERROR_PLUGIN_INIT_PRECISION,                           &
      &           COMIN_ERROR_PLUGIN_INIT_STATE_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_FATAL
  end ENUM
 
CONTAINS
 
  FUNCTION comin_errhandler_get_string(err_code) RESULT(string)
    CHARACTER(LEN=COMIN_MAX_LEN_ERR_MESSAGE) :: string
    INTEGER, INTENT(IN) :: err_code
 
    SELECT CASE(err_code)
    CASE(comin_success)
      string = "Success"
    CASE(comin_info)
      string = "Info"
    CASE(comin_warning)
      string = "Warning"
    CASE(comin_error_status)
      string = "Error"
    CASE(comin_error_callback_register_outside_primaryconstructor)
      string = "Callbacks cannot be registered after primary constructor."
    CASE(comin_error_callback_complete)
      string = "Callback registration could not be completed."
    CASE(comin_error_callback_ep_id_unknown)
      string = "Unknown id for ENTRY point."
    CASE(comin_error_descrdata_set_fct_glb2loc)
      string = "Unable to set descriptive DATA FUNCTION: glb2loc. FUNCTION not associated."
    CASE(comin_error_descrdata_finalize)
      string = "Unable to clean up descriptive DATA structure (finalize)."
    CASE(comin_error_metadata_set_outside_primaryconstructor)
      string = "Cannot set metadata outside primary constructor."
    CASE(comin_error_metadata_key_not_found)
      string = "Metadata key not found."
    CASE(comin_error_metadata_get_inside_primaryconstructor)
      string = "Unable to get metadata inside primary constructor."
    CASE(comin_error_setup_finalize)
      string = "Setup finalized failed."
    CASE(comin_error_setup_comin_already_initialized)
      string = "ComIn is already initilized."
    CASE(comin_error_plugin_init_comin_version)
      string = "Host and plugin are using incompatible ComIn versions."
    CASE(comin_error_plugin_init_precision)
      string = "Host and plugin are using incompatible PRECISION (wp)."
    CASE(comin_error_plugin_init_state_initialized)
      string = "State is already initialized WITH a different state."
    CASE(comin_error_setup_errhandler_not_associated)
      string = "The host model error handler PROCEDURE cannot be found."
    CASE(comin_error_setup_errhandler_not_set)
      string = "Error handler not set (setup check)."
    CASE(comin_error_setup_precision_test_failed)
      string = "PRECISION test failed (setup check)."
    CASE(comin_error_var_request_after_primaryconstructor)
      string = "Variables cannot be requested after primary constructor."
    CASE(comin_error_var_request_exists_is_lmodexclusive)
      string = "Requested variable already exists and is exclusive."
    CASE(comin_error_var_request_exists_request_lmodexclusive)
      string = "Requested exclusive variable already exists."
    CASE(comin_error_var_descriptor_not_found)
      string = "var_descriptor not found."
    CASE(comin_error_var_item_not_associated)
      string = "var_item not associated."
    CASE(comin_error_field_not_allocated)
      string = "Filed not allocated."
    CASE(comin_error_pointer_not_associated)
      string = "POINTER not associated."
    CASE(comin_error_tracer_request_not_for_all_domains)
      string = "Traers need to be requested for all domains (id=-1)."
    CASE(comin_error_var_sync_device_mem_not_associated)
      string = "Sync device memory callback not set (setup check)."
    CASE(comin_error_var_sync_halo_not_associated)
      string = "Sync halo callback not set (setup check)."
    CASE(comin_error_var_get_outside_secondary_constructor)
      string = "Cannot get variable outside of secondary constructor"
    CASE(comin_error_var_get_no_device)
      string = "No device available"
    CASE(comin_error_var_get_variable_not_found)
      string = "Cannot find variable"
    CASE(comin_error_var_get_container_can_not_halo_synchronized)
      string = "Cannot halo sync a container"
    CASE(comin_error_var_get_irregular_var_can_not_halo_synchronized)
      string = "Cannot halo sync an irregular variable"
    CASE(comin_error_var_sync_halo_not_supported_zaxis)
      string = "Can only halo sync vars on 2D or 3D vertical grid"
    CASE(comin_error_var_get_variable_wrong_type)
      string = "Wrong type used requesting the pointer of a variable"
    CASE(comin_error_fatal)
      string = "Fatal error"
    END SELECT
  END FUNCTION comin_errhandler_get_string
END MODULE comin_errhandler_constants