user_current.f

Go to the documentation of this file.

!                   ***********************
                    SUBROUTINE user_current
!                   ***********************
!
     &(ncou,fmtcou)
!
!***********************************************************************
! TOMAWAC
!***********************************************************************
!
!brief    READS IN THE CURRENTS USING A USER-DEFINED FORMAT.
!
!note     DURING THE FIRST PASS THE USER MUST IDENTIFY THE TIMES TC1 AND TC2
!+        WHICH SURROUND THE FIRST TIME STEP. NEXT, USING THE ARRAYS
!+        XRELC,YRELC,UR,VR OR DIRECTLY FROM THE CURRENT FILE, THE USER
!+        MAY HAVE TO INTERPOLATE THE CURRENTS READ FROM THE FILE INTO THE
!+        ARRAYS UC1,VC1 UC2,VC2.
!+
!+    INTERPOLATION SUBROUTINE FASP :
!+
!+    CALL FASP(X,Y,UC1,NPOIN,XRELC,YRELC,UR,NP,NBOR,MESH%KP1BOR%I,NPTFR,0.D0)
!+
!+    CALL FASP(X,Y,VC1,NPOIN,XRELC,YRELC,VR,NP,NBOR,MESH%KP1BOR%I,NPTFR,0.D0)
!+
!+    THE CODE WILL INTERPOLATE THE CURRENT AUTOMATICALLY BETWEEN THESE
!+        2 TIME STEPS.
!+
!+    THE OTHER PASSES OCCUR WHEN A NEW RECORD IS REQUIRED (AT>TC2).
!+        IN THIS CASE TC2,UC2,VC2 ONLY ARE TO BE COMPUTED.
!
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!| AT             |-->| COMPUTATION TIME
!| FMTCOU         |-->| CURRENTS FILE BINARY FORMAT
!| DDC            |-->| DATE OF COMPUTATION BEGINNING
!| NBOR           |-->| GLOBAL NUMBER OF BOUNDARY POINTS
!| NCOU           |-->| LOGICAL UNIT NUMBER OF THE CURRENTS FILE
!| NPMAX          |-->| MAXIMUM NUMBER OF POINTS THAT CAN BE READ
!| NPOIN          |-->| NUMBER OF POINTS IN 2D MESH
!| NPTFR          |-->| NUMBER OF BOUNDARY POINTS
!| TC1            |-->| TIME T1 IN THE CURRENT FILE
!| TC2            |-->| TIME T2 IN THE CURRENT FILE
!| UC1,VC1        |<->| CURRENTS VALUES AT TIME T1 IN THE MESH
!| UC2,VC2        |<->| CURRENTS VALUES AT TIME T2 IN THE MESH
!| X              |-->| ABSCISSAE OF POINTS IN THE MESH
!| Y              |-->| ORDINATES OF POINTS IN THE MESH
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!
!     USE DECLARATIONS_TOMAWAC, ONLY :  NPOIN2, X, Y, DDC, AT,
!    &                UC1, UC2, VC1, VC2, TC1, TC2, NBOR, NPTFR
      USE interface_tomawac, ex_user_current => user_current
!
      USE declarations_special
      IMPLICIT NONE
!
!
!+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
!
      INTEGER, INTENT(IN)             :: NCOU
      CHARACTER(LEN=8), INTENT(IN)    :: FMTCOU
!
!+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
!
      WRITE(lu,*) '*********************************************'
      WRITE(lu,*) '       YOU CALL THE SUBROUTINE COUUTI        '
      WRITE(lu,*) '        (CURRENTS FILE FORMAT = 3)           '
      WRITE(lu,*) '       BUT YOU DID NOT MODIFIED IT           '
      WRITE(lu,*) '*********************************************'
      CALL plante(1)
      stop
!
!-----------------------------------------------------------------------
!
      RETURN
      END