comin_descrdata_types.F90

Go to the documentation of this file.

 
!
!  @authors 10/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_descrdata_types
  USE iso_c_binding,         ONLY : c_signed_char, c_int, c_bool
  USE comin_setup_constants, ONLY : wp
  IMPLICIT NONE
 
  PRIVATE
 
  PUBLIC :: t_comin_descrdata_global
  PUBLIC :: t_comin_descrdata_domain
  PUBLIC :: t_comin_descrdata_domain_cells
  PUBLIC :: t_comin_descrdata_domain_edges
  PUBLIC :: t_comin_descrdata_domain_verts
  PUBLIC :: t_comin_descrdata_simulation_interval
  PUBLIC :: comin_glb2loc_index_lookup_fct
 
#include "comin_global.inc"
 
  ! ------------------------------------
  ! data types for descriptive data structures
  ! ------------------------------------
 
  ! Descriptive data from p_patch apart from few exceptions (e.g. lon and lat)
  ! handed to ComIn as pointer, all other descriptive data are copies from
  ! host model, which need to be updated during the model simulation if changed
 
  TYPE :: t_comin_descrdata_global
    ! number of logical domains
    INTEGER(C_INT)        :: n_dom
    ! maximum number of model domains
    INTEGER(C_INT)        :: max_dom
    ! block size
    INTEGER(C_INT)        :: nproma
    ! KIND value (REAL)
    INTEGER(C_INT)        :: wp
    ! block index
    INTEGER(C_INT)        :: min_rlcell_int
    INTEGER(C_INT)        :: min_rlcell
    INTEGER(C_INT)        :: max_rlcell
    INTEGER(C_INT)        :: min_rlvert_int
    INTEGER(C_INT)        :: min_rlvert
    INTEGER(C_INT)        :: max_rlvert
    INTEGER(C_INT)        :: min_rledge_int
    INTEGER(C_INT)        :: min_rledge
    INTEGER(C_INT)        :: max_rledge
    ! block index
    INTEGER(C_INT)        :: grf_bdywidth_c
    INTEGER(C_INT)        :: grf_bdywidth_e
    ! whether this is a restarted run
    LOGICAL(C_BOOL)       :: lrestartrun
    ! parameter A of the vertical coordinate (without influence of topography)
    ! index=1,nlev+1
    REAL(wp), ALLOCATABLE :: vct_a(:)
    ! The yac instance id used by the host model
    INTEGER(C_INT)        :: yac_instance_id
    ! Host model version information
    CHARACTER(LEN=:), ALLOCATABLE :: host_git_remote_url
    CHARACTER(LEN=:), ALLOCATABLE :: host_git_branch
    CHARACTER(LEN=:), ALLOCATABLE :: host_git_tag
    CHARACTER(LEN=:), ALLOCATABLE :: host_revision
    ! Information about the computation device (accelerator)
    LOGICAL(C_BOOL)               :: has_device
    CHARACTER(LEN=:), ALLOCATABLE :: device_name
    CHARACTER(LEN=:), ALLOCATABLE :: device_vendor
    CHARACTER(LEN=:), ALLOCATABLE :: device_driver
  END TYPE t_comin_descrdata_global
 
  TYPE :: t_comin_descrdata_domain_cells
    ! number of local cells
    INTEGER(C_INT), POINTER :: ncells => null()
    ! number of global cells
    INTEGER(C_INT), POINTER :: ncells_global => null()
    ! number of blocks for cells
    INTEGER(C_INT), POINTER :: nblks => null()
 
    INTEGER(C_INT), POINTER          :: max_connectivity => null()
    ! number of edges connected to cell
    ! index1=1,nproma, index2=1,nblks_c
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: num_edges(:,:) => null()
    ! lateral boundary distance indices
    ! index1=1,nproma, index2=1,nblks_c
    INTEGER(C_INT), POINTER             :: refin_ctrl(:,:) => null()
    ! list of start indices for each refin_ctrl level
    ! index1=min_rlcell,max_rlcell (defined in mo_impl_constants)
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: start_index(:) => null()
    ! list of end indices for each refin_ctrl level
    ! index1=min_rlcell,max_rlcell
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: end_index(:) => null()
    ! list of start block for each refin_ctrl level
    ! index1=min_rlcell,max_rlcell
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: start_block(:) => null()
    ! list of end block for each refin_ctrl level
    ! index1=min_rlcell,max_rlcell
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: end_block(:) => null()
    ! domain ID of child triangles:
    ! index1=1,nproma, index2=1,nblks_c
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: child_id(:,:) => null()
    ! line index of parent triangle:
    ! index1=1,nproma, index2=1,nblks_c
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: parent_glb_idx(:,:) => null()
    ! block index of parent triangle:
    ! index1=1,nproma, index2=1,nblks_c
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: parent_glb_blk(:,:) => null()
    ! line indices and blocks of verts of triangle:
    ! index1=1,nproma, index2=1,nblks_c, index3=1,3
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: vertex_idx(:,:,:) => null()
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: vertex_blk(:,:,:) => null()
    ! line indices and blocks of neighbors of triangle:
    ! index1=1,nproma, index2=1,nblks_c, index3=1,3
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: neighbor_blk(:,:,:) => null()
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: neighbor_idx(:,:,:) => null()
    ! line indices and blocks of edges of triangle:
    ! index1=1,nproma, index2=1,nblks_c, index3=1,3
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: edge_idx(:,:,:) => null()
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: edge_blk(:,:,:) => null()
    ! longitude & latitude of centers of triangular cells
    ! index1=nproma, index2=1,nblks_c
    REAL(wp), ALLOCATABLE     :: clon(:,:)
    REAL(wp), ALLOCATABLE     :: clat(:,:)
    ! area of triangle
    ! index1=nproma, index2=1,nblks_c
    REAL(wp), POINTER, CONTIGUOUS         :: area(:,:) => null()
    ! geometrical height of half levels at cell centre
    ! index1=1,nproma, index2=1,nlev+1, index3=1,nblks_c
    REAL(wp), ALLOCATABLE                 :: hhl(:,:,:)
 
    ! global cell indices
    INTEGER(C_INT), POINTER, CONTIGUOUS  :: glb_index(:) => null()
    ! Domain decomposition flag:
    ! decomp_domain==0: inner domain, decomp_domain>0: boundary, decomp_domain<0: undefined
    ! For cells:
    ! 0=owned, 1=shared edge with owned, 2=shared vertex with owned
    ! index1=nproma, index2=1,nblks_c
    INTEGER(C_INT), POINTER, CONTIGUOUS  :: decomp_domain(:,:) => null()
  END TYPE t_comin_descrdata_domain_cells
 
  TYPE :: t_comin_descrdata_domain_verts
    ! number of local verts
    INTEGER(C_INT), POINTER :: nverts => null()
    ! number of global verts
    INTEGER(C_INT), POINTER :: nverts_global => null()
    ! number of blocks for verts
    INTEGER(C_INT), POINTER :: nblks => null()
    ! number of edges connected to vertex
    ! index1=1,nproma, index2=1,nblks_v
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: num_edges(:,:) => null()
 
    ! lateral boundary distance indices
    ! index1=1,nproma, index2=1,nblks_v
    INTEGER(C_INT), POINTER             :: refin_ctrl(:,:) => null()
    ! list of start indices for each refin_ctrl level
    ! index1=min_rlvert,max_rlvert (defined in mo_impl_constants), index2=n_childdom
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: start_index(:) => null()
    ! list of end indices for each refin_ctrl level
    ! index1=min_rlvert,max_rlvert, index2=n_childdom
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: end_index(:) => null()
    ! list of start block for each refin_ctrl level
    ! index1=min_rlvert,max_rlvert, index2=n_childdom
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: start_block(:) => null()
    ! list of end block for each refin_ctrl level
    ! index1=min_rlvert,max_rlvert, index2=n_childdom
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: end_block(:) => null()
    ! block indices of neighbor vertices:
    ! index1=1,nproma, index2=1,nblks_v, index3=1,6
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: neighbor_blk(:,:,:) => null()
    ! line indices of neighbor vertices:
    ! index1=1,nproma, index2=1,nblks_v, index3=1,6
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: neighbor_idx(:,:,:) => null()
    ! line indices of cells around each vertex:
    ! index1=1,nproma, index2=1,nblks_v, index3=1,6
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: cell_idx(:,:,:) => null()
    ! block indices of cells around each vertex:
    ! index1=1,nproma, index2=1,nblks_v, index3=1,6
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: cell_blk(:,:,:) => null()
    ! line indices of edges around a vertex:
    ! index1=1,nproma, index2=1,nblks_v, index3=1,6
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: edge_idx(:,:,:) => null()
    ! block indices of edges around a vertex:
    ! index1=1,nproma, index2=1,nblks_v, index3=1,6
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: edge_blk(:,:,:) => null()
    ! longitude & latitude of vertex:
    ! index1=1,nproma, index2=1,nblks_v
    REAL(wp), ALLOCATABLE     :: vlon(:,:)
    REAL(wp), ALLOCATABLE     :: vlat(:,:)
  END TYPE t_comin_descrdata_domain_verts
 
  TYPE :: t_comin_descrdata_domain_edges
    ! number of local edges
    INTEGER(C_INT), POINTER :: nedges => null()
    ! number of global edges
    INTEGER(C_INT), POINTER :: nedges_global => null()
    ! number of blocks for edges
    INTEGER(C_INT), POINTER :: nblks => null()
 
    ! lateral boundary distance indices
    ! index1=1,nproma, index2=1,nblks_e
    INTEGER(C_INT), POINTER             :: refin_ctrl(:,:) => null()
    ! list of start indices for each refin_ctrl level
    ! index1=min_rledge,max_rledge (defined in mo_impl_constants), index2=n_childdom
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: start_index(:) => null()
    ! list of end indices for each refin_ctrl level
    ! index1=min_rledge,max_rledge, index2=n_childdom
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: end_index(:) => null()
    ! list of start block for each refin_ctrl level
    ! index1=min_rledge,max_rledge, index2=n_childdom
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: start_block(:) => null()
    ! list of end block for each refin_ctrl level
    ! index1=min_rledge,max_rledge, index2=n_childdom
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: end_block(:) => null()
    ! domain ID of child edges:
    ! index1=1,nproma, index2=1,nblks_e
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: child_id(:,:) => null()
    ! line index of parent edges:
    ! index1=1,nproma, index2=1,nblks_e
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: parent_glb_idx(:,:) => null()
    ! block index of parent edges:
    ! index1=1,nproma, index2=1,nblks_e
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: parent_glb_blk(:,:) => null()
    ! line indices of adjacent cells:
    ! index1=1,nproma, index2=1,nblks_e, index3=1,2
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: cell_idx(:,:,:) => null()
    ! block indices of adjacent cells:
    ! index1=1,nproma, index2=1,nblks_e, index3=1,2
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: cell_blk(:,:,:) => null()
    ! line indices of edge vertices:
    ! vertex indices 3 and 4 are the non-edge-aligned vertices of cells 1 and 2
    ! index1=1,nproma, index2=1,nblks_e, index3=1,4
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: vertex_idx(:,:,:) => null()
    ! block indices of edge vertices:
    ! index1=1,nproma, index2=1,nblks_e, index3=1,4
    INTEGER(C_INT), POINTER, CONTIGUOUS          :: vertex_blk(:,:,:) => null()
    ! longitude & latitude of edge midpoint
    ! index=1,nproma, index2=1,nblks_e
    REAL(wp), ALLOCATABLE     :: elon(:,:)
    REAL(wp), ALLOCATABLE     :: elat(:,:)
  END TYPE t_comin_descrdata_domain_edges
 
  TYPE :: t_comin_descrdata_domain
    ! horizontal grid filename
    CHARACTER(LEN=:), POINTER    :: grid_filename => null()
    ! alphanumerical hash of grid
    INTEGER(c_signed_char), POINTER     :: grid_uuid(:) => null()
    ! number of grid used (GRIB2 key)
    ! index=1,max_dom
    INTEGER(C_INT)                      :: number_of_grid_used
    ! domain ID of current domain
    INTEGER(C_INT), POINTER             :: id => null()
    ! domain id of parent
    INTEGER(C_INT), POINTER             :: parent_id => null()
    ! ids for all child domains
    INTEGER(C_INT), POINTER             :: child_id(:) => null()
    ! actual number of child domains
    INTEGER(C_INT), POINTER             :: n_childdom => null()
    ! time at which execution of a (nested) model domain starts
    REAL(wp)                     :: dom_start
    ! time at which execution of a (nested) model domain terminates
    REAL(wp)                     :: dom_end
    ! no. of vertical model levels
    INTEGER(C_INT), POINTER             :: nlev => null()
    ! half level of parent domain that coincides with upper margin of current
    ! domain
    INTEGER(C_INT), POINTER             :: nshift => null()
    ! total shift of model top w.r.t. global domain
    INTEGER(C_INT), POINTER             :: nshift_total => null()
 
    TYPE(t_comin_descrdata_domain_cells)    :: cells
    TYPE(t_comin_descrdata_domain_verts)    :: verts
    TYPE(t_comin_descrdata_domain_edges)    :: edges
  END TYPE t_comin_descrdata_domain
 
  TYPE :: t_comin_descrdata_simulation_interval
    CHARACTER(LEN=COMIN_MAX_DATETIME_STR_LEN) :: exp_start
    CHARACTER(LEN=COMIN_MAX_DATETIME_STR_LEN) :: exp_stop
    CHARACTER(LEN=COMIN_MAX_DATETIME_STR_LEN) :: run_start
    CHARACTER(LEN=COMIN_MAX_DATETIME_STR_LEN) :: run_stop
  END TYPE t_comin_descrdata_simulation_interval
 
  INTERFACE
    FUNCTION comin_glb2loc_index_lookup_fct(jg, glb) RESULT(loc)
      INTEGER,          INTENT(IN) :: jg
      INTEGER,          INTENT(IN) :: glb
      INTEGER :: loc
    END FUNCTION comin_glb2loc_index_lookup_fct
  END INTERFACE
 
END MODULE comin_descrdata_types