psmile_smioc_interface.F90

Go to the documentation of this file.

!------------------------------------------------------------------------
! Copyright 2006-2010, CERFACS, Toulouse, France.
! All rights reserved. Use is subject to license terms.
!------------------------------------------------------------------------
!
  MODULE psmile_smioc_interface

! !PUBLIC TYPES
  USE PRISM_Constants
  USE PSMILe_Common
  IMPLICIT NONE

! ----------------------------------------------------------------------------
! Interfaces of smioc extraction routines
! ----------------------------------------------------------------------------
!
! The following routines corresponds to the ones used to extract information
! from the smioc xml files.
!

  INTERFACE

!----------------------------------------------------------------------------
  SUBROUTINE get_smioc_numbers ( id_XML_doc,         &
                                 id_nb_unitsets,     &
                                 id_nb_grids,        &
                                 id_nb_transi,       &
                                 id_nb_persis,       &
                                 id_comp,            &
                                 cda_app_name,       &
                                 cda_comp_name,      &
                                 ld_first_details,   &
                                 id_error )
! !DESCRIPTION
! This routine gives the numbers of Fortran unit sets, grids,
! transi and persis for one smioc
!
!----------------------------------------------------------------------
!
! 0. Declaration
!
    USE PSMILe_smioc
!
! handle of XML content of the smioc file
    INTEGER, INTENT(In) :: id_XML_doc

! number of Fortran unit sets for the component
    INTEGER, INTENT(Out) :: id_nb_unitsets

! number of grids for the component
    INTEGER, INTENT(Out) :: id_nb_grids

! number of transi variables for the component
    INTEGER, INTENT(Out) :: id_nb_transi

! number of persis variables for the component!
    INTEGER, INTENT(Out) :: id_nb_persis

! id number of component
    INTEGER, INTENT(In)  :: id_comp

! Names of application and component
    CHARACTER(len=*), INTENT(In)  :: cda_app_name
    CHARACTER(len=*), INTENT(In)  :: cda_comp_name

! logical flag first pass / second pass
    LOGICAL, INTENT(In)  :: ld_first_details

! returned error code
    INTEGER, INTENT(Out) :: id_error

  END SUBROUTINE get_smioc_numbers
!--------------------------------------------------------------------------------
  SUBROUTINE get_unitsets_details ( id_XML_doc,         &
                                    id_nb_unitsets,     &
                                    ida_smioc_unitsets, &
                                    id_error)

! !DESCRIPTION
! This routines extracts the Fortran units sets for one smioc
!
!----------------------------------------------------------------------
!
! 0. Declaration
!
    USE PSMILe_smioc
!
! handle of XML content of the smioc file
    INTEGER, INTENT(In) :: id_XML_doc

! number of Fortran units sets for the component
    INTEGER, INTENT(In) :: id_nb_unitsets

! Fortran units sets for the component
    INTEGER, DIMENSION(id_nb_unitsets,3), INTENT(Out) :: ida_smioc_unitsets

! returned error code
    INTEGER, INTENT(Out) :: id_error

  END SUBROUTINE get_unitsets_details
!------------------------------------------------------------------------------
  SUBROUTINE get_transi_io_numbers ( id_XML_doc,         &
                                     id_nb_transi,       &
                                     ida_nb_stand_name,  &
                                     ida_nb_transi_in,   &
                                     ida_nb_transi_out,  &
                                     id_comp,            &
                                     cda_app_name,       &
                                     cda_comp_name,      &
                                     ld_first_details,   &
                                     id_error  )
!
! !DESCRIPTION
! This routine gives the number of input and output for each transi
! of one smioc
!
!----------------------------------------------------------------------
!
! 0. Declaration
!
    USE PSMILe_smioc

! handle of XML content of the smioc file
    INTEGER, INTENT(In) :: id_XML_doc

! number of transi variables for the component
    INTEGER, INTENT(In) :: id_nb_transi

! number of standard name per transi for the component
    INTEGER, DIMENSION(id_nb_transi), INTENT(Out) :: ida_nb_stand_name

! number of input transi per transi for the component
    INTEGER, DIMENSION(id_nb_transi), INTENT(Out) :: ida_nb_transi_in

! number of output transi per transi for the component
    INTEGER, DIMENSION(id_nb_transi), INTENT(Out) :: ida_nb_transi_out

! Component id
    INTEGER, INTENT(In) :: id_comp

! Names of application and component
    CHARACTER(len=*), INTENT(In)  :: cda_app_name
    CHARACTER(len=*), INTENT(In)  :: cda_comp_name

! logical flag first pass / second pass
    LOGICAL, INTENT(In)  :: ld_first_details

! returned error code
   INTEGER, INTENT(Out) :: id_error

   END SUBROUTINE get_transi_io_numbers
!----------------------------------------------------------------------------

  SUBROUTINE init_grids (id_nb_grids, sda_smioc_grids, id_error)
!
    USE PSMILe_smioc

! !INPUT PARAMETERS:
    INTEGER,INTENT(In):: id_nb_grids ! number of grids
!
! !RETURN VALUE:
!   grids structure
    TYPE (smioc_grid),DIMENSION(id_nb_grids),INTENT(Out):: sda_smioc_grids
!
! returned error code
    INTEGER,INTENT(Out):: id_error

  END SUBROUTINE init_grids
!-------------------------------------------------------------------------------

  SUBROUTINE init_transi (id_nb_transi,                 &
                          ida_nb_stand_name,            &
                          ida_nb_transi_in,             &
                          ida_nb_transi_out,            &
                          sda_smioc_transi,             &
                          id_error )
    USE PSMILe_smioc

!   number of transient variables
    INTEGER,INTENT(In):: id_nb_transi

!   number of standard names for each transient
    INTEGER,DIMENSION(id_nb_transi),INTENT(In):: ida_nb_stand_name

!   number of input origins for each transient
    INTEGER,DIMENSION(id_nb_transi),INTENT(In):: ida_nb_transi_in

!   number of output for each transient
    INTEGER,DIMENSION(id_nb_transi),INTENT(In):: ida_nb_transi_out
!
! !RETURN VALUE:
!   transients structure
    TYPE(transient),DIMENSION(id_nb_transi),INTENT(InOut):: 
       sda_smioc_transi
!
! returned error code
   INTEGER,INTENT(Out):: id_error
!
  END SUBROUTINE init_transi
!----------------------------------------------------------------------------
!
  SUBROUTINE get_transi_details ( id_XML_doc,         &
                                  id_nb_transi,       &
                                  sda_smioc_transi,   &
                                  id_comp,            &
                                  cda_app_name,       &
                                  cda_comp_name,      &
                                  ld_first_details,   &
                                  id_error )

    USE PSMILe_smioc

! handle of XML content of the smioc file
    INTEGER, INTENT(In) :: id_XML_doc

! number of transi variables
    INTEGER, INTENT(In) :: id_nb_transi

! transi structure
    TYPE(transient), DIMENSION(id_nb_transi), INTENT(InOut) :: sda_smioc_transi

! Component id
    INTEGER, INTENT(In) :: id_comp

! Names of application and component
    CHARACTER(len=*), INTENT(In)  :: cda_app_name
    CHARACTER(len=*), INTENT(In)  :: cda_comp_name

! logical flag first pass / second pass
    LOGICAL, INTENT(In)  :: ld_first_details

! returned error code
    INTEGER, INTENT(Out):: id_error

  END SUBROUTINE get_transi_details
!---------------------------------------------------------------------------
!
  SUBROUTINE get_cnct_source_details ( id_XML_doc,  &
     cda_xpath,         &
     ld_coupling,       &
     sd_source,         &
     id_error )
    
    USE PSMILe_smioc

! handle of XML content of the CIM file
    INTEGER, INTENT(In) :: id_XML_doc

! XPath character string
    CHARACTER(len=*), INTENT(In)  :: cda_xpath

! Flag for coupling (true) or connection (false)
    LOGICAL, INTENT(In) :: ld_coupling

! Data structure to fill in
    TYPE(transient_out), INTENT(InOut) :: sd_source

! returned error code
    INTEGER, INTENT(Out):: id_error

  END SUBROUTINE get_cnct_source_details
!---------------------------------------------------------------------------
!
  SUBROUTINE get_cnct_target_details ( id_XML_doc,  &
     cda_xpath,         &
     ld_coupling,       &
     ld_source_is_file, &
     sd_target,         &
     id_error )

    USE PSMILe_smioc

! handle of XML content of the CIM file
    INTEGER, INTENT(In) :: id_XML_doc

! XPath character string
    CHARACTER(len=*), INTENT(In)  :: cda_xpath

! Flag for coupling (true) or connection (false)
    LOGICAL, INTENT(In) :: ld_coupling

! Flag for when the source of coupling is a file
    LOGICAL, INTENT(In) :: ld_source_is_file
! Data structure to fill in
    TYPE(transient_in), INTENT(InOut) :: sd_target

! returned error code
    INTEGER, INTENT(Out):: id_error

  END SUBROUTINE get_cnct_target_details
!---------------------------------------------------------------------------
!
  SUBROUTINE get_file_details ( id_XML_doc,  &
     cda_xpath,         &
     cda_var_name,      &
     sd_file,           &
     id_error )
    
    USE PSMILe_smioc

! handle of XML content of the CIM file
    INTEGER, INTENT(In) :: id_XML_doc

! XPath character string = where to search in the XML document
    CHARACTER(len=*), INTENT(In)  :: cda_xpath

! NetCDF variable name we are looking for
    CHARACTER(len=*), INTENT(In)  :: cda_var_name

! Data structure to fill in
    TYPE (PSMILe_file_struct), INTENT(InOut) :: sd_file

! returned error code
    INTEGER, INTENT(Out):: id_error

  ENDSUBROUTINE get_file_details
!---------------------------------------------------------------------------
!
  SUBROUTINE get_regrid_details ( id_XML_doc,  &
     cda_xpath,       &
     id_nb_regrid,    &
     sd_interp,       &
     id_error )     

    USE PSMILe_smioc

! handle of XML content of the CIM file
    INTEGER, INTENT(In) :: id_XML_doc

! XPath character string
    CHARACTER(len=*), INTENT(In)  :: cda_xpath

! Number of <spatialRegridding> elements
    INTEGER, INTENT(In) :: id_nb_regrid

! Interpolation structure
    TYPE(PSMILe_interp), INTENT(InOut) :: sd_interp

! returned error code
    INTEGER, INTENT(Out):: id_error 

  ENDSUBROUTINE get_regrid_details
!---------------------------------------------------------------------------
!
  SUBROUTINE get_persis_details ( id_XML_doc,        &
                                  id_nb_persis,      &
                                  sda_smioc_persis,  &
                                  id_error )
    USE PSMILe_smioc

! handle of XML content of the smioc file
    INTEGER, INTENT(In) :: id_XML_doc

! number of persis variables
    INTEGER,INTENT(In):: id_nb_persis

! persis structure
    TYPE(persistent),DIMENSION(id_nb_persis),INTENT (Out):: 
       sda_smioc_persis

! returned error code
    INTEGER,INTENT(Out):: id_error

  END SUBROUTINE get_persis_details 
!-----------------------------------------------------------------------------
!
  SUBROUTINE init_comp_udef ( id_nb_transi,                 &
                              ida_nb_transi_in,             &
                              ida_nb_transi_out,            &
                              id_comp,                      &
                              id_error )
    USE PSMILe_smioc

!   number of transient variables in XML SMIOC for one component
    INTEGER,INTENT(In):: id_nb_transi

!   number of input origins for each transient
    INTEGER,DIMENSION(id_nb_transi),INTENT(In):: ida_nb_transi_in

!   number of output for each transient
    INTEGER,DIMENSION(id_nb_transi),INTENT(In):: ida_nb_transi_out

!   index of component
    INTEGER, INTENT(In) :: id_comp
!
! !RETURN VALUE:
!   Global structure sga_comp_udef_idx variables are all = .false.
!
! returned error code
   INTEGER,INTENT(Out):: id_error

  END SUBROUTINE init_comp_udef
!------------------------------------------------------------------------------
!
  SUBROUTINE create_transi_udef ( id_nb_transi,     &
                                  id_xml,           &
                                  id_u,             &
                                  id_ch,            &
                                  id_side,          &
                                  sda_smioc_transi, &
                                  id_comp,          &
                                  id_error )
!
    USE PSMILe_smioc
!   Dimensions of array sda_smioc_transi (2nd pass)
    Integer, Intent(In)          :: id_nb_transi

!   Index of transient (geographic) to be copied (defined in the SMIOC XML)
    Integer, Intent(In)          :: id_xml

!   Index of associated transient "udef" to be created for this component
    Integer, Intent(In)          :: id_u

!   Index of channel (In OR Out) of the SMIOC XML (geographic) transient
    Integer, Intent(In)          :: id_ch

!   Side of channel (In) only .XOR. (Out) only of the id_ch channel
    Integer, Intent(In)          :: id_side

!   transients structure (array allocated with dimension id_nb_transi in second pass)
    TYPE(transient), Dimension(id_nb_transi), TARGET,  Intent(InOut)  ::  sda_smioc_transi
!
!   Index of component
    Integer, Intent(In)          :: id_comp

!   returned error code
    Integer, Intent(Out)         :: id_error
!
  END SUBROUTINE create_transi_udef
!-----------------------------------------------------------------------------
!
  SUBROUTINE init_persis (id_nb_persis,      &
                          sda_smioc_persis, &
                          id_error )
    USE PSMILe_smioc

!   number of persistent variables
    INTEGER,INTENT(In):: id_nb_persis
!
! !RETURN VALUE:
!   persistents structure
    TYPE(persistent),DIMENSION(id_nb_persis),INTENT(Out):: 
       sda_smioc_persis
!
! returned error code
   INTEGER,INTENT(Out):: id_error

  END SUBROUTINE init_persis
!-----------------------------------------------------------------------------
!
  SUBROUTINE write_grids_details (id_nb_grids,     &
                                  sda_grids,       &
                                  id_chanel,       &
                                  id_error )
    USE PSMILe_smioc

!   number of grids
    INTEGER,INTENT(In):: id_nb_grids
!   grids structure
    TYPE (smioc_grid),DIMENSION(id_nb_grids),INTENT (In):: sda_grids
!   channel used for testing smioc infos
    INTEGER,INTENT(In):: id_chanel
!
!   returned error code
    INTEGER,INTENT(Out):: id_error

  END SUBROUTINE write_grids_details
!------------------------------------------------------------------------------

  SUBROUTINE write_transi_details (id_nb_transi,    &
                                   sda_transi,      &
                                   id_chanel,       &
                                   id_error )
    USE PSMILe_smioc

!   number of transient variables
    INTEGER,INTENT(In):: id_nb_transi
!   transients structure
    TYPE(transient),DIMENSION(id_nb_transi),INTENT(In):: sda_transi
!   channel used for testing smioc infos
    INTEGER,INTENT(In):: id_chanel
!
! returned error code
   INTEGER,INTENT(Out):: id_error

  END SUBROUTINE write_transi_details
!---------------------------------------------------------------------------------
!
  SUBROUTINE write_persis_details (id_nb_persis,    &
                                   sda_persis,      &
                                   id_chanel,       &
                                   id_error)
    USE PSMILe_smioc

!   number of persistent variables
    INTEGER,INTENT(In):: id_nb_persis

!   persistents structure
    TYPE(persistent),DIMENSION(id_nb_persis),INTENT(In):: sda_persis

!   channel used for testing smioc infos
    INTEGER,INTENT(In):: id_chanel
!
!  returned error code
    INTEGER,INTENT(Out):: id_error

  END SUBROUTINE write_persis_details
!----------------------------------------------------------------------------
!
  SUBROUTINE get_grids_details ( id_XML_doc,         &
                                 id_nb_grids,        &
                                 cda_app_name,       &
                                 cda_comp_name,      &
                                 sda_smioc_grids,    &
                                 id_error )
    USE PSMILe_smioc

! handle of XML content of the smioc file
    INTEGER, INTENT(In) :: id_XML_doc

! number of grids for the component
    INTEGER, INTENT(In) :: id_nb_grids

! Names of application and component
    CHARACTER(len=*), INTENT(In)  :: cda_app_name
    CHARACTER(len=*), INTENT(In)  :: cda_comp_name

! grids structure for the component
    TYPE (smioc_grid), DIMENSION(id_nb_grids), INTENT(Out) :: sda_smioc_grids
!
! returned error code
   INTEGER, INTENT(Out) :: id_error

  END SUBROUTINE get_grids_details
!-------------------------------------------------------------------------------
!
  SUBROUTINE put_udef_suffix ( cd_in, cd_out, id_chan, id_side )

  USE PSMILe_smioc

! !Input  argument
   Character(len=*),        Intent(In)  :: cd_in

! !Output argument
   Character(len=max_name), Intent(Out) :: cd_out
!
! !Input argument
   Integer,                  Intent(In) :: id_chan
!
! !Input argument : 0 = source = "O",       1 = target = "I"
   Integer,                  Intent(In) :: id_side

  END SUBROUTINE put_udef_suffix
!-------------------------------------------------------------------------------
!
  END INTERFACE
!
  END MODULE psmile_smioc_interface