!

! $Id: limit_read_mod.F90 3435 2019-01-22 15:21:59Z fairhead $

!

MODULE limit_read_mod

!

! This module reads the fichier "limit.nc" containing fields for surface forcing.

!

! Module subroutines :

!  limit_read_frac    : call limit_read_tot and return the fractions

!  limit_read_rug_alb : return rugosity and albedo, if coupled ocean call limit_read_tot first

!  limit_read_sst     : return sea ice temperature

!  limit_read_tot     : read limit.nc and store the fields in local modules variables

!

  IMPLICIT NONE

  REAL, ALLOCATABLE, DIMENSION(:,:), SAVE, PRIVATE :: pctsrf

!$OMP THREADPRIVATE(pctsrf)

  REAL, ALLOCATABLE, DIMENSION(:),   SAVE, PRIVATE :: rugos

!$OMP THREADPRIVATE(rugos)

  REAL, ALLOCATABLE, DIMENSION(:),   SAVE, PRIVATE :: albedo

!$OMP THREADPRIVATE(albedo)

  REAL, ALLOCATABLE, DIMENSION(:),   SAVE, PRIVATE :: sst

!$OMP THREADPRIVATE(sst)

  LOGICAL,SAVE :: read_continents=.FALSE.

!$OMP THREADPRIVATE(read_continents)

CONTAINS

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!

!! Public subroutines :

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

  USE mod_grid_phy_lmdz

  USE surface_data

  USE mod_phys_lmdz_para

#ifdef CPP_XIOS

  USE XIOS

#endif

  IMPLICIT NONE

    INTEGER, INTENT(IN) :: first_day

    IF ( type_ocean /= 'couple') THEN

      IF (grid_type==unstructured) THEN

#ifdef CPP_XIOS

        IF (is_omp_master) CALL xios_set_file_attr("limit_read",enabled=.TRUE.,record_offset=first_day)

#endif

      ENDIF

    ENDIF

!

! This subroutine is called from "change_srf_frac" for case of

! ocean=force or from ocean_slab_frac for ocean=slab.

! The fraction for all sub-surfaces at actual time step is returned.

    USE dimphy

    USE indice_sol_mod

! Input arguments

!****************************************************************************************

    INTEGER, INTENT(IN) :: itime   ! time step

    INTEGER, INTENT(IN) :: jour    ! current day

    REAL   , INTENT(IN) :: dtime   ! length of time step

! Output arguments

!****************************************************************************************

    REAL, DIMENSION(klon,nbsrf), INTENT(OUT) :: pctsrf_new  ! sub surface fractions

    LOGICAL, INTENT(OUT)                     :: is_modified ! true if pctsrf is modified at this time step

! End declaration

!****************************************************************************************

! 1) Read file limit.nc

! 2) Return the fraction read in limit_read_tot

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

       knon, knindex, &

       rugos_out, alb_out)

!

! This subroutine is called from surf_land_bucket.

! The flag "ok_veget" must can not be true. If coupled run, "ocean=couple"

! then this routine will call limit_read_tot.

!

    USE dimphy

    USE surface_data

! Input arguments

!****************************************************************************************

    INTEGER, INTENT(IN) :: itime                     ! numero du pas de temps courant

    INTEGER, INTENT(IN) :: jour                      ! jour a lire dans l'annee

    REAL   , INTENT(IN) :: dtime                     ! pas de temps de la physique (en s)

    INTEGER, INTENT(IN) :: knon                      ! nomber of points on compressed grid

    INTEGER, DIMENSION(klon), INTENT(IN) :: knindex  ! grid point number for compressed grid

! Output arguments

!****************************************************************************************

    REAL, DIMENSION(klon), INTENT(OUT) :: rugos_out

    REAL, DIMENSION(klon), INTENT(OUT) :: alb_out

! Local variables

!****************************************************************************************

    INTEGER :: i

    LOGICAL :: is_modified

!****************************************************************************************

         (type_ocean == 'slab' .AND. version_ocean == 'sicINT')) THEN

       ! limit.nc has not yet been read. Do it now!

    END IF

    END DO

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!

! This subroutine returns the sea surface temperature already read from limit.nc.

!

    USE dimphy, ONLY : klon

    INTEGER, INTENT(IN)                  :: knon     ! nomber of points on compressed grid

    INTEGER, DIMENSION(klon), INTENT(IN) :: knindex  ! grid point number for compressed grid

    REAL, DIMENSION(klon), INTENT(OUT)   :: sst_out

    INTEGER :: i

    END DO

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!

!! Private subroutine :

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!

! Read everything needed from limit.nc

!

! 0) Initialize

! 1) Open the file limit.nc, if it is time

! 2) Read fraction, if not type_ocean=couple

! 3) Read sea surface temperature, if not type_ocean=couple

! 4) Read albedo and rugosity for land surface, only in case of no vegetation model

! 5) Close file and distribuate variables to all processus

    USE dimphy

    USE mod_grid_phy_lmdz

    USE mod_phys_lmdz_para

    USE surface_data, ONLY : type_ocean, ok_veget

    USE netcdf

    USE indice_sol_mod

    USE phys_cal_mod, ONLY : calend, year_len

    USE print_control_mod, ONLY: lunout, prt_level

#ifdef CPP_XIOS

    USE XIOS, ONLY: xios_recv_field

#endif

    IMPLICIT NONE

! In- and ouput arguments

!****************************************************************************************

    INTEGER, INTENT(IN) :: itime   ! numero du pas de temps courant

    INTEGER, INTENT(IN) :: jour    ! jour a lire dans l'annee

    REAL   , INTENT(IN) :: dtime   ! pas de temps de la physique (en s)

    LOGICAL, INTENT(OUT) :: is_modified  ! true if pctsrf is modified at this time step

! Locals variables with attribute SAVE

!****************************************************************************************

! frequence de lecture des conditions limites (en pas de physique)

    INTEGER,SAVE                              :: lmt_pas

!$OMP THREADPRIVATE(lmt_pas)

    LOGICAL, SAVE                             :: first_call=.TRUE.

!$OMP THREADPRIVATE(first_call)

    INTEGER, SAVE                             :: jour_lu = -1

!$OMP THREADPRIVATE(jour_lu)

! Locals variables

!****************************************************************************************

    INTEGER                                   :: nid, nvarid, ndimid, nn

    INTEGER                                   :: ii, ierr

    INTEGER, DIMENSION(2)                     :: start, epais

    REAL, DIMENSION(klon_mpi,nbsrf)           :: pct_mpi  ! fraction at global grid

    REAL, DIMENSION(klon_mpi)                 :: sst_mpi  ! sea-surface temperature at global grid

    REAL, DIMENSION(klon_mpi)                 :: rug_mpi  ! rugosity at global grid

    REAL, DIMENSION(klon_mpi)                 :: alb_mpi  ! albedo at global grid

    CHARACTER(len=20)                         :: modname='limit_read_mod'

    CHARACTER(LEN=99)                         :: abort_message, calendar, str

! End declaration

!****************************************************************************************

!****************************************************************************************

! 0) Initialization

!

!****************************************************************************************

       ! calculate number of time steps for one day

       ! Allocate module save variables

       END IF

       END IF

!$OMP MASTER  ! Only master thread

          !--- WARNING IF CALENDAR IS KNOWN AND DOES NOT MATCH THE ONE OF LMDZ

          END IF

          !--- ERROR IF FILE RECORDS NUMBER IS NOT EQUAL TO EXPECTED NUMBER OF DAYS

          ELSE

          ENDIF

          !--- ERROR IF FILES AND LMDZ HORIZONTAL RESOLUTIONS DO NOT MATCH

          ELSE

          ENDIF

       END IF ! is_mpi_root

!$OMP END MASTER

!$OMP BARRIER

    END IF

!****************************************************************************************

! 1) Open the file limit.nc if it is the right moment to read, once a day.

!    The file is read only by the master thread of the master mpi process(is_mpi_root)

!    Check by the way if the number of records is correct.

!

!****************************************************************************************

!ym    IF (MOD(itime-1, lmt_pas) == 0 .OR. jour_lu /= jour ) THEN   ! time to read

!  not REALLY PERIODIC

!    IF (MOD(itime-1, lmt_pas) == 0) THEN   ! time to read

#ifdef CPP_XIOS

        IF ( type_ocean /= 'couple') THEN

           IF (is_omp_master) CALL xios_recv_field("foce_limin",pct_mpi(:,is_oce))

           IF (is_omp_master) CALL xios_recv_field("fsic_limin",pct_mpi(:,is_sic))

  !         IF (read_continents .OR. itime == 1) THEN

           IF (is_omp_master) CALL xios_recv_field("fter_limin",pct_mpi(:,is_ter))

           IF (is_omp_master) CALL xios_recv_field("flic_limin",pct_mpi(:,is_lic))

  !         ENDIF

         ENDIF! type_ocean /= couple

         IF ( type_ocean /= 'couple') THEN

             IF (is_omp_master) CALL xios_recv_field("sst_limin",sst_mpi)

         ENDIF

         IF (.NOT. ok_veget) THEN

           IF (is_omp_master) CALL xios_recv_field("alb_limin",alb_mpi)

           IF (is_omp_master) CALL xios_recv_field("rug_limin",rug_mpi)

         ENDIF

       IF ( type_ocean /= 'couple') THEN

          CALL Scatter_omp(sst_mpi,sst)

          CALL Scatter_omp(pct_mpi(:,is_oce),pctsrf(:,is_oce))

          CALL Scatter_omp(pct_mpi(:,is_sic),pctsrf(:,is_sic))

!          IF (read_continents .OR. itime == 1) THEN

             CALL Scatter_omp(pct_mpi(:,is_ter),pctsrf(:,is_ter))

             CALL Scatter_omp(pct_mpi(:,is_lic),pctsrf(:,is_lic))

!          END IF

       END IF

       IF (.NOT. ok_veget) THEN

          CALL Scatter_omp(alb_mpi, albedo)

          CALL Scatter_omp(rug_mpi, rugos)

       END IF

#endif

     ELSE      ! grid_type==regular

!$OMP MASTER  ! Only master thread

          ! La tranche de donnees a lire:

!****************************************************************************************

! 2) Read fraction if not type_ocean=couple

!

!****************************************************************************************

!

! Ocean fraction

!

! Sea-ice fraction

! Read land and continentals fraction only if asked for

!

! Land fraction

!

! Continentale ice fraction

             END IF

          END IF ! type_ocean /= couple

!****************************************************************************************

! 3) Read sea-surface temperature, if not coupled ocean

!

!****************************************************************************************

          END IF

!****************************************************************************************

! 4) Read albedo and rugosity for land surface, only in case of no vegetation model

!

!****************************************************************************************

!

! Read albedo

!

! Read rugosity

          END IF

!****************************************************************************************

! 5) Close file and distribuate variables to all processus

!

!****************************************************************************************

       ENDIF ! is_mpi_root

!$OMP END MASTER

!$OMP BARRIER

          END IF

       END IF

       END IF

      ENDIF ! Grid type

    ENDIF ! time to read

END MODULE limit_read_mod