mod_types.f90

Go to the documentation of this file.

!/===========================================================================/
! Copyright (c) 2007, The University of Massachusetts Dartmouth 
! Produced at the School of Marine Science & Technology 
! Marine Ecosystem Dynamics Modeling group
! All rights reserved.
!
! FVCOM has been developed by the joint UMASSD-WHOI research team. For 
! details of authorship and attribution of credit please see the FVCOM
! technical manual or contact the MEDM group.
!
! 
! This file is part of FVCOM. For details, see http://fvcom.smast.umassd.edu 
! The full copyright notice is contained in the file COPYRIGHT located in the 
! root directory of the FVCOM code. This original header must be maintained
! in all distributed versions.
!
! THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
! AND ANY EXPRESS OR  IMPLIED WARRANTIES, INCLUDING,  BUT NOT  LIMITED TO,
! THE IMPLIED WARRANTIES OF MERCHANTABILITY AND  FITNESS FOR A PARTICULAR
! PURPOSE ARE DISCLAIMED.  
!
!/---------------------------------------------------------------------------/
! CVS VERSION INFORMATION
! $Id$
! $Name$
! $Revision$
!/===========================================================================/

MODULE mod_types
  USE mod_prec
  IMPLICIT NONE
  TYPE map
     INTEGER :: nsize ! SIZE OF LOCAL DATA (Size of Local data)
     INTEGER :: gsize ! GLOBAL SIZE (SIZE OF GLOBAL DATA)
     INTEGER :: lsize ! SIZE OF LOCAL ARRAY (Usually ==nsize or MT,NT)
     ! INDEX FROM LOCAL ARRAY TO GLOBAL ARRAY
     INTEGER, POINTER,  DIMENSION(:) :: loc_2_gl
     ! INDEX FROM LOCAL ARRAY TO LOCAL GRID
     INTEGER, POINTER,  DIMENSION(:) :: loc_2_grid
  END TYPE map

  TYPE comm
     !----------------------------------------------------------
     ! SND: TRUE IF YOU ARE TO SEND TO PROCESSOR               |
     ! RCV: TRUE IF YOU ARE TO RECEIVE FROM PROCESSOR          |
     ! NSND: NUMBER OF DATA TO SEND TO PROCESSOR               |
     ! NRCV: NUMBER OF DATA TO RECEIVE FROM PROCESSOR          |
     ! SNDP: ARRAY POINTING TO LOCATIONS TO SEND TO PROCESSOR  | 
     ! RCVP: ARRAY POINTING TO LOCATIONS RECEIVED FROM PROCESS |
     ! RCPT: POINTER TO LOCATION IN RECEIVE BUFFER             |
     !----------------------------------------------------------

     !  LOGICAL :: SND,RCV
     INTEGER  nsnd,nrcv,rcpt
     INTEGER, POINTER,  DIMENSION(:) :: sndp,rcvp
     REAL(sp), POINTER,   DIMENSION(:) :: mltp
  END TYPE comm

  TYPE bc
     INTEGER ntimes
     REAL(sp), POINTER,  DIMENSION(:) :: times
     CHARACTER(LEN=80) :: label
  END TYPE bc


  ! THIS IS NOT REALLY A GRID - IT ONLY HOLDS INTEGER INDEX DATA THAT
  ! IS GRID DEPENDENT
  TYPE grid
     CHARACTER(len=80):: units
     CHARACTER(len=160):: name
     INTEGER :: m   =0
     INTEGER :: n   =0
     INTEGER :: mt  =0
     INTEGER :: nt  =0
     INTEGER :: mgl =0
     INTEGER :: ngl =0
     INTEGER :: kb  =0
     INTEGER :: kbm1=0
     INTEGER :: kbm2=0

     
     ! PARALLEL STUFF
!     INTEGER, POINTER :: EL_PID(:) !!PROCESSOR OWNER OF GLOBAL ELEMENT

     INTEGER, POINTER :: egid(:) !!GLOBAL ID OF LOCAL ELEMENT
     INTEGER, POINTER :: ngid(:) !!GLOBAL ID OF LOCAL NODE 
     INTEGER, POINTER :: elid(:) !!LOCAL ID OF GLOBAL ELEMENT
     INTEGER, POINTER :: nlid(:) !!LOCAL ID OF GLOBAL NODE 

     ! TRANSFER INDEX INCLUDING HALO
     INTEGER, POINTER :: egid_x(:)
     INTEGER, POINTER :: ngid_x(:)
     INTEGER, POINTER :: elid_x(:)
     INTEGER, POINTER :: nlid_x(:)

     ! GRID DATA POINTERS

     INTEGER, POINTER :: nv(:,:)


     REAL(sp),POINTER :: xm(:)
     REAL(sp),POINTER :: ym(:)
     REAL(sp),POINTER :: lon(:)
     REAL(sp),POINTER :: lat(:)

     REAL(sp),POINTER :: xmc(:)
     REAL(sp),POINTER :: ymc(:)
     REAL(sp),POINTER :: lonc(:)
     REAL(sp),POINTER :: latc(:)

     ! NOTES: SHOULD MAKE AN ARRAY TO STORE 1/ART, 1/ART2 and 1/ART2
     ! IT is faster and safer

!     REAL(SP), POINTER :: ART(:)              !!AREA OF ELEMENT
!     REAL(SP), POINTER :: ART1(:)             !!AREA OF NODE-BASE CONTROl VOLUME
!     REAL(SP), POINTER :: ART2(:)             !!AREA OF ELEMENTS AROUND NODE

     !----------------Node, Boundary Condition, and Control Volume-----------------------!


     INTEGER, POINTER :: nbe(:,:)            !!INDICES OF ELMNT NEIGHBORS
 !    INTEGER, POINTER :: NTVE(:)             !! NUMBER OF ELEMENTS SURROUNDING EACH NODE
 !    INTEGER, POINTER :: NTSN(:)             !! NUMBER OF NODES SURROUNDING EACH NODE
 !    INTEGER, POINTER :: ISONB(:)            !!NODE MARKER = 0,1,2
 !    INTEGER, POINTER :: ISBC(:)     
 !    INTEGER, POINTER :: ISBCE(:)     
 !    INTEGER, POINTER :: IEC(:,:)
 !    INTEGER, POINTER :: IENODE(:,:)
     INTEGER, POINTER :: nbsn(:,:)            !! INDICES OF NODES SURROUNDING EACH NODE
!     INTEGER, POINTER :: NIEC(:,:)
!     INTEGER, POINTER :: NTRG(:)
     INTEGER, POINTER :: nbve(:,:)            !! INDICIES OF ELEMENTS SURROUNDING EACH NODE
!     INTEGER, POINTER :: NBVT(:,:)

     !----------------2-d arrays for the general vertical coordinate -------------------------------!

     REAL(sp), POINTER :: h(:)                      !!BATHYMETRY 
     REAL(sp), POINTER :: z(:,:)                    !!SIGMA COORDINATE VALUE 
     REAL(sp), POINTER :: zz(:,:)                   !!INTRA LEVEL SIGMA VALUE
     REAL(sp), POINTER :: h1(:)                      !!BATHYMETRY 
     REAL(sp), POINTER :: z1(:,:)                    !!SIGMA COORDINATE VALUE 
     REAL(sp), POINTER :: zz1(:,:)                   !!INTRA LEVEL SIGMA VALUE

     !------------shape coefficient arrays and control volume metrics--------------------!
     
!     REAL(SP), POINTER :: A1U(:,:)      
!     REAL(SP), POINTER :: A2U(:,:)     
!     REAL(SP), POINTER :: AWX(:,:)   
!     REAL(SP), POINTER :: AWY(:,:)  
!     REAL(SP), POINTER :: AW0(:,:) 
!     REAL(SP), POINTER :: ALPHA(:)
     

     ! OBC DATA

!     INTEGER :: IOBCN =0
!     INTEGER, POINTER :: I_OBC_N(:)
!     INTEGER, POINTER :: TYPE_OBC(:)

     ! END DATA POINTERS FOR GRID TYPE

  END TYPE grid

  CONTAINS

    SUBROUTINE kill_grid(G)
      IMPLICIT NONE
      TYPE(grid), POINTER :: G
      

      IF(.NOT. ASSOCIATED(g)) RETURN

!      IF(ASSOCIATED(G%EL_PID)) DEALLOCATE(G%EL_PID)

      IF(ASSOCIATED(g%egid)) DEALLOCATE(g%egid)
      IF(ASSOCIATED(g%ngid)) DEALLOCATE(g%ngid)
      IF(ASSOCIATED(g%elid)) DEALLOCATE(g%elid)
      IF(ASSOCIATED(g%nlid)) DEALLOCATE(g%nlid)

      IF(ASSOCIATED(g%egid_X)) DEALLOCATE(g%egid_X)
      IF(ASSOCIATED(g%elid_X)) DEALLOCATE(g%elid_X)
      IF(ASSOCIATED(g%ngid_X)) DEALLOCATE(g%ngid_X)
      IF(ASSOCIATED(g%nlid_X)) DEALLOCATE(g%nlid_X)

      IF(ASSOCIATED(g%NV)) DEALLOCATE(g%NV)

      IF(ASSOCIATED(g%XM)) DEALLOCATE(g%XM)
      IF(ASSOCIATED(g%YM)) DEALLOCATE(g%YM)
      IF(ASSOCIATED(g%LON)) DEALLOCATE(g%LON)
      IF(ASSOCIATED(g%LAT)) DEALLOCATE(g%LAT)

      IF(ASSOCIATED(g%XMC)) DEALLOCATE(g%XMC)
      IF(ASSOCIATED(g%YMC)) DEALLOCATE(g%YMC)
      IF(ASSOCIATED(g%LONC)) DEALLOCATE(g%LONC)
      IF(ASSOCIATED(g%LATC)) DEALLOCATE(g%LATC)

!      IF(ASSOCIATED(G%ART)) DEALLOCATE(G%ART)
!      IF(ASSOCIATED(G%ART1)) DEALLOCATE(G%ART1)
!      IF(ASSOCIATED(G%ART2)) DEALLOCATE(G%ART2)

      IF(ASSOCIATED(g%NBE)) DEALLOCATE(g%NBE)
!      IF(ASSOCIATED(G%NTVE)) DEALLOCATE(G%NTVE)
!      IF(ASSOCIATED(G%NTSN)) DEALLOCATE(G%NTSN)
!      IF(ASSOCIATED(G%ISONB)) DEALLOCATE(G%ISONB)
!      IF(ASSOCIATED(G%ISBC)) DEALLOCATE(G%ISBC)
!      IF(ASSOCIATED(G%IEC)) DEALLOCATE(G%IEC)
!      IF(ASSOCIATED(G%IENODE)) DEALLOCATE(G%IENODE)
      IF(ASSOCIATED(g%NBSN)) DEALLOCATE(g%NBSN)
!      IF(ASSOCIATED(G%NIEC)) DEALLOCATE(G%NIEC)
!      IF(ASSOCIATED(G%NTRG)) DEALLOCATE(G%NTRG)
      IF(ASSOCIATED(g%NBVE)) DEALLOCATE(g%NBVE)
!      IF(ASSOCIATED(G%NBVT)) DEALLOCATE(G%NBVT)

!      IF(ASSOCIATED(G%Z)) DEALLOCATE(G%Z)
!      IF(ASSOCIATED(G%ZZ)) DEALLOCATE(G%ZZ)
 
!      IF(ASSOCIATED(G%A1U)) DEALLOCATE(G%A1U)
!      IF(ASSOCIATED(G%A2U)) DEALLOCATE(G%A2U)
!      IF(ASSOCIATED(G%AWX)) DEALLOCATE(G%AWX)
!      IF(ASSOCIATED(G%AWY)) DEALLOCATE(G%AWY)
!      IF(ASSOCIATED(G%AW0)) DEALLOCATE(G%AW0)
!      IF(ASSOCIATED(G%ALPHA)) DEALLOCATE(G%ALPHA)

!      IF(ASSOCIATED(G%I_OBC_N)) DEALLOCATE(G%I_OBC_N)
!      IF(ASSOCIATED(G%TYPE_OBC)) DEALLOCATE(G%TYPE_OBC)

      
      DEALLOCATE(g)


    END SUBROUTINE kill_grid


END MODULE mod_types