v4.4.9

Author: SiqiLiOcean

README.md

@@ -1,4 +1,4 @@
-# FVCOM 4.4.8
+# FVCOM 4.4.9
 
 http://fvcom.smast.umassd.edu/
 

src/coords_n_const.F

@@ -193,6 +193,9 @@ SUBROUTINE COORDS_N_CONST
 
 
      CALL LOAD_COLDSTART_COORDS(X_GBL,Y_GBL,X_LCL,Y_LCL)
+# if !defined (SPHERICAL)  
+     CALL LOAD_COLDSTART_LONLAT    !@ Siqi Li, LONLAT@20231113 
+# endif   
      CALL COORDINATE_UNITS(X_LCL,Y_LCL)
      CALL SETUP_CENTER_COORDS
 

src/fvcom.F

@@ -27,7 +27,7 @@
 !/===========================================================================/
 
 !==============================================================================!
-!  VERSION 4.4.8
+!  VERSION 4.4.9
 !==============================================================================!
 
 PROGRAM FVCOM

src/mod_input.F

@@ -1352,6 +1352,25 @@ SUBROUTINE OPEN_COLDSTART
     pathnfile = trim(INPUT_DIR)//trim(GRID_FILE)
     Call FOPEN(GRIDUNIT,trim(pathnfile),'cfr')
 
+# if !defined (SPHERICAL) 
+!@---> Siqi Li, LONLAT@20231113
+    !Check LONLAT File and open:
+    if (TRIM(LONLAT_FILE) /= 'none') then
+        USE_LONLAT = .TRUE.
+        ! TEST FILE NAME
+        charnum = index (LONLAT_FILE,".dat")
+        if (charnum /= len_trim(LONLAT_FILE)-3)&
+           & CALL WARNING("LONLAT FILE does not end in .dat", &
+           & trim(LONLAT_FILE))
+        ! OPEN FILE
+        pathnfile = trim(INPUT_DIR)//trim(LONLAT_FILE)
+        Call FOPEN(LONLATUNIT,trim(pathnfile),'cfr')
+    else
+        USE_LONLAT = .FALSE.
+    endif
+!@<--- Siqi Li
+# endif 
+
 # if defined (PLBC) 
     !Check plbc_cell File and open:
     ! OPEN FILE
@@ -2767,6 +2786,7 @@ END SUBROUTINE LOAD_RESTART_LSF_GRID
 
   SUBROUTINE LOAD_RESTART_COORDS(X_LCL,Y_LCL)
     USE CONTROL
+    USE ALL_VARS, ONLY : LON, LAT !@ Siqi Li, LONLAT@20231113
     IMPLICIT NONE
     REAL(SP), ALLOCATABLE,TARGET :: X_LCL(:),Y_LCL(:)
 
@@ -2793,6 +2813,28 @@ SUBROUTINE LOAD_RESTART_COORDS(X_LCL,Y_LCL)
        CALL NC_READ_VAR(VAR)
        CALL NC_DISCONNECT(VAR)
 
+       !@---> Siqi Li, LONLAT@20231113
+       VAR => FIND_VAR(NC_START,'lon',FOUND)
+       IF(.not. FOUND) CALL FATAL_ERROR("COULD NOT FIND VARIABLE 'lon'&
+            & IN THE HOTSTART FILE OBJECT")
+       CALL NC_CONNECT_AVAR(VAR, LON)
+       CALL NC_READ_VAR(VAR)
+       CALL NC_DISCONNECT(VAR)
+
+       VAR => FIND_VAR(NC_START,'lat',FOUND)
+       IF(.not. FOUND) CALL FATAL_ERROR("COULD NOT FIND VARIABLE 'lat'&
+            & IN THE HOTSTART FILE OBJECT")
+       CALL NC_CONNECT_AVAR(VAR, LAT)
+       CALL NC_READ_VAR(VAR)
+       CALL NC_DISCONNECT(VAR)
+       
+       IF (MINVAL(LON)==MAXVAL(LON) .AND. MINVAL(LAT)==MAXVAL(LAT)) THEN
+            USE_LONLAT = .FALSE.
+       ELSE
+            USE_LONLAT = .TRUE.
+       ENDIF
+       !@<--- Siqi Li
+
     CASE('degrees')
        ! CONNECT THE VARIABLE OBJECTS AND LOAD THE DATA
        VAR => FIND_VAR(NC_START,'lon',FOUND)
@@ -4831,6 +4873,129 @@ SUBROUTINE READ_COLDSTART_SIGMA
 
  END SUBROUTINE READ_COLDSTART_SIGMA
 
+!---> Siqi Li, LONLAT@2031113
+  SUBROUTINE READ_COLDSTART_LONLAT(LONLATUNIT,MGL,XG1,YG1)
+
+    IMPLICIT NONE
+    INTEGER, INTENT(IN)  :: LONLATUNIT, MGL
+    REAL(SP),ALLOCATABLE,INTENT(INOUT) :: XG1(:),YG1(:)
+    CHARACTER(LEN=80)    :: temp
+    INTEGER              :: I,IOS,NodeCount, ISCAN
+    Real(sp)             :: X1, Y1
+    !==============================================================================|
+
+    !----------------Determine Number of Nodes -----------------------!
+    ISCAN = SCAN_FILE(LONLATUNIT,"Node Number",ISCAL = NODECOUNT)
+    IF(ISCAN /= 0) then
+       write(temp,'(I2)') ISCAN
+       call fatal_error('Improper formatting of LONLAT FILE: ISCAN ERROR&
+            &# '//trim(temp),&
+            & 'The header must contain: "Node Number ="', &
+            & 'Followed by an integer number of nodes')
+    END IF
+
+    if ( NODECOUNT .NE. MGL) &
+         & CALL FATAL_ERROR('The stated number of nodes in the lonlat file',&
+         ' does not match the number in the grid file')
+
+   !----------------Read LONLAT Array----------------------------------!
+   ! FIND FIRST LINE of CONNECTIVITY ARRAY
+    rewind LONLATUNIT
+    NHEADER = 0
+    DO WHILE(.TRUE.)
+       READ(LONLATUNIT,*,IOSTAT=IOS,END=99)X1,Y1
+       if (IOS == 0) then
+          exit
+       end if
+
+       NHEADER = NHEADER + 1
+       CYCLE
+
+99 Call FATAL_ERROR('Improper formatting of LONLAT FILE:',&
+           &'Reached end of file with out finding LONLAT data?',&
+           &'FORMAT: X Y (ALL REALS)')
+    END DO
+
+    REWIND LONLATUNIT
+    DO I = 1, NHEADER
+       READ(LONLATUNIT,*)
+    END DO
+
+    I = 0
+    DO WHILE(.TRUE.)
+       READ(LONLATUNIT,*,IOSTAT=IOS) X1,Y1
+       IF(IOS < 0) exit
+       I = I + 1
+       IF(I > MGL) CALL FATAL_ERROR('Number of rows of data in the lonlat file &
+            & exceeds the number of nodes ?')
+       IF(X1 < 0.0) X1 = X1 + 360.0_SP
+       XG1(I) = X1
+       YG1(I) = Y1
+    END DO
+
+    if ( I .NE. MGL) &
+         & CALL FATAL_ERROR('The number of rows of data in the lonlat file does&
+         & not equal the number of nodes?')
+
+   if(DBG_SET(dbg_log)) then
+      WRITE(IPT,*)'!  Finished Reading LONLAT File'
+      WRITE(IPT,*)'!  LON range =           :',minval(XG1(1:MGL)),maxval(XG1(1:MGL))
+      WRITE(IPT,*)'!  LAT range =           :',minval(YG1(1:MGL)),maxval(YG1(1:MGL))
+      WRITE(IPT,*)'!'
+   end if
+
+  END SUBROUTINE READ_COLDSTART_LONLAT
+
+
+  SUBROUTINE LOAD_COLDSTART_LONLAT
+    USE CONTROL
+    USE ALL_VARS
+    IMPLICIT NONE
+    integer status,I,IERR
+    REAL(SP), ALLOCATABLE :: LON_GL(:), LAT_GL(:)
+    INTEGER :: SENDID,SENDER
+
+    IF(PAR) CALL MPI_BCAST(USE_LONLAT,1,MPI_LOGICAL,0,MPI_FVCOM_GROUP,IERR)
+
+    ALLOCATE(LON_GL(0:MGL))
+    ALLOCATE(LAT_GL(0:MGL))
+
+    IF (MSR) THEN
+       ! Read (LON, LAT) from the ASCII input
+       CALL READ_COLDSTART_LONLAT(LONLATUNIT,MGL,LON_GL,LAT_GL)
+       CLOSE(LONLATUNIT)
+    END IF
+
+# if defined (MULTIPROCESSORdd)
+    IF(PAR)THEN
+      SENDER = MSRID - 1
+      CALL MPI_BCAST(LON_GL,MGL,MPI_F,SENDER,MPI_FVCOM_GROUP,IERR)
+      CALL MPI_BCAST(LAT_GL,MGL,MPI_F,SENDER,MPI_FVCOM_GROUP,IERR)
+      LON_GL(0)=0.0_SP
+      LAT_GL(0)=0.0_SP
+    END IF
+# endif
+
+    ! Convert it from the global vairable to the local one.
+    IF (SERIAL) THEN
+       LON = LON_GL
+       LAT = LAT_GL
+    ELSE
+# if defined (MULTIPROCESSOR)
+       CALL ADEAL(MYID,MSRID,NPROCS,NXMAP,LON_GL,LON)
+       CALL ADEAL(MYID,MSRID,NPROCS,NXMAP,LAT_GL,LAT)
+# endif
+    ENDIF
+
+    IF (MSR) THEN
+       DEALLOCATE(LON_GL)
+       DEALLOCATE(LAT_GL)
+    ENDIF
+
+  END SUBROUTINE LOAD_COLDSTART_LONLAT
+!<--- Siqi Li
+
+
   SUBROUTINE HelpTxt(IPT)
     implicit none
     INTEGER, INTENT(IN) :: IPT

src/mod_main.F

@@ -802,12 +802,14 @@ MODULE CONTROL
     CHARACTER(LEN=80) GRID_FILE
     CHARACTER(LEN=80) GRID_FILE_UNITS
     CHARACTER(LEN=200) PROJECTION_REFERENCE
+    CHARACTER(LEN=80) LONLAT_FILE     !@ Siqi Li, LONLAT@20231113
     CHARACTER(LEN=80) SIGMA_LEVELS_FILE
     CHARACTER(LEN=80) DEPTH_FILE
     CHARACTER(LEN=80) CORIOLIS_FILE
     CHARACTER(LEN=80) SPONGE_FILE
 
     LOGICAL USE_PROJ
+    LOGICAL USE_LONLAT !@ Siqi Li, LONLAT@20231113
 ! THESE ARE THE FVCOM NAMES FOR 
      !SIGMA_LEVELS = KB
      !SIGMA_LAYERS = KBM1 = KB - 1
@@ -817,6 +819,7 @@ MODULE CONTROL
          & GRID_FILE,                      &
          & GRID_FILE_UNITS,                &
          & PROJECTION_REFERENCE,           &
+         & LONLAT_FILE,                    & !@ Siqi Li, LONLAT@20231113
          & SIGMA_LEVELS_FILE,              &
          & DEPTH_FILE,                     &
          & CORIOLIS_FILE,                  &
@@ -1157,6 +1160,7 @@ MODULE CONTROL
    INTEGER, PARAMETER :: NESTUNIT=30
    INTEGER, PARAMETER :: SUBDUNIT=31
    INTEGER, PARAMETER :: NANUNIT=32  ! Siqi Li, NAN@20230601
+   INTEGER, PARAMETER :: LONLATUNIT=33  !@ Siqi Li, LONLAT@20231113
 
    INTEGER            :: RIVERNMLUNIT
 
@@ -1216,10 +1220,12 @@ MODULE ALL_VARS
    REAL(SP), ALLOCATABLE,TARGET :: YM(:)               !!Y-COORD AT NODE IN METERS
    REAL(SP), ALLOCATABLE,TARGET :: XMC(:)              !!X-COORD AT CELL CENTER IN METERS
    REAL(SP), ALLOCATABLE,TARGET :: YMC(:)              !!Y-COORD AT CELL CENTER IN METERS
+   !@---> Siqi Li, LONLAT@20231113
    REAL(SP), ALLOCATABLE,TARGET :: LON(:)              !!LONGITUDE AT THE NODE
    REAL(SP), ALLOCATABLE,TARGET :: LAT(:)              !!LATITUDE AT THE NODE
    REAL(SP), ALLOCATABLE,TARGET :: LONC(:)              !!LONGITUDE AT THE NODE
    REAL(SP), ALLOCATABLE,TARGET :: LATC(:)              !!LATITUDE AT THE NODE
+   !@<--- Siqi Li
    ! VX,VY and XC,YC are used for either meters or spherical depending on
    ! make file option 'SPHERICAL'
    REAL(SP), ALLOCATABLE,TARGET :: VX(:)               !!X-COORD AT GRID POINT

src/mod_setup.F

@@ -142,8 +142,18 @@ SUBROUTINE SETUP_CENTER_COORDS
     YMC = YC + VYMIN
     YMC(0)= 0.0_SP
 
-    IF (USE_PROJ ) THEN
-        IF (SERIAL) THEN
+    !@---> Siqi Li, LONLAT@20231113
+    IF (USE_LONLAT) THEN
+      CALL N2E2D(LON, LONC)
+      CALL N2E2D(LAT, LATC)
+    ENDIF
+    !@<--- Siqi
+
+!@---> Siqi Li, LONLAT@20231113
+!    IF (USE_PROJ ) THEN
+    IF (USE_PROJ .AND. .NOT. USE_LONLAT) THEN 
+!@<---
+         IF (SERIAL) THEN
            CALL Meters2Degrees(XMC(1:NT),YMC(1:NT)&
                 &   ,PROJECTION_REFERENCE,LONC(1:NT),LATC(1:NT),NT)
 # if defined (MULTIPROCESSOR)
@@ -695,7 +705,10 @@ SUBROUTINE COORDINATE_UNITS(XL,YL)
        YM = YL
 
        ! USE PROJECTION TOOL BOX TO CONVERT TO DEGREES
-       IF (USE_PROJ ) THEN
+!---> Siqi Li, LONLAT@20231113
+!       IF (USE_PROJ ) THEN
+       IF (USE_PROJ .AND. .NOT. USE_LONLAT) THEN  
+!@<---
         IF (SERIAL) THEN
            CALL meters2degrees(XL(1:MT),YL(1:MT), &
             & PROJECTION_REFERENCE,LON(1:MT),LAT(1:MT),MT)

src/mod_utils.F

@@ -141,7 +141,7 @@ SUBROUTINE INITIALIZE_CONTROL(NAME)
 !  FVCOM VERSION                                                               !
 !==============================================================================!
 
-   FVCOM_VERSION     = 'FVCOM_4.4.8'
+   FVCOM_VERSION     = 'FVCOM_4.4.9'
    FVCOM_WEBSITE     = 'http://fvcom.smast.umassd.edu, https://github.com/FVCOM-GitHub/FVCOM'
    INSTITUTION       = 'School for Marine Science and Technology'
 
@@ -2324,7 +2324,7 @@ SUBROUTINE WRITE_BANNER(PAR,NP,ID)
 WRITE(IPT,*)'         |  ___)  | |   | || |      | |   | || ||_|| |            '
 WRITE(IPT,*)'         | |       \ \ / / | |_____ | |___| || |   | |            '
 WRITE(IPT,*)'         |_|        \___/   \______) \_____/ |_|   |_|            '
-WRITE(IPT,*)' -- Version 4.4.8 Release'
+WRITE(IPT,*)' -- Version 4.4.9 Release'
 WRITE(IPT,*)'!================================================================!'
 WRITE(IPT,*)'!                                                                !'
 WRITE(IPT,*)'!========DOMAIN DECOMPOSITION USING: METIS 4.0.1 ================!'