PLAG_BinSortSpatialDist.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: sort particle entering nozzle by bins.
!
! Description: none.
!
! Input: iReg    = region number
!        iLev    = current level
!        region  = region data (dimensions, plag variables)
!        iRegBin = region number to bin
!
! Output: to plot file.
!
! Notes: none.
!
!******************************************************************************
!
! $Id: PLAG_BinSortSpatialDist.F90,v 1.3 2008/12/06 08:45:07 mtcampbe Exp $
!
! Copyright: (c) 2004 by the University of Illinois
!
!******************************************************************************

SUBROUTINE plag_binsortspatialdist ( iReg, iLev, region, iRegBin )

  USE moddatatypes
  USE moderror
  USE modpartlag, ONLY    : t_plag, t_plag_input
  USE moddatastruct, ONLY : t_region
  USE modglobal, ONLY     : t_global

  USE modmpi
  USE modparameters
  USE plag_modparameters
  IMPLICIT NONE

! ... parameters
  INTEGER :: ireg, ilev, iregbin

  TYPE(t_region) :: region

! ... loop variables
  INTEGER :: i,j

! ... local variables
  CHARACTER(CHRLEN)   :: rcsidentstring
  CHARACTER(CHRLEN+4) :: fname

  INTEGER :: errorflag, ndimplag
  INTEGER :: pidini,regini,icell,indexi,indexj,indexk
  INTEGER :: ibin,nbins
  INTEGER :: icontal,icontalox
  INTEGER, POINTER :: cvmass(:)
  INTEGER, POINTER :: aiv(:,:)
  INTEGER, DIMENSION(0:500) :: sizebin

  REAL(RFREAL)          :: diammicron,deltay,xposplag,yposplag,yposplagshift
  REAL(RFREAL)          :: massl,yheight,yheightchan,yheightnozz,yheightmin
  REAL(RFREAL)          :: xminrange
  REAL(RFREAL), DIMENSION(0:500) :: compalbin,compaloxbin,diam32bin,diam43bin,&
                                    diam2bin,diam3bin,diam4bin,massalbin,     &
                                    massaloxbin,masstotbin,uvelbin,vvelbin,   &
                                    volbin,wvelbin,xmombin,ybin,ymombin,zmombin
  REAL(RFREAL), POINTER :: cv(:,:), dv(:,:)

  TYPE(t_global), POINTER :: global

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

  rcsidentstring = '$RCSfile: PLAG_BinSortSpatialDist.F90,v $ $Revision: 1.3 $'

  global => region%global

  CALL registerfunction( global,'PLAG_BinSortSpatialDist', 'PLAG_BinSortSpatialDist.F90' )

! set parameters --------------------------------------------------------------

  ndimplag = region%levels(ilev)%plag%nPcls
 
  sizebin(0:500) = 0
  diam2bin(0:500) = 0.0_rfreal
  diam3bin(0:500) = 0.0_rfreal
  diam4bin(0:500) = 0.0_rfreal
  diam32bin(0:500) = 0.0_rfreal
  diam43bin(0:500) = 0.0_rfreal

  nbins=20
  
  icontal   = 1
  icontalox = 2  
  compalbin(0:500)   = 0.0_rfreal
  compaloxbin(0:500) = 0.0_rfreal
  
  massalbin(0:500)   = 0.0_rfreal
  massaloxbin(0:500) = 0.0_rfreal
  masstotbin(0:500)  = 0.0_rfreal
  volbin(0:500)      = 0.0_rfreal
  
  uvelbin(0:500) = 0.0_rfreal
  vvelbin(0:500) = 0.0_rfreal
  wvelbin(0:500) = 0.0_rfreal

  xmombin(0:500) = 0.0_rfreal
  ymombin(0:500) = 0.0_rfreal
  zmombin(0:500) = 0.0_rfreal

  IF (ireg /= iregbin) goto 1999
  
  print*,'PLAG_BinSortSpatialDist: iRegBin, nDimPlag = ',iregbin,ndimplag

! set values ------------------------------------------------------------------

! TEMPORARY: Data Pertinent to c1

  yheightchan = 0.09_rfreal
  yheightnozz = 0.0481267_rfreal
  
  SELECT CASE (iregbin)
    CASE(41)
      yheight = yheightchan
      yheightmin = 0.0_rfreal
      xminrange  = 0.0_rfreal

    CASE(52)
      yheight = yheightnozz
      yheightmin = 0.0209367_rfreal
      xminrange = 0.465_rfreal

    CASE default
      yheight = 1.0_rfreal
  END SELECT ! iRegBin
 
  deltay = yheight/REAL(nbins,kind=rfreal)
  ybin(1) = yheightmin
  
  DO i = 2, nbins+1
    ybin(i) = ybin(i-1) +deltay
  END DO ! i

! set pointers ----------------------------------------------------------------

  aiv => region%levels(ilev)%plag%aiv
  cv  => region%levels(ilev)%plag%cv
  dv  => region%levels(ilev)%plag%dv
  cvmass  => region%levels(ilev)%plag%cvPlagMass

! determine size ---------------------------------------------------------------

  DO i = 1, ndimplag
    xposplag = cv(cv_plag_xpos,i)
    
    IF ( xposplag >= xminrange ) THEN
      yposplag = cv(cv_plag_ypos,i)
      yposplagshift = yposplag -yheightmin
    
      ibin=nint(yposplagshift/deltay)
      sizebin(ibin) = sizebin(ibin)+1
    
      diammicron = dv(dv_plag_diam,i)*1.0e+06_rfreal
      massl = sum( cv(cvmass(:),i) )    
    
      massalbin(ibin)   = massalbin(ibin) +cv(cvmass(icontal),i)
      massaloxbin(ibin) = massaloxbin(ibin) +cv(cvmass(icontalox),i)
      masstotbin(ibin)  = masstotbin(ibin) +massl
      diam2bin(ibin)    = diam2bin(ibin) +diammicron**2
      diam3bin(ibin)    = diam3bin(ibin) +diammicron**3
      diam4bin(ibin)    = diam4bin(ibin) +diammicron**4

      xmombin(ibin) = xmombin(ibin) +cv(cv_plag_xmom,i)
      ymombin(ibin) = ymombin(ibin) +cv(cv_plag_ymom,i)
      zmombin(ibin) = zmombin(ibin) +cv(cv_plag_zmom,i)
    ENDIF ! xPosPlag
  ENDDO ! i 

  DO ibin = 1, nbins
    IF ( sizebin(ibin) > 0 ) THEN
      compalbin(ibin)   = massalbin(ibin)/masstotbin(ibin)
      compaloxbin(ibin) = massaloxbin(ibin)/masstotbin(ibin)

      diam43bin(ibin) = diam4bin(ibin)/diam3bin(ibin)
      diam32bin(ibin) = diam3bin(ibin)/diam2bin(ibin)

      uvelbin(ibin) = xmombin(ibin)/masstotbin(ibin)
      vvelbin(ibin) = ymombin(ibin)/masstotbin(ibin)
      wvelbin(ibin) = zmombin(ibin)/masstotbin(ibin)
    END IF ! sizeBin
  ENDDO ! iBin

! open file and write the header ----------------------------------------------

  WRITE(fname,'(A,I2,A,1PE11.5,A)') &
   trim(global%casename)//'.plag_ydist_bin_reg_',iregbin,'_',global%currentTime,'.dat'
  OPEN(if_plot,file=fname,status='unknown',form='formatted',iostat=errorflag)
  global%error = errorflag
  IF (global%error /= 0) CALL errorstop( global,err_file_open,__line__,fname )

  IF (global%currentTime <= 0._rfreal) THEN
    WRITE(if_plot,1005,err=10) trim(global%casename),global%timeStamp
  ELSE
    WRITE(if_plot,1005,err=10) trim(global%casename),global%currentTime
  ENDIF

  WRITE(if_plot,1010,err=10) 'iBin yBin size compAl compAlOx diam32 diam43 u v w'

  WRITE(if_plot,1015) iregbin, nbins

  DO ibin = 1, nbins
    WRITE(if_plot,1020,err=10) ibin,(ybin(ibin)-yheightmin)/yheight,sizebin(ibin),&
                               nint(compalbin(ibin)*100.0_rfreal),&
                               nint(compaloxbin(ibin)*100.0_rfreal), &
                               nint(diam32bin(ibin)),nint(diam43bin(ibin)),&
                               uvelbin(ibin),vvelbin(ibin),wvelbin(ibin)
  ENDDO ! iBin

! close file, handle errors ---------------------------------------------------

  CLOSE(if_plot,iostat=errorflag)
  global%error = errorflag
  IF (global%error /= 0) CALL errorstop( global,err_file_close,__line__,fname )

! open file and write the header for time-averaging ---------------------------

  WRITE(fname,'(A,I2,A,1PE11.5,A)') &
   trim(global%casename)//'.plag_cv_ydist_bin_reg_',iregbin,'_',global%currentTime,'.dat'
  OPEN(if_plot,file=fname,status='unknown',form='formatted',iostat=errorflag)
  global%error = errorflag
  IF (global%error /= 0) CALL errorstop( global,err_file_open,__line__,fname )

  IF (global%currentTime <= 0._rfreal) THEN
    WRITE(if_plot,1005,err=10) trim(global%casename),global%timeStamp
  ELSE
    WRITE(if_plot,1005,err=10) trim(global%casename),global%currentTime
  ENDIF

  WRITE(if_plot,1010,err=10) 'iBin yBin size massAl massAlOxBin massTot diam2 diam3 diam4 xMom yMom zMom '

  WRITE(if_plot,1015) iregbin, nbins

  DO ibin = 1, nbins
    WRITE(if_plot,1030,err=10) ibin,(ybin(ibin)-yheightmin)/yheight,sizebin(ibin),&
                               massalbin(ibin),massaloxbin(ibin),masstotbin(ibin),&
                               diam2bin(ibin),diam3bin(ibin),diam4bin(ibin),&
                               xmombin(ibin),ymombin(ibin),zmombin(ibin)
  ENDDO ! iBin

! close file, handle errors ---------------------------------------------------

  CLOSE(if_plot,iostat=errorflag)
  global%error = errorflag
  IF (global%error /= 0) CALL errorstop( global,err_file_close,__line__,fname )

1999 CONTINUE
  CALL deregisterfunction( global )
  goto 999

10   CONTINUE
  CALL errorstop( global,err_file_write,__line__,fname )

! formats ---------------------------------------------------------------------

1005 FORMAT('TITLE="',a,'. Time: ',1pe11.5,'."')
1010 FORMAT('VARIABLES= ',a)
1015 FORMAT('ZONE T="',i5.5,'", I=',i10,', F=POINT')
1020 FORMAT(1x,i5,1x,1pe12.5,5(1x,i5),3(1x,1pe12.5))
1030 FORMAT(1x,i5,1x,1pe12.5,1x,i5,9(1x,1e23.16))

999  CONTINUE
END SUBROUTINE plag_binsortspatialdist

!******************************************************************************
!
! RCS Revision history:
!
! $Log: PLAG_BinSortSpatialDist.F90,v $
! Revision 1.3  2008/12/06 08:45:07  mtcampbe
! Updated license.
!
! Revision 1.2  2008/11/19 22:18:18  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.1  2004/11/13 22:00:00  fnajjar
! Initial import
!
!******************************************************************************