comin_setup_constants.F90

Go to the documentation of this file.

!> @file comin_setup_constants.F90
!! @brief ComIn utilities, containing named constants for entry points and
!!        named constants for variable state (READ, WRITE, ...).
!
!  @authors 01/2023 :: 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_setup_constants
  USE iso_c_binding,        ONLY : c_double, c_float
 
  IMPLICIT NONE
 
  PUBLIC
 
#include "comin_global.inc"
 
  !> working precision
  !! @ingroup fortran_interface
  INTEGER, PARAMETER   :: wp = c_double
  INTEGER, PARAMETER   :: dp = c_double
  INTEGER, PARAMETER   :: sp = c_float
 
  !> List of entry points
  !!
  !! Note: EP_DESTRUCTOR should always be the last entry
  !! @ingroup fortran_interface
  ENUM, BIND(C)
    ENUMERATOR :: ep_secondary_constructor = 1, &
      &           EP_ATM_YAC_DEFCOMP_BEFORE,    &
      &           EP_ATM_YAC_DEFCOMP_AFTER,     &
      &           EP_ATM_YAC_SYNCDEF_BEFORE,    &
      &           EP_ATM_YAC_SYNCDEF_AFTER,     &
      &           EP_ATM_YAC_ENDDEF_BEFORE,     &
      &           EP_ATM_YAC_ENDDEF_AFTER,      &
      &           EP_ATM_INIT_FINALIZE,         &
      &           EP_ATM_TIMELOOP_BEFORE,       &
      &           EP_ATM_TIMELOOP_START,        &
      &           EP_ATM_TIMELOOP_END,          &
      &           EP_ATM_TIMELOOP_AFTER,        &
      &           EP_ATM_INTEGRATE_BEFORE,      &
      &           EP_ATM_INTEGRATE_START,       &
      &           EP_ATM_INTEGRATE_END,         &
      &           EP_ATM_INTEGRATE_AFTER,       &
      &           EP_ATM_WRITE_OUTPUT_BEFORE,   &
      &           EP_ATM_WRITE_OUTPUT_AFTER,    &
      &           EP_ATM_CHECKPOINT_BEFORE,     &
      &           EP_ATM_CHECKPOINT_AFTER,      &
      &           EP_ATM_ADVECTION_BEFORE,      &
      &           EP_ATM_ADVECTION_AFTER,       &
      &           EP_ATM_PHYSICS_BEFORE,        &
      &           EP_ATM_PHYSICS_AFTER,         &
      &           EP_ATM_NUDGING_BEFORE,        &
      &           EP_ATM_NUDGING_AFTER,         &
      &           EP_ATM_SURFACE_BEFORE,        &
      &           EP_ATM_SURFACE_AFTER,         &
      &           EP_ATM_TURBULENCE_BEFORE,     &
      &           EP_ATM_TURBULENCE_AFTER,      &
      &           EP_ATM_MICROPHYSICS_BEFORE,   &
      &           EP_ATM_MICROPHYSICS_AFTER,    &
      &           EP_ATM_CONVECTION_BEFORE,     &
      &           EP_ATM_CONVECTION_AFTER,      &
      &           EP_ATM_RADIATION_BEFORE,      &
      &           EP_ATM_RADIATION_AFTER,       &
      &           EP_ATM_RADHEAT_BEFORE,        &
      &           EP_ATM_RADHEAT_AFTER,         &
      &           EP_ATM_GWDRAG_BEFORE,         &
      &           EP_ATM_GWDRAG_AFTER,          &
      &           EP_FINISH,                    &
      &           EP_DESTRUCTOR
  end ENUM
 
  !> Variable access flags.
  !! @ingroup fortran_interface
  ENUM, BIND(C)
    ENUMERATOR :: comin_flag_none         = 0,          &
      &           COMIN_FLAG_READ         = IBSET(0,1), &
      &           COMIN_FLAG_WRITE        = IBSET(0,2), &
      &           COMIN_FLAG_SYNC_HALO    = IBSET(0,3), &
      &           COMIN_FLAG_DEVICE       = IBSET(0,4)
  end ENUM
 
  !> integer constant, which gives an interpretation of the horizontal
  !> grid location (cell, edge, vertex).
  !! @ingroup fortran_interface
  ENUM, BIND(C)
    ENUMERATOR :: comin_hgrid_unstructured_cell   = 1,  &
     &            COMIN_HGRID_UNSTRUCTURED_EDGE   = 2,  &
     &            COMIN_HGRID_UNSTRUCTURED_VERTEX = 3
  end ENUM
 
  !> Integer constants, giving an interpretation of the vertical axis
  !! (2D, atmospheric levels, ...)
  !! @ingroup fortran_interface
  ENUM, BIND(C)
    ENUMERATOR :: comin_zaxis_undef         = -1,   &
      &           COMIN_ZAXIS_NONE          =  0,   &
      &           COMIN_ZAXIS_2D            =  1,   &
      &           COMIN_ZAXIS_3D            =  2,   &
      &           COMIN_ZAXIS_3D_HALF       =  3
  end ENUM
 
  !> Type ids for metadata
  !! @ingroup fortran_interface
  ENUM, BIND(C)
    ENUMERATOR :: comin_metadata_typeid_undefined = -1, &
         &        COMIN_METADATA_TYPEID_INTEGER   =  0, &
         &        COMIN_METADATA_TYPEID_REAL      =  1, &
         &        COMIN_METADATA_TYPEID_CHARACTER =  2, &
         &        COMIN_METADATA_TYPEID_LOGICAL   =  3
  end ENUM
 
  !> Integer constants, giving an interpretation of variable data types
  !! @ingroup fortran_interface
  ENUM, BIND(C)
    ENUMERATOR :: comin_var_datatype_double = 1,   &
       &          COMIN_VAR_DATATYPE_FLOAT,        &
       &          COMIN_VAR_DATATYPE_INT
  end ENUM
 
  !> Dimension semantics
  !! @ingroup fortran_interface
  ENUM, BIND(C)
    ENUMERATOR :: comin_dim_semantics_undef           =  1, & ! not explicitly defined
       &          COMIN_DIM_SEMANTICS_NPROMA    =  2, & ! nproma
       &          COMIN_DIM_SEMANTICS_BLOCK     =  3, & ! blocked data layout
       &          COMIN_DIM_SEMANTICS_UNBLOCK   =  4, & ! unblocked data layout
       &          COMIN_DIM_SEMANTICS_LEVEL     =  5, & ! vertical axis dimension
       &          COMIN_DIM_SEMANTICS_CONTAINER =  6, & ! container
       &          COMIN_DIM_SEMANTICS_OTHER     =  7, & ! special cases (tracers, tiles, etc)
       &          COMIN_DIM_SEMANTICS_UNUSED    =  8    ! unused dimension
  end ENUM
 
END MODULE comin_setup_constants