unpack_same_rank.F90

Go to the documentation of this file.

!SFX_LIC Copyright 1994-2014 CNRS, Meteo-France and Universite Paul Sabatier
!SFX_LIC This is part of the SURFEX software governed by the CeCILL-C licence
!SFX_LIC version 1. See LICENSE, CeCILL-C_V1-en.txt and CeCILL-C_V1-fr.txt  
!SFX_LIC for details. version 1.
!     ##########################
      MODULE modi_unpack_same_rank
!     ##########################
INTERFACE unpack_same_rank
      SUBROUTINE unpack_same_rank_from1di(KM,K1D_IN,K1D_OUT,KMISS)

INTEGER, DIMENSION(:),   INTENT(IN) :: KM
INTEGER, DIMENSION(:),   INTENT(IN) :: K1D_IN
INTEGER, DIMENSION(:),   INTENT(OUT):: K1D_OUT
INTEGER, OPTIONAL,       INTENT(IN) :: KMISS
END SUBROUTINE unpack_same_rank_from1di
!
      SUBROUTINE unpack_same_rank_from2di(KM,K1D_IN,K1D_OUT,KMISS)

INTEGER, DIMENSION(:),   INTENT(IN) :: KM
INTEGER, DIMENSION(:,:), INTENT(IN) :: K1D_IN
INTEGER, DIMENSION(:,:), INTENT(OUT):: K1D_OUT
INTEGER, OPTIONAL,       INTENT(IN) :: KMISS
END SUBROUTINE unpack_same_rank_from2di
!
      SUBROUTINE unpack_same_rank_from1dl(KM,O1D_IN,O1D_OUT,OMISS)

INTEGER, DIMENSION(:),   INTENT(IN) :: KM
LOGICAL, DIMENSION(:),   INTENT(IN) :: O1D_IN
LOGICAL, DIMENSION(:),   INTENT(OUT):: O1D_OUT
LOGICAL, OPTIONAL,       INTENT(IN) :: OMISS
END SUBROUTINE unpack_same_rank_from1dl
!
      SUBROUTINE unpack_same_rank_from1d(KM,P1D_IN,P1D_OUT,PMISS)

INTEGER, DIMENSION(:),   INTENT(IN) :: KM
REAL, DIMENSION(:),   INTENT(IN) :: P1D_IN
REAL, DIMENSION(:),   INTENT(OUT):: P1D_OUT
REAL, OPTIONAL,       INTENT(IN) :: PMISS
END SUBROUTINE unpack_same_rank_from1d
!
      SUBROUTINE unpack_same_rank_from2d(KM,P2D_IN,P2D_OUT,PMISS)

INTEGER, DIMENSION(:),   INTENT(IN) :: KM
REAL, DIMENSION(:,:), INTENT(IN) :: P2D_IN
REAL, DIMENSION(:,:), INTENT(OUT):: P2D_OUT
REAL, OPTIONAL,       INTENT(IN) :: PMISS
!
END SUBROUTINE unpack_same_rank_from2d
!
      SUBROUTINE unpack_same_rank_from3d(KM,P3D_IN,P3D_OUT,PMISS)

INTEGER, DIMENSION(:),   INTENT(IN) :: KM
REAL, DIMENSION(:,:,:), INTENT(IN) :: P3D_IN
REAL, DIMENSION(:,:,:), INTENT(OUT):: P3D_OUT
REAL, OPTIONAL,       INTENT(IN) :: PMISS
!
END SUBROUTINE unpack_same_rank_from3d
!
      SUBROUTINE unpack_same_rank_from3di(KM,K3D_IN,K3D_OUT,KMISS)

INTEGER, DIMENSION(:),   INTENT(IN) :: KM
INTEGER, DIMENSION(:,:,:), INTENT(IN) :: K3D_IN
INTEGER, DIMENSION(:,:,:), INTENT(OUT):: K3D_OUT
INTEGER, OPTIONAL,       INTENT(IN) :: KMISS
!
END SUBROUTINE unpack_same_rank_from3di
!
      SUBROUTINE unpack_same_rank_from4d(KM,P4D_IN,P4D_OUT,PMISS)

INTEGER, DIMENSION(:),   INTENT(IN) :: KM
REAL, DIMENSION(:,:,:,:), INTENT(IN) :: P4D_IN
REAL, DIMENSION(:,:,:,:),   INTENT(OUT):: P4D_OUT
REAL, OPTIONAL,       INTENT(IN) :: PMISS
!
END SUBROUTINE unpack_same_rank_from4d
!
END INTERFACE 
!
END MODULE modi_unpack_same_rank
!
!     ##############################################
      SUBROUTINE unpack_same_rank_from1d(KM,P1D_IN,P1D_OUT,PMISS)
!     ##############################################
!
!!****  *UNPACK_SAME_RANK* - extract the defined data from a 1D field into a 1D field of lower rank
!!
!!    PURPOSE
!!    -------
!!
!!**  METHOD
!!    ------
!!
!!    EXTERNAL
!!    --------
!!
!!
!!    IMPLICIT ARGUMENTS
!!    ------------------
!!
!!    REFERENCE
!!    ---------
!!
!!
!!    AUTHOR
!!    ------
!!      F. Habets   *Meteo France*
!!
!!    MODIFICATIONS
!!    -------------
!!      Original    08/03
!!      B. Decharme 2008  Allows to put other optional value for missval
!-------------------------------------------------------------------------------
!
!*       0.    DECLARATIONS
!              ------------
!
USE modd_surf_par,   ONLY : xundef
!
!
USE yomhook   ,ONLY : lhook,   dr_hook
USE parkind1  ,ONLY : jprb
!
IMPLICIT NONE
!
!*       0.1   Declarations of arguments
!              -------------------------
!
INTEGER, DIMENSION(:),   INTENT(IN) :: KM
REAL, DIMENSION(:),   INTENT(IN) :: P1D_IN
REAL, DIMENSION(:),   INTENT(OUT):: P1D_OUT
REAL, OPTIONAL,       INTENT(IN) :: PMISS
!
!*       0.2   Declarations of local variables
!              -------------------------------
!
INTEGER :: JI ! loop counter
REAL(KIND=JPRB) :: ZHOOK_HANDLE
!
!-------------------------------------------------------------------------------
!
IF (lhook) CALL dr_hook('MODI_UNPACK_SAME_RANK:UNPACK_SAME_RANK_FROM1D',0,zhook_handle)
IF(PRESENT(pmiss))THEN
  p1d_out(:) = pmiss      
ELSE
  p1d_out(:) = xundef
ENDIF
!
!cdir nodep
DO ji=1,SIZE(p1d_in,1)
  p1d_out(km(ji)) = p1d_in(ji) 
ENDDO
IF (lhook) CALL dr_hook('MODI_UNPACK_SAME_RANK:UNPACK_SAME_RANK_FROM1D',1,zhook_handle)
!
!-------------------------------------------------------------------------------
!
END SUBROUTINE unpack_same_rank_from1d
!
!
!     ##############################################
      SUBROUTINE unpack_same_rank_from1di(KM,K1D_IN,K1D_OUT,KMISS)
!     ##############################################
!
!!****  *UNPACK_SAME_RANK* - extract the defined data from a 1D field into a 1D field of lower rank
!!
!!    PURPOSE
!!    -------
!!
!!**  METHOD
!!    ------
!!
!!    EXTERNAL
!!    --------
!!
!!
!!    IMPLICIT ARGUMENTS
!!    ------------------
!!
!!    REFERENCE
!!    ---------
!!
!!
!!    AUTHOR
!!    ------
!!      F. Habets   *Meteo France*
!!
!!    MODIFICATIONS
!!    -------------
!!      Original    08/03
!-------------------------------------------------------------------------------
!
!*       0.    DECLARATIONS
!              ------------
!
USE modd_surf_par,   ONLY : nundef
!
!
USE yomhook   ,ONLY : lhook,   dr_hook
USE parkind1  ,ONLY : jprb
!
IMPLICIT NONE
!
!*       0.1   Declarations of arguments
!              -------------------------
!
INTEGER, DIMENSION(:),   INTENT(IN) :: KM
INTEGER, DIMENSION(:),   INTENT(IN) :: K1D_IN
INTEGER, DIMENSION(:),   INTENT(OUT):: K1D_OUT
INTEGER, OPTIONAL,       INTENT(IN) :: KMISS
!
!*       0.2   Declarations of local variables
!              -------------------------------
!
INTEGER :: JI ! loop counter
REAL(KIND=JPRB) :: ZHOOK_HANDLE
!
!-------------------------------------------------------------------------------
!
IF (lhook) CALL dr_hook('MODI_UNPACK_SAME_RANK:UNPACK_SAME_RANK_FROM1DI',0,zhook_handle)
IF(PRESENT(kmiss))THEN
  k1d_out(:) = kmiss      
ELSE
  k1d_out(:) = nundef
ENDIF
!
!cdir nodep
DO ji=1,SIZE(k1d_in,1)
  k1d_out(km(ji)) = k1d_in(ji) 
ENDDO
IF (lhook) CALL dr_hook('MODI_UNPACK_SAME_RANK:UNPACK_SAME_RANK_FROM1DI',1,zhook_handle)
!
!-------------------------------------------------------------------------------
!
END SUBROUTINE unpack_same_rank_from1di
!
!     ##############################################
      SUBROUTINE unpack_same_rank_from2di(KM,K2D_IN,K2D_OUT,PMISS)
!     ##############################################
!
!!****  *UNPACK_SAME_RANK* - extract the defined data from a 2D field into a 2D field
!!
!!    PURPOSE
!!    -------
!!
!!**  METHOD
!!    ------
!!
!!    EXTERNAL
!!    --------
!!
!!
!!    IMPLICIT ARGUMENTS
!!    ------------------
!!
!!    REFERENCE
!!    ---------
!!
!!
!!    AUTHOR
!!    ------
!!      F. Habets   *Meteo France*
!!
!!    MODIFICATIONS
!!    -------------
!!      Original    08/03
!-------------------------------------------------------------------------------
!
!*       0.    DECLARATIONS
!              ------------
!
USE modd_surf_par,   ONLY : nundef
!
USE yomhook   ,ONLY : lhook,   dr_hook
USE parkind1  ,ONLY : jprb
!
IMPLICIT NONE
!
!*       0.1   Declarations of arguments
!              -------------------------
!
INTEGER, DIMENSION(:),  INTENT(IN) :: KM
INTEGER, DIMENSION(:,:),   INTENT(IN) :: K2D_IN
INTEGER, DIMENSION(:,:),   INTENT(OUT):: K2D_OUT
REAL, OPTIONAL,         INTENT(IN) :: PMISS
!
!*       0.2   Declarations of local variables
!              -------------------------------
!
INTEGER :: JI, JJ ! loop counter
REAL(KIND=JPRB) :: ZHOOK_HANDLE
!
!-------------------------------------------------------------------------------
!
IF (lhook) CALL dr_hook('MODI_UNPACK_SAME_RANK:UNPACK_SAME_RANK_FROM2DI',0,zhook_handle)
!
IF(PRESENT(pmiss))THEN
  k2d_out(:,:) = pmiss      
ELSE
  k2d_out(:,:) = nundef
ENDIF
!
DO jj=1,SIZE(k2d_in,2)
!cdir nodep
  DO ji=1,SIZE(k2d_in,1)
    k2d_out(km(ji),jj) = k2d_in(ji,jj)
  ENDDO 
ENDDO
IF (lhook) CALL dr_hook('MODI_UNPACK_SAME_RANK:UNPACK_SAME_RANK_FROM2DI',1,zhook_handle)
!
!-------------------------------------------------------------------------------
!
END SUBROUTINE unpack_same_rank_from2di
!
!     ##############################################
      SUBROUTINE unpack_same_rank_from1dl(KM,O1D_IN,O1D_OUT,OMISS)
!     ##############################################
!
!!****  *UNPACK_SAME_RANK* - extract the defined data from a 1D field into a 1D field of lower rank
!!
!!    PURPOSE
!!    -------
!!
!!**  METHOD
!!    ------
!!
!!    EXTERNAL
!!    --------
!!
!!
!!    IMPLICIT ARGUMENTS
!!    ------------------
!!
!!    REFERENCE
!!    ---------
!!
!!
!!    AUTHOR
!!    ------
!!      F. Habets   *Meteo France*
!!
!!    MODIFICATIONS
!!    -------------
!!      Original    08/03
!-------------------------------------------------------------------------------
!
!*       0.    DECLARATIONS
!              ------------
!
!
!
USE yomhook   ,ONLY : lhook,   dr_hook
USE parkind1  ,ONLY : jprb
!
IMPLICIT NONE
!
!*       0.1   Declarations of arguments
!              -------------------------
!
INTEGER, DIMENSION(:),   INTENT(IN) :: KM
LOGICAL, DIMENSION(:),   INTENT(IN) :: O1D_IN
LOGICAL, DIMENSION(:),   INTENT(OUT):: O1D_OUT
LOGICAL, OPTIONAL,       INTENT(IN) :: OMISS
!
!*       0.2   Declarations of local variables
!              -------------------------------
!
INTEGER :: JI ! loop counter
REAL(KIND=JPRB) :: ZHOOK_HANDLE
!
!-------------------------------------------------------------------------------
!
IF (lhook) CALL dr_hook('MODI_UNPACK_SAME_RANK:UNPACK_SAME_RANK_FROM1DL',0,zhook_handle)
IF(PRESENT(omiss))THEN
  o1d_out(:) = omiss      
ELSE
  o1d_out(:) = .false.
ENDIF
!
!cdir nodep
DO ji=1,SIZE(o1d_in,1)
  o1d_out(km(ji)) = o1d_in(ji) 
ENDDO
IF (lhook) CALL dr_hook('MODI_UNPACK_SAME_RANK:UNPACK_SAME_RANK_FROM1DL',1,zhook_handle)
!
!-------------------------------------------------------------------------------
!
END SUBROUTINE unpack_same_rank_from1dl
!
!
!     ##############################################
      SUBROUTINE unpack_same_rank_from2d(KM,P2D_IN,P2D_OUT,PMISS)
!     ##############################################
!
!!****  *UNPACK_SAME_RANK* - extract the defined data from a 2D field into a 2D field
!!
!!    PURPOSE
!!    -------
!!
!!**  METHOD
!!    ------
!!
!!    EXTERNAL
!!    --------
!!
!!
!!    IMPLICIT ARGUMENTS
!!    ------------------
!!
!!    REFERENCE
!!    ---------
!!
!!
!!    AUTHOR
!!    ------
!!      F. Habets   *Meteo France*
!!
!!    MODIFICATIONS
!!    -------------
!!      Original    08/03
!-------------------------------------------------------------------------------
!
!*       0.    DECLARATIONS
!              ------------
!
USE modd_surf_par,   ONLY : xundef
!
!
USE yomhook   ,ONLY : lhook,   dr_hook
USE parkind1  ,ONLY : jprb
!
IMPLICIT NONE
!
!*       0.1   Declarations of arguments
!              -------------------------
!
INTEGER, DIMENSION(:),  INTENT(IN) :: KM
REAL, DIMENSION(:,:),   INTENT(IN) :: P2D_IN
REAL, DIMENSION(:,:),   INTENT(OUT):: P2D_OUT
REAL, OPTIONAL,         INTENT(IN) :: PMISS
!
!*       0.2   Declarations of local variables
!              -------------------------------
!
INTEGER :: JI, JJ ! loop counter
REAL(KIND=JPRB) :: ZHOOK_HANDLE
!
!-------------------------------------------------------------------------------
!
IF (lhook) CALL dr_hook('MODI_UNPACK_SAME_RANK:UNPACK_SAME_RANK_FROM2D',0,zhook_handle)
IF(PRESENT(pmiss))THEN
  p2d_out(:,:) = pmiss      
ELSE
  p2d_out(:,:) = xundef
ENDIF
!
DO jj=1,SIZE(p2d_in,2)
!cdir nodep
  DO ji=1,SIZE(p2d_in,1)
    p2d_out(km(ji),jj) = p2d_in(ji,jj)
  ENDDO 
ENDDO
IF (lhook) CALL dr_hook('MODI_UNPACK_SAME_RANK:UNPACK_SAME_RANK_FROM2D',1,zhook_handle)
!
!-------------------------------------------------------------------------------
!
END SUBROUTINE unpack_same_rank_from2d
!
!
!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
!     ##############################################
      SUBROUTINE unpack_same_rank_from3d(KM,P3D_IN,P3D_OUT,PMISS)
!     ##############################################
!
!!****  *UNPACK_SAME_RANK* - extract the defined data from a 3D field into a 3D field
!!
!!    PURPOSE
!!    -------
!!
!!**  METHOD
!!    ------
!!
!!    EXTERNAL
!!    --------
!!
!!
!!    IMPLICIT ARGUMENTS
!!    ------------------
!!
!!    REFERENCE
!!    ---------
!!
!!
!!    AUTHOR
!!    ------
!!      F. Habets   *Meteo France*
!!
!!    MODIFICATIONS
!!    -------------
!!      Original    08/03
!-------------------------------------------------------------------------------
!
!*       0.    DECLARATIONS
!              ------------
!
USE modd_surf_par,   ONLY : xundef
!
!
USE yomhook   ,ONLY : lhook,   dr_hook
USE parkind1  ,ONLY : jprb
!
IMPLICIT NONE
!
!*       0.1   Declarations of arguments
!              -------------------------
!
INTEGER, DIMENSION(:),   INTENT(IN) :: KM
REAL, DIMENSION(:,:,:),  INTENT(IN) :: P3D_IN
REAL, DIMENSION(:,:,:),  INTENT(OUT):: P3D_OUT
REAL, OPTIONAL,          INTENT(IN) :: PMISS
!
!*       0.2   Declarations of local variables
!              -------------------------------
!
INTEGER :: JI, JJ, JK ! loop counter
REAL(KIND=JPRB) :: ZHOOK_HANDLE
!
!-------------------------------------------------------------------------------
!
IF (lhook) CALL dr_hook('MODI_UNPACK_SAME_RANK:UNPACK_SAME_RANK_FROM3D',0,zhook_handle)
IF(PRESENT(pmiss))THEN
  p3d_out(:,:,:) = pmiss      
ELSE
  p3d_out(:,:,:) = xundef
ENDIF
!
DO jk=1,SIZE(p3d_in,3)
  DO jj=1,SIZE(p3d_in,2)
!cdir nodep
    DO ji=1,SIZE(p3d_in,1)
      p3d_out(km(ji),jj,jk) = p3d_in(ji,jj,jk)
    ENDDO
  ENDDO 
ENDDO
IF (lhook) CALL dr_hook('MODI_UNPACK_SAME_RANK:UNPACK_SAME_RANK_FROM3D',1,zhook_handle)
!
!-------------------------------------------------------------------------------
!
END SUBROUTINE unpack_same_rank_from3d
!
!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
!     ##############################################
      SUBROUTINE unpack_same_rank_from3di(KM,K3D_IN,K3D_OUT,KMISS)
!     ##############################################
!
!!****  *UNPACK_SAME_RANK* - extract the defined data from a 3D field into a 3D field
!!
!!    PURPOSE
!!    -------
!!
!!**  METHOD
!!    ------
!!
!!    EXTERNAL
!!    --------
!!
!!
!!    IMPLICIT ARGUMENTS
!!    ------------------
!!
!!    REFERENCE
!!    ---------
!!
!!
!!    AUTHOR
!!    ------
!!      F. Habets   *Meteo France*      
!!
!!    MODIFICATIONS
!!    -------------
!!      Original    08/03
!-------------------------------------------------------------------------------
!
!*       0.    DECLARATIONS
!              ------------
!
USE modd_surf_par,   ONLY : nundef
!
!
USE yomhook   ,ONLY : lhook,   dr_hook
USE parkind1  ,ONLY : jprb
!
IMPLICIT NONE
!
!*       0.1   Declarations of arguments
!              -------------------------
!
INTEGER, DIMENSION(:),   INTENT(IN) :: KM
REAL, DIMENSION(:,:,:),  INTENT(IN) :: K3D_IN
REAL, DIMENSION(:,:,:),  INTENT(OUT):: K3D_OUT
REAL, OPTIONAL,          INTENT(IN) :: KMISS
!
!*       0.2   Declarations of local variables
!              -------------------------------
!
INTEGER :: JI, JJ, JK ! loop counter
REAL(KIND=JPRB) :: ZHOOK_HANDLE
!
!-------------------------------------------------------------------------------
!
IF (lhook) CALL dr_hook('MODI_UNPACK_SAME_RANK:UNPACK_SAME_RANK_FROM3D',0,zhook_handle)
IF(PRESENT(kmiss))THEN
  k3d_out(:,:,:) = kmiss      
ELSE
  k3d_out(:,:,:) = nundef
ENDIF
!
DO jk=1,SIZE(k3d_in,3)
  DO jj=1,SIZE(k3d_in,2)
!cdir nodep
    DO ji=1,SIZE(k3d_in,1)
      k3d_out(km(ji),jj,jk) = k3d_in(ji,jj,jk)
    ENDDO
  ENDDO 
ENDDO
IF (lhook) CALL dr_hook('MODI_UNPACK_SAME_RANK:UNPACK_SAME_RANK_FROM3DI',1,zhook_handle)
!
!-------------------------------------------------------------------------------
!
END SUBROUTINE unpack_same_rank_from3di
!
!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
!     ##############################################
      SUBROUTINE unpack_same_rank_from4d(KM,P4D_IN,P4D_OUT,PMISS)
!     ##############################################
!
!!****  *UNPACK_SAME_RANK* - extract the defined data from a 4D field into a 4D field
!!
!!    PURPOSE
!!    -------
!!
!!**  METHOD
!!    ------
!!
!!    EXTERNAL
!!    --------
!!
!!
!!    IMPLICIT ARGUMENTS
!!    ------------------
!!
!!    REFERENCE
!!    ---------
!!
!!
!!    AUTHOR
!!    ------
!!      F. Habets   *Meteo France*
!!
!!    MODIFICATIONS
!!    -------------
!!      Original    08/03
!-------------------------------------------------------------------------------
!
!*       0.    DECLARATIONS
!              ------------
!
USE modd_surf_par,   ONLY : xundef
!
!
USE yomhook   ,ONLY : lhook,   dr_hook
USE parkind1  ,ONLY : jprb
!
IMPLICIT NONE
!
!*       0.1   Declarations of arguments
!              -------------------------
!
INTEGER, DIMENSION(:),    INTENT(IN) :: KM
REAL, DIMENSION(:,:,:,:), INTENT(IN) :: P4D_IN
REAL, DIMENSION(:,:,:,:), INTENT(OUT):: P4D_OUT
REAL, OPTIONAL,           INTENT(IN) :: PMISS
!
!*       0.2   Declarations of local variables
!              -------------------------------
!
!
INTEGER :: JI, JJ, JK, JL ! loop counter
REAL(KIND=JPRB) :: ZHOOK_HANDLE
!
!-------------------------------------------------------------------------------
!
IF (lhook) CALL dr_hook('MODI_UNPACK_SAME_RANK:UNPACK_SAME_RANK_FROM4D',0,zhook_handle)
IF(PRESENT(pmiss))THEN
  p4d_out(:,:,:,:) = pmiss      
ELSE
  p4d_out(:,:,:,:) = xundef
ENDIF
!
DO jl=1,SIZE(p4d_out,4)
  DO jk=1,SIZE(p4d_out,3)
    DO jj=1,SIZE(p4d_out,2)
!cdir nodep
      DO ji=1,SIZE(p4d_out,1)
        p4d_out(km(ji),jj,jk,jl) = p4d_in(ji,jj,jk,jl)
      ENDDO
    ENDDO
  ENDDO
ENDDO
IF (lhook) CALL dr_hook('MODI_UNPACK_SAME_RANK:UNPACK_SAME_RANK_FROM4D',1,zhook_handle)
!
!-------------------------------------------------------------------------------
!
END SUBROUTINE unpack_same_rank_from4d