!!  Copyright (C) Stichting Deltares, 2005-2020.
!!
!!  This file is part of iMOD.
!!
!!  This program is free software: you can redistribute it and/or modify
!!  it under the terms of the GNU General Public License as published by
!!  the Free Software Foundation, either version 3 of the License, or
!!  (at your option) any later version.
!!
!!  This program is distributed in the hope that it will be useful,
!!  but WITHOUT ANY WARRANTY; without even the implied warranty of
!!  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
!!  GNU General Public License for more details.
!!
!!  You should have received a copy of the GNU General Public License
!!  along with this program.  If not, see <http://www.gnu.org/licenses/>.
!!
!!  Contact: imod.support@deltares.nl
!!  Stichting Deltares
!!  P.O. Box 177
!!  2600 MH Delft, The Netherlands.
!!
MODULE MOD_BATCH_FLUMY

USE WINTERACTER
USE RESOURCE
USE MOD_IPF_PAR
USE MOD_IPF, ONLY : IPFREAD2,IPFALLOCATE,IPFDEALLOCATE
USE MOD_IPFASSFILE,ONLY : IPFOPENASSFILE,IPFREADASSFILELABEL,IPFREADASSFILE
USE MOD_IPFASSFILE_UTL
USE MOD_OSD, ONLY : OSD_OPEN
USE MOD_UTL, ONLY : UTL_CAP,UTL_GETUNIT,UTL_CREATEDIR,RTOS,ITOS

TYPE FLMOBJ
 CHARACTER(LEN=52) :: GRAIN
 CHARACTER(LEN=2) :: FACL
 INTEGER :: FACN
END TYPE FLMOBJ
TYPE(FLMOBJ),ALLOCATABLE,DIMENSION(:) :: FLM

REAL(KIND=DP_KIND) :: XOFFSET,YOFFSET,ZOFFSET

CONTAINS

 !###======================================================================
 SUBROUTINE FLUMY_MAIN(IPFFNAME)
 !###======================================================================
 IMPLICIT NONE
 CHARACTER(LEN=*),INTENT(IN) :: IPFFNAME
 INTEGER :: IU,JU,I,J,K,IOS
 CHARACTER(LEN=256) :: FNAME,DIR,LINE
 REAL(KIND=DP_KIND) :: X,Y,DZ,DZT,DZV,DY
 
 NIPF=1; CALL IPFALLOCATE()
 IPF(1)%XCOL =1 !## x
 IPF(1)%YCOL =2 !## y
 IPF(1)%QCOL =1 !## q not used
 IPF(1)%ZCOL =1 !## z not used
 IPF(1)%Z2COL=1 !## z2 not used  
 IPF(1)%FNAME=IPFFNAME
 
 !## read entire ipf
 IF(.NOT.IPFREAD2(1,1,1))RETURN

 !## store each drill in memory for picking purposes
 CALL IPFASSFILEALLOCATE(1)
 
 !## create flumy folder
 J=INDEX(IPF(1)%FNAME,'\',.TRUE.)
 DIR=IPF(1)%FNAME(1:J-1)

 !## Read all lines from IPF-file and open related associated file
 DO I=1,IPF(1)%NROW
  X=IPF(1)%XYZ(1,I) !## x-coordinate borehole
  Y=IPF(1)%XYZ(2,I) !## y-coordinate borehole

  !## read associated file 
  FNAME=TRIM(DIR)//'\'//TRIM(IPF(1)%INFO(IPF(1)%ACOL,I))//'.'//TRIM(ADJUSTL(IPF(1)%FEXT))
  !## read dimensions of associated file
  IF(IPFOPENASSFILE(IU,1,FNAME))THEN
   !## drill found   
   IF(ASSF(1)%ITOPIC.EQ.2)THEN
    IF(IPFREADASSFILELABEL(IU,1,FNAME).AND.IPFREADASSFILE(IU,1,FNAME))THEN

     !## write data to txt-file in flumy-format
     FNAME=TRIM(DIR)//'\FLUMY\'//TRIM(IPF(1)%INFO(IPF(1)%ACOL,I))//'_flumy.txt'
     CALL UTL_CREATEDIR(FNAME(1:INDEX(FNAME,'\',.TRUE.)-1))
     JU=UTL_GETUNIT(); CALL OSD_OPEN(JU,FILE=FNAME,STATUS='UNKNOWN',ACTION='WRITE',IOSTAT=IOS)
     IF(JU.NE.0)THEN
      WRITE(JU,'(A)')'# ====================================================================='
      WRITE(JU,'(A)')'# Well '//TRIM(IPF(1)%INFO(IPF(1)%ACOL,I))
      WRITE(JU,'(A)')'#'
      WRITE(JU,'(A)')'# Coordinates, depth and thickness are expressed in meters'
      WRITE(JU,'(A)')'# ====================================================================='
      WRITE(JU,'(A)')'# Well Location'
      DZ=X-XOFFSET
      LINE='X_WELL='//TRIM(RTOS(DZ,'F',4))
      WRITE(JU,'(A)') TRIM(LINE)
      DY=Y-YOFFSET
      LINE='Y_WELL='//TRIM(RTOS(DY,'F',4))
      WRITE(JU,'(A)') TRIM(LINE)
      WRITE(JU,'(A)')'#'
      WRITE(JU,'(A)')'# Bottom elevation'
      LINE='Z_BOTTOM='//TRIM(RTOS(ASSF(1)%Z(ASSF(1)%NRASS)+ZOFFSET,'F',1))
      WRITE(JU,'(A)') TRIM(LINE)  
      WRITE(JU,'(A)')'# Top elevation'
      LINE='Z_TOP='//TRIM(RTOS(ASSF(1)%Z(1)+ZOFFSET,'F',1))
      WRITE(JU,'(A)') TRIM(LINE)
      WRITE(JU,'(A)')'#'
      WRITE(JU,'(A)')'# Deposits From top to bottom'
      WRITE(JU,'(A)')'# Facies_id Facies Depth'
      WRITE(JU,'(A)')'#   Warning : Depth from top of deposit basis'
      WRITE(JU,'(A)')'ATTRIBUTE_COLUMN=1'
      WRITE(JU,'(A)')'DEPTH_COLUMN=3'
      WRITE(JU,'(A)')'DISCRETE_ATTRIBUTE=1'
      WRITE(JU,'(A)')'STANDARD_FACIES=1'
      WRITE(JU,'(A)')'~Ascii' 
     
      !#search for lithology class in data string, and compare with GRAIN-variable in batch-file.
      DO K=1,ASSF(1)%NRASS-1 !loop over rows associated file
       DO J=1,SIZE(FLM)
        IF(TRIM(UTL_CAP(ASSF(1)%L(3,K),'U')).EQ.TRIM(FLM(J)%GRAIN))EXIT
       ENDDO
       !## grain found
       IF(J.LE.SIZE(FLM))THEN
        DZT=ASSF(1)%Z(1)-ASSF(1)%Z(ASSF(1)%NRASS) !#difference between top and bottom of borehole
        DZ=ASSF(1)%Z(1)-ASSF(1)%Z(K+1) !## difference between 2 layers
        DZV=DZ-DZT !#difference between total depth borehole and the depth of specific layer
        LINE=TRIM(ITOS(FLM(J)%FACN))//' '//TRIM(UTL_CAP(FLM(J)%FACL,'U'))//' '//TRIM(RTOS(DZT+DZV,'F',1))
        WRITE(JU,'(A)') TRIM(LINE)
       ELSE
        write(*,*) 'K=',K
        WRITE(*,'(A)') 'iMOD cannot find '//TRIM(UTL_CAP(ASSF(1)%L(3,K),'U'))//' in *.ini file. Check your *.ini file on missing GRAIN-parameter.'
        RETURN
       ENDIF

      ENDDO
      CLOSE(JU)
     ELSE
      !## error message iMOD isn't able to make the file
      WRITE(*,'(A)') 'iMOD cannot create file :'//TRIM(FNAME)//'. It is probably opened already in another application.'
     ENDIF   
    ENDIF
   ENDIF
  ENDIF
  
 ENDDO

 CALL IPFDEALLOCATE()
 
 END SUBROUTINE FLUMY_MAIN

END MODULE MOD_BATCH_FLUMY