api_run_sis.f

Go to the documentation of this file.

!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!
      MODULE api_run_sis
!

      USE api_handle_error
      USE api_handle_var_sis
      USE api_instance_sis
      USE interface_sisyphe
      USE bief
      USE declarations_telemac
      USE declarations_sisyphe
      USE declarations_special
      USE declarations_parallel, ONLY : comm
      IMPLICIT NONE
      PRIVATE
      ! COMMON VALUES TO DEFINE OUTPUT + LANGUAGE
!
      INTEGER tdeb,tfin,iflot,ncar,nit_ori,nit_to_do
!
      CHARACTER(LEN=24), PARAMETER :: code='SISYPHE                 '
!
      CHARACTER(LEN=MAXLENTMPDIR) path
      CHARACTER(LEN=250) motcar(300),file_desc(4,300)
!
      INTEGER  time_in_seconds
      EXTERNAL time_in_seconds
!
! List the public subroutines
!
      PUBLIC :: run_set_config_sis_d
      PUBLIC :: run_read_case_sis_d
      PUBLIC :: run_allocation_sis_d
      PUBLIC :: run_init_sis_d
      PUBLIC :: run_timestep_sis_d
      PUBLIC :: run_finalize_sis_d

      CONTAINS
      ! SET THE LU AND LNG VALUES
      !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      SUBROUTINE run_set_config_sis_d(INST, U_LU, U_LNG, U_COMM,
     &                                U_STD_OUTPUT, IERR)
        TYPE(instance_sis),  INTENT(INOUT) :: inst
        INTEGER,             INTENT(IN) :: U_LU, U_LNG, U_COMM
        LOGICAL,             INTENT(IN) :: U_STD_OUTPUT
        INTEGER,             INTENT(OUT) :: IERR
!
        ierr = 0
!
        lu = u_lu
        lng = u_lng
        comm = u_comm
        std_output = u_std_output
!
      END SUBROUTINE run_set_config_sis_d
!
!!!!!!! FUNCTION HANDLING THE EXECUTION OF THE SIMULATION
!
      !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      SUBROUTINE run_read_case_sis_d(INST,CODE1,CAS_FILE,DICO_FILE,
     &                               INIT,IERR)
!
        TYPE(instance_sis), INTENT(INOUT) :: INST
        CHARACTER(LEN=24),  INTENT(IN) :: CODE1
        CHARACTER(LEN=250), INTENT(IN) :: CAS_FILE
        CHARACTER(LEN=250), INTENT(IN) :: DICO_FILE
        LOGICAL,            INTENT(IN) :: INIT
        INTEGER,            INTENT(OUT) :: IERR
!
!
        ierr = 0
!
        CALL bief_init(path,ncar,init)
!
        tdeb = time_in_seconds()
!
!  HEADING TO THE LISTING
!
        CALL print_header(code1,'                        ')
!
!-----------------------------------------------------------------------
!
! READS THE STEERING FILE
!
        CALL lecdon_sisyphe(motcar,file_desc,path,ncar,code1,
     &  cas_file,dico_file)
!
      END SUBROUTINE run_read_case_sis_d
!
      !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      SUBROUTINE run_allocation_sis_d(INST,IERR)
        TYPE(instance_sis), INTENT(INOUT) :: INST
        INTEGER,            INTENT(OUT) :: IERR

        ierr = 0
        iflot = 0
        CALL bief_open_files(code,inst%SIS_FILES,inst%MAXLU_SIS,
     &                     path,ncar,2,.true.)
!
!-----------------------------------------------------------------------
!
! ALLOCATES VECTORS, MATRICES AND BLOCKS
!
        CALL point_sisyphe
      END SUBROUTINE run_allocation_sis_d

!
      !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      SUBROUTINE run_init_sis_d(INST,IERR)
!
        TYPE(instance_sis), INTENT(INOUT) :: INST
        INTEGER,            INTENT(OUT) :: IERR
!
        ierr = 0

        CALL sisyphe(2, inst%TEL%LOOPCOUNT,inst%TEL%GRAPHCOUNT,
     &         inst%TEL%LISTCOUNT, inst%TEL%NIT, inst%TEL%U,
     &         inst%TEL%V, inst%TEL%H, inst%TEL%HN,
     &         inst%TEL%ZF, inst%TEL%UETCAR,
     &         inst%TEL%CF, inst%TEL%KS, inst%TEL%SIS_CPL%CONSTFLOW,
     &         inst%TEL%SIS_CPL%NSIS_CFD,inst%TEL%SIS_CPL%SISYPHE_CFD,
     &         inst%TEL%CODE, inst%TEL%PERICOU, inst%TEL%U3D,
     &         inst%TEL%V3D, inst%TEL%T, inst%TEL%VISC, inst%TEL%DT,
     &         inst%TEL%SIS_CPL%CHARR, inst%TEL%SIS_CPL%SUSP,
     &         inst%TEL%FLBOR,inst%TEL%SOLSYS, inst%TEL%DM1,
     &         inst%TEL%UCONV,inst%TEL%VCONV, inst%TEL%ZCONV,
     &         inst%TEL%THETAW,inst%TEL%HW, inst%TEL%TW, inst%TEL%UW,
     &         inst%TEL%YAGOUT,api_iter=inst%LT,grcomp=inst%TEL%COMPLEO)

        nit_ori = inst%NIT !NEED TO CHECK THESE VARIABLE
        nit_to_do = nit_ori     !NEED TO CHECK THESE VARIABLE
      END SUBROUTINE run_init_sis_d

!
      !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      SUBROUTINE run_timestep_sis_d(INST,IERR)
!
        TYPE(instance_sis), INTENT(INOUT) :: INST
        INTEGER,            INTENT(OUT) :: IERR
!
        ierr = 0
!
        IF (nit_to_do.LT.0) THEN
          ierr = overtime_error
          err_mess = 'INITIAL NUMBER OF TIMESTEP OVERREACHED'
        ENDIF
        inst%LT=inst%NIT-nit_to_do+1    !RESTE A TROUVER LE LT DE SISYPHE

        CALL sisyphe(3, inst%TEL%LOOPCOUNT,inst%TEL%GRAPHCOUNT,
     &         inst%TEL%LISTCOUNT, inst%TEL%NIT, inst%TEL%U,
     &         inst%TEL%V, inst%TEL%H, inst%TEL%HN,
     &         inst%TEL%ZF, inst%TEL%UETCAR,
     &         inst%TEL%CF, inst%TEL%KS, inst%TEL%SIS_CPL%CONSTFLOW,
     &         inst%TEL%SIS_CPL%NSIS_CFD,inst%TEL%SIS_CPL%SISYPHE_CFD,
     &         inst%TEL%CODE, inst%TEL%PERICOU, inst%TEL%U3D,
     &         inst%TEL%V3D, inst%TEL%T, inst%TEL%VISC, inst%TEL%DT,
     &         inst%TEL%SIS_CPL%CHARR, inst%TEL%SIS_CPL%SUSP,
     &         inst%TEL%FLBOR, inst%TEL%SOLSYS, inst%TEL%DM1,
     &         inst%TEL%UCONV, inst%TEL%VCONV, inst%TEL%ZCONV,
     &         inst%TEL%THETAW, inst%TEL%HW, inst%TEL%TW, inst%TEL%UW,
     &         inst%TEL%YAGOUT,api_iter=inst%LT,grcomp=inst%TEL%COMPLEO)

        nit_to_do = nit_to_do - 1
!
      END SUBROUTINE run_timestep_sis_d

!
      !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!
      SUBROUTINE run_finalize_sis_d(INST,IERR)
!
        TYPE(instance_sis), INTENT(INOUT) :: INST
        INTEGER,            INTENT(OUT) :: IERR
!
        ierr = 0
!
!-----------------------------------------------------------------------
!
        CALL bief_close_files(inst%SIS_FILES,
     &                        inst%MAXLU_SIS,.false.)
        CALL deall_sisyphe()
!
!
!-----------------------------------------------------------------------
!
        WRITE(lu,11)
11      FORMAT(1x,///,1x,'CORRECT END OF RUN',///)
!
!-----------------------------------------------------------------------
!
        tfin = time_in_seconds()
        WRITE(lu,*) 'COMPUTER TIME: ',tfin-tdeb,' SECONDS'
        ! Only closing file in stand alone otherwise telemac2d will do
        ! it
        IF(inst%TEL%CODE(1:7) == 'SISYPHE') THEN
          ! Closing log files
          IF(ipid.NE.0) THEN
            CLOSE(lu)
          ELSE
            IF(.NOT.std_output) CLOSE(lu)
          ENDIF
        ENDIF
!
!-----------------------------------------------------------------------
!
      END SUBROUTINE run_finalize_sis_d
!
      END MODULE api_run_sis