source: trunk/LMDZ.MARS/libf/phymars/phyetat0_mod.F90 @ 1962

module phyetat0_mod

implicit none

contains

subroutine phyetat0 (fichnom,tab0,Lmodif,nsoil,ngrid,nlay,nq, &
                     day_ini,time0,tsurf,tsoil,albedo,emis,q2,qsurf,co2ice, &
                     tauscaling,totcloudfrac,wstar,mem_Mccn_co2,mem_Nccn_co2,&
                     mem_Mh2o_co2)

  use tracer_mod, only: noms ! tracer names
  use surfdat_h, only: phisfi, albedodat, z0, z0_default,&
                       zmea, zstd, zsig, zgam, zthe
  use iostart, only: nid_start, open_startphy, close_startphy, &
                     get_field, get_var, inquire_field, &
                     inquire_dimension, inquire_dimension_length
  use ioipsl_getincom, only : getin

  implicit none
!======================================================================
! Auteur(s) Z.X. Li (LMD/CNRS) date: 19930818
!  Adaptation à Mars : Yann Wanherdrick 
! Objet: Lecture de l etat initial pour la physique
! Modifs: Aug.2010 EM : use NetCDF90 to load variables (enables using
!                      r4 or r8 restarts independently of having compiled
!                      the GCM in r4 or r8)
!         June 2013 TN : Possibility to read files with a time axis
!         November 2013 EM : Enabeling parallel, using iostart module
!======================================================================
  INTEGER nbsrf !Mars nbsrf a 1 au lieu de 4
  PARAMETER (nbsrf=1) ! nombre de sous-fractions pour une maille
!======================================================================
!  Arguments:
!  ---------
!  inputs:
  character*(*),intent(in) :: fichnom ! "startfi.nc" file
  integer,intent(in) :: tab0
  integer,intent(in) :: Lmodif
  integer,intent(in) :: nsoil ! # of soil layers
  integer,intent(in) :: ngrid ! # of atmospheric columns
  integer,intent(in) :: nlay ! # of atmospheric layers
  integer,intent(in) :: nq
  integer :: day_ini
  real :: time0

!  outputs:
  real,intent(out) :: tsurf(ngrid) ! surface temperature
  real,intent(out) :: tsoil(ngrid,nsoil) ! soil temperature
  real,intent(out) :: albedo(ngrid,2) ! surface albedo
  real,intent(out) :: emis(ngrid) ! surface emissivity
  real,intent(out) :: q2(ngrid,nlay+1) ! 
  real,intent(out) :: qsurf(ngrid,nq) ! tracers on surface
  real,intent(out) :: co2ice(ngrid) ! co2 ice cover
  real,intent(out) :: tauscaling(ngrid) ! dust conversion factor
  real,intent(out) :: totcloudfrac(ngrid) ! total cloud fraction
  real,intent(out) :: wstar(ngrid) ! Max vertical velocity in thermals (m/s)
  real,intent(out) :: mem_Mccn_co2(ngrid,nlay) ! Memory of CCN mass of H2O and dust used by CO2
  real,intent(out) :: mem_Nccn_co2(ngrid,nlay) ! Memory of CCN number of H2O and dust used by CO2
  real,intent(out) :: mem_Mh2o_co2(ngrid,nlay) ! Memory of H2O mass integred into CO2 crystal
!======================================================================
!  Local variables:

      real surffield(ngrid) ! to temporarily store a surface field
      real xmin,xmax ! to display min and max of a field
!
      INTEGER ig,iq,lmax
      INTEGER nid, nvarid
      INTEGER ierr, i, nsrf
!      integer isoil 
!      INTEGER length
!      PARAMETER (length=100)
      CHARACTER*7 str7
      CHARACTER*2 str2
      CHARACTER*1 yes
!
      REAL p_rad,p_omeg,p_g,p_mugaz,p_daysec
      INTEGER nqold

! flag which identifies if 'startfi.nc' file is using old names (qsurf01,...)
      logical :: oldtracernames=.false.
      integer :: count
      character(len=30) :: txt ! to store some text

! specific for time 
      REAL,ALLOCATABLE :: time(:) ! times stored in start
      INTEGER timelen ! number of times stored in the file
      INTEGER indextime ! index of selected time

      INTEGER :: edges(3),corner(3)
      LOGICAL :: found

      REAL :: timestart ! to pick which initial state to start from

! open physics initial state file:
call open_startphy(fichnom)


! possibility to modify tab_cntrl in tabfi
write(*,*)
write(*,*) 'TABFI in phyeta0: Lmodif=',Lmodif," tab0=",tab0
call tabfi (nid_start,Lmodif,tab0,day_ini,lmax,p_rad, &
            p_omeg,p_g,p_mugaz,p_daysec,time0)


! Load surface geopotential:
call get_field("phisfi",phisfi,found)
if (.not.found) then
  write(*,*) "phyetat0: Failed loading <phisfi>"
  call abort
else
  write(*,*) "phyetat0: surface geopotential <phisfi> range:", &
             minval(phisfi), maxval(phisfi)
endif


! Load bare ground albedo:
call get_field("albedodat",albedodat,found)
if (.not.found) then
  write(*,*) "phyetat0: Failed loading <albedodat>"
  call abort
else
  write(*,*) "phyetat0: Bare ground albedo <albedodat> range:", &
             minval(albedodat), maxval(albedodat)
endif

! ZMEA
call get_field("ZMEA",zmea,found)
if (.not.found) then
  write(*,*) "phyetat0: Failed loading <ZMEA>"
  call abort
else
  write(*,*) "phyetat0: <ZMEA> range:", &
             minval(zmea), maxval(zmea)
endif


! ZSTD
call get_field("ZSTD",zstd,found)
if (.not.found) then
  write(*,*) "phyetat0: Failed loading <ZSTD>"
  call abort
else
  write(*,*) "phyetat0: <ZSTD> range:", &
             minval(zstd), maxval(zstd)
endif


! ZSIG
call get_field("ZSIG",zsig,found)
if (.not.found) then
  write(*,*) "phyetat0: Failed loading <ZSIG>"
  call abort
else
  write(*,*) "phyetat0: <ZSIG> range:", &
             minval(zsig), maxval(zsig)
endif


! ZGAM
call get_field("ZGAM",zgam,found)
if (.not.found) then
  write(*,*) "phyetat0: Failed loading <ZGAM>"
  call abort
else
  write(*,*) "phyetat0: <ZGAM> range:", &
             minval(zgam), maxval(zgam)
endif


! ZTHE
call get_field("ZTHE",zthe,found)
if (.not.found) then
  write(*,*) "phyetat0: Failed loading <ZTHE>"
  call abort
else
  write(*,*) "phyetat0: <ZTHE> range:", &
             minval(zthe), maxval(zthe)
endif

      
! Time axis
! obtain timestart from run.def
timestart=-9999 ! default value
call getin("timestart",timestart)

found=inquire_dimension("Time")
if (.not.found) then
  indextime = 1
  write(*,*) "phyetat0: No time axis found in "//trim(fichnom)
else
  write(*,*) "phyetat0: Time axis found in "//trim(fichnom)
  timelen=inquire_dimension_length("Time")
  allocate(time(timelen))
  ! load "Time" array:
  call get_var("Time",time,found)
  if (.not.found) then
    write(*,*) "phyetat0: Failed loading <Time>"
    call abort
  endif
  ! seclect the desired time index
  IF (timestart .lt. 0) THEN  ! default: we use the last time value
    indextime = timelen
  ELSE  ! else we look for the desired value in the time axis
    indextime = 0
    DO i=1,timelen
      IF (abs(time(i) - timestart) .lt. 0.01) THEN
        indextime = i
        EXIT
      ENDIF
    ENDDO
    IF (indextime .eq. 0) THEN
      PRINT*, "Time", timestart," is not in "//trim(fichnom)//"!!"
      PRINT*, "Stored times are:"
      DO i=1,timelen
         PRINT*, time(i)
      ENDDO
      CALL abort
    ENDIF
  ENDIF ! of IF (timestart .lt. 0)
  ! In startfi the absolute date is day_ini + time0 + time
  ! For now on, in the GCM physics, it is day_ini + time0
  time0 = time(indextime) + time0
  day_ini = day_ini + INT(time0)
  time0 = time0 - INT(time0)
        
  PRINT*, "phyetat0: Selected time ",time(indextime), &
          " at index ",indextime
     
  DEALLOCATE(time)
endif ! of if Time not found in file


! CO2 ice cover
call get_field("co2ice",co2ice,found,indextime)
if (.not.found) then
  write(*,*) "phyetat0: Failed loading <co2ice>"
  call abort
else
  write(*,*) "phyetat0: CO2 ice cover <co2ice> range:", &
             minval(co2ice), maxval(co2ice)
endif

! Memory of the origin of the co2 particles
call get_field("mem_Mccn_co2",mem_Mccn_co2,found,indextime)
if (.not.found) then
  write(*,*) "phyetat0: <mem_Mccn_co2> not in file"
  mem_Mccn_co2(:,:)=0
else
  write(*,*) "phyetat0: Memory of CCN mass of H2O and dust used by CO2"
  write(*,*) " <mem_Mccn_co2> range:", &
             minval(mem_Mccn_co2), maxval(mem_Mccn_co2)
endif

call get_field("mem_Nccn_co2",mem_Nccn_co2,found,indextime)
if (.not.found) then
  write(*,*) "phyetat0: <mem_Nccn_co2> not in file"
  mem_Nccn_co2(:,:)=0
else
  write(*,*) "phyetat0: Memory of CCN number of H2O and dust used by CO2"
  write(*,*) " <mem_Nccn_co2> range:", &
             minval(mem_Nccn_co2), maxval(mem_Nccn_co2)
endif

call get_field("mem_Mh2o_co2",mem_Mh2o_co2,found,indextime)
if (.not.found) then
  write(*,*) "phyetat0: <mem_Mh2o_co2> not in file"
  mem_Mh2o_co2(:,:)=0
else
  write(*,*) "phyetat0: Memory of H2O mass integred into CO2 crystal"
  write(*,*) " <mem_Mh2o_co2> range:", &
             minval(mem_Mh2o_co2), maxval(mem_Mh2o_co2)
endif

! Dust conversion factor
call get_field("tauscaling",tauscaling,found,indextime)
if (.not.found) then
  write(*,*) "phyetat0: <tauscaling> not in file"
  tauscaling(:) = -1
else
  write(*,*) "phyetat0: dust conversion factor <tauscaling> range:", &
             minval(tauscaling), maxval(tauscaling)
endif

! Sub-grid cloud fraction
call get_field("totcloudfrac",totcloudfrac,found,indextime)
if (.not.found) then
  write(*,*) "phyetat0: <totcloudfrac> not in file WARNING put to 1"
  totcloudfrac(:) = 1.0 !valeur par defaut (CLFfixval par defaut)
else
  write(*,*) "phyetat0: total cloud fraction <totcloudfrac> range:", &
             minval(totcloudfrac), maxval(totcloudfrac)
endif

! Max vertical velocity in thermals
call get_field("wstar",wstar,found,indextime)
if (.not.found) then
  write(*,*) "phyetat0: <totcloudfrac> not in file! Set to zero"
  wstar(:)=0
else
  write(*,*) "phyetat0: Max vertical velocity in thermals <wstar> range:", &
             minval(wstar),maxval(wstar)
endif

! Surface temperature :
call get_field("tsurf",tsurf,found,indextime)
if (.not.found) then
  write(*,*) "phyetat0: Failed loading <tsurf>"
  call abort
else
  write(*,*) "phyetat0: Surface temperature <tsurf> range:", &
             minval(tsurf), maxval(tsurf)
endif

! Surface albedo
call get_field("albedo",albedo(:,1),found,indextime)
if (.not.found) then
  write(*,*) "phyetat0: Failed loading <albedo>"
  albedo(:,1)=albedodat(:)
else
  write(*,*) "phyetat0: Surface albedo <albedo> range:", &
             minval(albedo(:,1)), maxval(albedo(:,1))
endif
albedo(:,2)=albedo(:,1)

! Surface emissivity
call get_field("emis",emis,found,indextime)
if (.not.found) then
  write(*,*) "phyetat0: Failed loading <emis>"
  call abort
else
  write(*,*) "phyetat0: Surface emissivity <emis> range:", &
             minval(emis), maxval(emis)
endif


! surface roughness length (NB: z0 is a common in surfdat_h)
call get_field("z0",z0,found)
if (.not.found) then
  write(*,*) "phyetat0: Failed loading <z0>"
  write(*,*) 'will use constant value of z0_default:',z0_default
  z0(:)=z0_default
else
  write(*,*) "phyetat0: Surface roughness <z0> range:", &
             minval(z0), maxval(z0)
endif


! pbl wind variance
call get_field("q2",q2,found,indextime)
if (.not.found) then
  write(*,*) "phyetat0: Failed loading <q2>"
  call abort
else
  write(*,*) "phyetat0: PBL wind variance <q2> range:", &
             minval(q2), maxval(q2)
endif


! tracer on surface
if (nq.ge.1) then
  do iq=1,nq
    txt=noms(iq)
    if (txt.eq."h2o_vap") then
      ! There is no surface tracer for h2o_vap;
      ! "h2o_ice" should be loaded instead
      txt="h2o_ice"
      write(*,*) 'phyetat0: loading surface tracer', &
                           ' h2o_ice instead of h2o_vap'
    endif
    call get_field(txt,qsurf(:,iq),found,indextime)
    if (.not.found) then
      write(*,*) "phyetat0: Failed loading <",trim(txt),">"
      write(*,*) "         ",trim(txt)," is set to zero"
    else
      write(*,*) "phyetat0: Surface tracer <",trim(txt),"> range:", &
                 minval(qsurf(:,iq)), maxval(qsurf(:,iq))
    endif
  enddo
endif ! of if (nq.ge.1)

! Call to soil_settings, in order to read soil temperatures,
! as well as thermal inertia and volumetric heat capacity
call soil_settings(nid_start,ngrid,nsoil,tsurf,tsoil,indextime)

!
! close file:
!
call close_startphy

end subroutine phyetat0

end module phyetat0_mod