user_tide.f

Go to the documentation of this file.

!                   ********************
                    SUBROUTINE user_tide
!                   ********************
!
     &(nmar,fmtmar)
!
!***********************************************************************
! TOMAWAC
!***********************************************************************
!
!brief    READS THE TIDES IN A USER-DEFINED FILE FORMAT.
!
!note     DURING THE FIRST PASS THE USER MUST IDENTIFY THE TIMES TV1 AND TV2
!+        WHICH SURROUND THE FIRST TIME STEP. NEXT, USING THE ARRAYS
!+        XRELV,YRELV,UR,VR OR DIRECTLY FROM THE TIDE FILE, THE USER
!+        MAY HAVE TO INTERPOLATE THE TIDES READ FROM THE FILE INTO THE
!+        ARRAYS U1,V1 U2,V2.
!+
!+    INTERPOLATION SUBROUTINE FASP :
!+
!+    CALL FASP(X,Y,Z1,NPOIN,XRELV,YRELV,ZR,NP,NBOR,MESH%KP1BOR%I,NPTFR,0.D0)
!+
!+    THE CODE WILL INTERPOLATE THE TIDE AUTOMATICALLY BETWEEN THESE
!+        2 TIME STEPS.
!+
!+    THE OTHER PASSES OCCUR WHEN A NEW RECORD IS REQUIRED (AT>TV2).
!+        IN THIS CASE TV2,Z2 ONLY ARE TO BE COMPUTED.
!
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!| FMTMAR         |-->| TIDAL WATER LEVEL FILE FORMAT
!| NBOR           |-->| GLOBAL NUMBER OF BOUNDARY POINTS
!| NMAR           |-->| LOGICAL UNIT NUMBER OF TIDAL WATER LEVEL FILE
!| NPTFR          |-->| NUMBER OF BOUNDARY POINTS
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!
      USE declarations_special
!     USE DECLARATIONS_TOMAWAC, ONLY :   NPOIN2, X, Y, DDC, AT,
!    &                ZM1, ZM2, TM1, TM2, NBOR, NPTFR
      USE interface_tomawac, ex_user_tide=> user_tide
      IMPLICIT NONE
!
!
!+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
!
      INTEGER, INTENT(IN)             :: NMAR
      CHARACTER(LEN=8), INTENT(IN)    :: FMTMAR
!
!+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
!
      WRITE(lu,*) '*********************************************'
      WRITE(lu,*) '      YOU ARE CALLING SUBROUTINE USER_TIDE   '
      WRITE(lu,*) '            (TIDE FILE FORMAT = 4)           '
      WRITE(lu,*) '           BUT YOU DID NOT MODIFY IT         '
      WRITE(lu,*) '*********************************************'
      CALL plante(1)
      stop
!
!-----------------------------------------------------------------------
!
      RETURN
      END