PLAG_InitGenxInterface.F90

Go to the documentation of this file.

! *********************************************************************
! * Rocstar Simulation Suite                                          *
! * Copyright@2015, Illinois Rocstar LLC. All rights reserved.        *
! *                                                                   *
! * Illinois Rocstar LLC                                              *
! * Champaign, IL                                                     *
! * www.illinoisrocstar.com                                           *
! * sales@illinoisrocstar.com                                         *
! *                                                                   *
! * License: See LICENSE file in top level of distribution package or *
! * http://opensource.org/licenses/NCSA                               *
! *********************************************************************
! *********************************************************************
! * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,   *
! * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES   *
! * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND          *
! * NONINFRINGEMENT.  IN NO EVENT SHALL THE CONTRIBUTORS OR           *
! * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER       *
! * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,   *
! * Arising FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE    *
! * USE OR OTHER DEALINGS WITH THE SOFTWARE.                          *
! *********************************************************************
!******************************************************************************
!
! Purpose: register PLAG windows with GenX.
!
! Description: none.
!
! Input: regions    = data of all regions,
!        wins, winp = GenX window registrations.
!
! Output: to Roccom.
!
! Notes: Surface registration for Tiles works only for External coupled bc.
!        Need to activate for both Internal and External bc.
!
!******************************************************************************
!
! $Id: PLAG_InitGenxInterface.F90,v 1.5 2009/10/26 00:19:31 mtcampbe Exp $
!
! Copyright: (c) 2003 by the University of Illinois
!
!******************************************************************************

SUBROUTINE plag_initgenxinterface( regions, wins, inPlag, obtain_attribute )

  USE moddatatypes
  USE modglobal, ONLY     : t_global
  USE modbndpatch, ONLY   : t_patch
  USE moddatastruct, ONLY : t_region
  USE modinterfaces, ONLY : rflo_getdimensdummynodes
  USE moderror
  USE modparameters
  USE plag_modparameters
  USE modpartlag, ONLY    : t_plag, t_tile_plag
  IMPLICIT NONE
  include 'roccomf90.h'

! ... parameters

  TYPE(t_region), POINTER :: regions(:)

  CHARACTER(CHRLEN) :: wins, inplag

  INTEGER :: obtain_attribute

! ... loop variables

  INTEGER :: icont, ireg, ipatch

! ... local variables
  
  CHARACTER(CHRLEN) :: winp

  INTEGER, PARAMETER :: ascii_zero = 48   ! char representation of zero
  INTEGER :: bctype, errorflag, ilb, icount, ilev,pid
  INTEGER :: idnbeg, idnend, jdnbeg, jdnend, kdnbeg, kdnend
  INTEGER :: naiv, narv, ncont, ncontmax, ncv, ncvtile, ndv, ndvtile
  INTEGER :: ndimplag
  INTEGER :: plagstatus
  INTEGER, POINTER, DIMENSION(:) :: pcvtilemass
  INTEGER, POINTER :: pint

  TYPE(t_global),     POINTER :: pglobal
  TYPE(t_patch) ,     POINTER :: ppatch
  TYPE(t_plag)  ,     POINTER :: pplag
  TYPE(t_tile_plag),  POINTER :: ptileplag

!******************************************************************************

  pglobal => regions(1)%global

  CALL registerfunction( pglobal,'PLAG_InitGenxInterface',&
  'PLAG_InitGenxInterface.F90' )

! set PLAG window -------------------------------------------------------------

  winp = trim(pglobal%winName)//'_plag'
  pglobal%winp = winp
  
! input data (currently none) -------------------------------------------------

! output surface data ---------------------------------------------------------

  CALL com_new_attribute( trim(wins)//'.plag_momnrm', 'e',  &
                          com_double, 1, 'kg/(m^2 s)' )
  CALL com_new_attribute( trim(wins)//'.plag_ener',   'e',  &
                          com_double, 1, 'J/kg'       )

  ncontmax = 0
  IF ( pglobal%plagUsed ) THEN
    DO ireg=1,pglobal%nRegions
      ncontmax = max(ncontmax,regions(ireg)%plagInput%nCont)
    ENDDO ! iReg
  ENDIF ! plagUsed

  DO icont=1,ncontmax
    CALL com_new_attribute( trim(wins)//'.plag_mass'//char(icont+ascii_zero), 'e', &
                            com_double, 1, 'kg/m^3' )
  ENDDO ! iCont

  CALL com_new_attribute( trim(wins)//'.plag_dv_timefctr', 'e',   &
                          com_double, 1, ''  )

  CALL com_new_attribute( trim(wins)//'.plag_dv_diam'    , 'e',   &
                          com_double, 1, 'm' )

  CALL com_new_attribute( trim(wins)//'.plag_dv_spload'  , 'e',   &
                          com_double, 1, ''  )

! restart data (av, cv ) and additional plot data (dv= diam) ------------------
  CALL com_new_window( trim(winp))

  CALL com_new_attribute( trim(winp)//'.plag_aiv_pidini', 'n' ,  &
                          com_integer, 1, '' )
  CALL com_new_attribute( trim(winp)//'.plag_aiv_regini', 'n' ,  &
                          com_integer, 1, '' )
  CALL com_new_attribute( trim(winp)//'.plag_aiv_regcrt', 'n' ,  &
                          com_integer, 1, '' )
  CALL com_new_attribute( trim(winp)//'.plag_aiv_icells', 'n' ,  &
                          com_integer, 1, '' )
  CALL com_new_attribute( trim(winp)//'.plag_aiv_indexi', 'n' ,  &
                          com_integer, 1, '' )
  CALL com_new_attribute( trim(winp)//'.plag_aiv_indexj', 'n' ,  &
                          com_integer, 1, '' )
  CALL com_new_attribute( trim(winp)//'.plag_aiv_indexk', 'n' ,  &
                          com_integer, 1, '' )
  CALL com_new_attribute( trim(winp)//'.plag_aiv_burnstat', 'n' ,&
                          com_integer, 1, '' )
  CALL com_new_attribute( trim(winp)//'.plag_arv_spload', 'n' ,  &
                          com_double, 1, '' )

  CALL com_new_attribute( trim(winp)//'.plag_xmom', 'n',         &
                          com_double, 1, 'kg/(m^2 s)'  )
  CALL com_new_attribute( trim(winp)//'.plag_ymom', 'n',         &
                          com_double, 1, 'kg/(m^2 s)'  )
  CALL com_new_attribute( trim(winp)//'.plag_zmom', 'n',         &
                          com_double, 1, 'kg/(m^2 s)'  )
  CALL com_new_attribute( trim(winp)//'.plag_ener', 'n',         &
                          com_double, 1, 'J/kg'        )
  CALL com_new_attribute( trim(winp)//'.plag_enervapor', 'n',    &
                          com_double, 1, 'J/kg'        )
  DO icont = 1, ncontmax
    CALL com_new_attribute( trim(winp)//'.plag_mass'//char(icont+ascii_zero), 'n', &
                            com_double,1, 'kg/m^3'     )
  ENDDO ! iCont

  CALL com_new_attribute( trim(winp)//'.plag_diam', 'n',         &
                          com_double, 1,'m'            )

  CALL com_new_attribute( trim(winp)//'.plag_nextid', 'p',com_integer, 1,'')

! loop over all regions -------------------------------------------------------

  DO ireg=1,pglobal%nRegions
    IF ( regions(ireg)%procid==pglobal%myProcid .AND. &   ! region active and
         regions(ireg)%active==active           .AND. &   ! on my processor
         pglobal%plagUsed ) THEN                          ! and particles used
 
      ilev   = regions(ireg)%currLevel
      icount = 0

! - set pointer ---------------------------------------------------------------

      pplag => regions(ireg)%levels(ilev)%plag



! - get dimensions ------------------------------------------------------------

      ndimplag = regions(ireg)%plagInput%nPclsMax
      ncont    = regions(ireg)%plagInput%nCont
      naiv     = pplag%nAiv
      narv     = pplag%nArv
      ncv      = pplag%nCv
      ndv      = pplag%nDv
      ncvtile  = cv_tile_last+ncont
      ndvtile  = dv_tile_last

! - surface data for tile infrastructure --------------------------------------

      DO ipatch=1,regions(ireg)%nPatches
        ppatch => regions(ireg)%levels(ilev)%patches(ipatch)
        bctype =  ppatch%bcType

        IF ( ppatch%bcCoupled == bc_external   .AND.                      &
             ( bctype>=bc_injection .AND. bctype<=bc_injection+bc_range ) ) THEN
          icount  = icount + 1
          pid     = ireg*regoff + icount

          ptileplag   => ppatch%tilePlag
          pcvtilemass => ptileplag%cvTileMass

! -- output tile data ---------------------------------------------------------

          ilb = lbound(ptileplag%cv,2)
          CALL com_set_array( trim(wins)//'.plag_momnrm',pid, &
                              ptileplag%cv(cv_tile_momnrm,ilb),ncvtile)
          CALL com_set_array( trim(wins)//'.plag_ener',  pid, &
                              ptileplag%cv(cv_tile_ener,ilb),ncvtile)

          DO icont = 1, ncont
            CALL com_set_array( trim(wins)//'.plag_mass'//char(icont+ascii_zero),&
                                pid, ptileplag%cv(pcvtilemass(icont),ilb),ncvtile)
          ENDDO ! iCont

          ilb = lbound(ptileplag%dv,2)
          CALL com_set_array( trim(wins)//'.plag_dv_timefctr',  &
                              pid, ptileplag%dv(dv_tile_countdown,ilb),ndvtile)
          CALL com_set_array( trim(wins)//'.plag_dv_diam',  &
                              pid, ptileplag%dv(dv_tile_diam    ,ilb),ndvtile)
          CALL com_set_array( trim(wins)//'.plag_dv_spload',    &
                              pid, ptileplag%dv(dv_tile_spload  ,ilb),ndvtile)

        ENDIF   ! external BC
      ENDDO     ! iPatch

! -- volume data --------------------------------------------------------------

! -- create PLAG pane data ----------------------------------------------------

      pid = ireg*regoff+1

! Obtain status
      plagstatus = com_get_status( trim(inplag),pid )
      
! Obtain the number of particles
! check if status is inexistent first.

      IF ( plagstatus == -1 ) THEN
#ifndef NATIVE_MP_IO
        pplag%nPcls = 0
#endif
      ELSE 
        CALL com_get_size( trim(inplag)//'.nc',pid,pplag%nPcls)
      END IF ! plagStatus

! COM_set_size procedure must be called in RFLO_sendBoundaryValues
! if nPcls has changed.

      CALL com_set_size( trim(winp)//'.nc',pid,pplag%nPcls)

! COM_set_array on '.nc' processes all three components at once
      ilb = lbound(pplag%cv,2)
      CALL com_set_array( trim(winp)//'.nc',pid, &
                          pplag%cv(cv_plag_xpos,ilb),ncv,ndimplag )

      pint => pplag%nextIdNumber
      CALL com_set_size( trim(winp)//'.plag_nextid',pid,1)
      CALL com_set_array( trim(winp)//'.plag_nextid', pid, pint)

! -- aiv data -----------------------------------------------------------------

      ilb = lbound(pplag%aiv,2)
      CALL com_set_array( trim(winp)//'.plag_aiv_pidini',pid,          &
                          pplag%aiv(aiv_plag_pidini,ilb),naiv,ndimplag )
      CALL com_set_array( trim(winp)//'.plag_aiv_regini',pid,          &
                          pplag%aiv(aiv_plag_regini,ilb),naiv,ndimplag )
      CALL com_set_array( trim(winp)//'.plag_aiv_regcrt',pid,          &
                          pplag%aiv(aiv_plag_regcrt,ilb),naiv,ndimplag )
      CALL com_set_array( trim(winp)//'.plag_aiv_icells',pid,          &
                          pplag%aiv(aiv_plag_icells,ilb),naiv,ndimplag )
      CALL com_set_array( trim(winp)//'.plag_aiv_indexi',pid,          &
                          pplag%aiv(aiv_plag_indexi,ilb),naiv,ndimplag )
      CALL com_set_array( trim(winp)//'.plag_aiv_indexj',pid,          &
                          pplag%aiv(aiv_plag_indexj,ilb),naiv,ndimplag )
      CALL com_set_array( trim(winp)//'.plag_aiv_indexk',pid,          &
                          pplag%aiv(aiv_plag_indexk,ilb),naiv,ndimplag )
      CALL com_set_array( trim(winp)//'.plag_aiv_burnstat',pid,          &
                          pplag%aiv(aiv_plag_burnstat,ilb),naiv,ndimplag )

! -- arv data -----------------------------------------------------------------

      ilb = lbound(pplag%arv,2)
      CALL com_set_array( trim(winp)//'.plag_arv_spload',pid,          &
                          pplag%arv(arv_plag_spload,ilb),narv,ndimplag )

! -- cv data ------------------------------------------------------------------

      ilb = lbound(pplag%cv,2)
      CALL com_set_array( trim(winp)//'.plag_xmom',pid,           &
                          pplag%cv(cv_plag_xmom,ilb),ncv,ndimplag )
      CALL com_set_array( trim(winp)//'.plag_ymom',pid,           &
                          pplag%cv(cv_plag_ymom,ilb),ncv,ndimplag )
      CALL com_set_array( trim(winp)//'.plag_zmom',pid,           &
                          pplag%cv(cv_plag_zmom,ilb),ncv,ndimplag )
      CALL com_set_array( trim(winp)//'.plag_ener',pid,           &
                          pplag%cv(cv_plag_ener,ilb),ncv,ndimplag )
      CALL com_set_array( trim(winp)//'.plag_enervapor',pid,           &
                          pplag%cv(cv_plag_enervapor,ilb),ncv,ndimplag )
      DO icont = 1, ncont
        CALL com_set_array( trim(winp)//'.plag_mass'//char(icont+ascii_zero),  &
                            pid, pplag%cv(cv_plag_last+icont,ilb),ncv,ndimplag )
      ENDDO ! iCont

! -- dv data (for plotting) ---------------------------------------------------

      ilb = lbound(pplag%dv,2)
      CALL com_set_array( trim(winp)//'.plag_diam',pid,           &
                          pplag%dv(dv_plag_diam,ilb),ndv,ndimplag )

    ENDIF      ! region on this processor and active

  ENDDO        ! iReg

  CALL com_window_init_done( trim(winp))

#ifndef NATIVE_MP_IO
  CALL com_call_function( obtain_attribute,2, &
                          com_get_attribute_handle_const(trim(inplag)//".all"), &
                          com_get_attribute_handle(trim(winp)//".all") )
#endif

! finalize --------------------------------------------------------------------

  CALL deregisterfunction( pglobal )

END SUBROUTINE plag_initgenxinterface

!******************************************************************************
!
! RCS Revision history:
!
! $Log: PLAG_InitGenxInterface.F90,v $
! Revision 1.5  2009/10/26 00:19:31  mtcampbe
! Updates for completion of NATIVE_MP_IO
!
! Revision 1.4  2008/12/06 08:44:00  mtcampbe
! Updated license.
!
! Revision 1.3  2008/11/19 22:17:14  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.2  2007/03/13 18:54:19  fnajjar
! Fixed bug to change nPclsTot to nPclsMax
!
! Revision 1.1  2004/12/01 21:23:44  haselbac
! Initial revision after changing case
!
! Revision 1.14  2004/11/05 22:29:31  fnajjar
! Included a COM_get_status call before calling COM_get_size
!
! Revision 1.13  2004/11/05 19:12:06  fnajjar
! Deleted REGOFF definition since it now resides in ModParameters
!
! Revision 1.12  2004/10/03 03:04:46  fnajjar
! Bug fix for attribute surface variable changed to plag_dv_diam
!
! Revision 1.11  2004/07/02 22:05:56  fnajjar
! Modified routine for Roccom3 import
!
! Revision 1.10  2004/06/16 23:08:48  fnajjar
! Renamed DV_TILE_TIMEFCTR to DV_TILE_COUNTDOWN for CRE kernel
!
! Revision 1.9  2004/05/12 14:13:29  fnajjar
! Added missing array entries for aiv and cv to Genx IO
!
! Revision 1.8  2004/03/16 21:24:51  fnajjar
! Bug fix for plagUsed as it needs to use pGlobal pointer rather than global pointer
!
! Revision 1.7  2004/03/05 22:08:58  jferry
! created global variables for peul, plag, and inrt use
!
! Revision 1.6  2004/03/05 16:27:18  fnajjar
! Added dv(diam) and dv(spload) from tile datastructure to insure proper restart
!
! Revision 1.5  2004/01/21 16:37:20  fnajjar
! Fixed semantics of iCont in Roccom window to bypass Frost compilation error
!
! Revision 1.4  2004/01/20 23:22:48  fnajjar
! Fixed CHAR operation in RocCom window naming to correct Frost compilation error
!
! Revision 1.3  2003/12/03 03:02:07  jiao
! Removed all calls involving COM_NULL.
!
! Revision 1.2  2003/11/26 22:04:12  fnajjar
! Defined nDvTile correctly for Roccom restart
!
! Revision 1.1  2003/11/21 22:21:42  fnajjar
! Initial import of Rocpart GenX interfaces
!
!******************************************************************************