PLAG_ReadStatPost.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: Read in time averaged statistics of the Lagrangian particles 
!          on Eulerian grid.
!
! Description: the following solution formats are supported:
!              - RocfloMP ASCII
!              - RocfloMP binary
!
! Input: regions = dimensions of all regions
!
! Output: region%levels%plag%tav = time avg Lagrangian particle variables
!         global%integrTime      = integrated averaging time
!
! Notes: time averaged solution is read in only for the current grid level;
!        it is also read in for all dummy cells
!
! ******************************************************************************
!
! $Id: PLAG_ReadStatPost.F90,v 1.3 2008/12/06 08:45:07 mtcampbe Exp $
!
! Copyright: (c) 2005 by the University of Illinois
!
! ******************************************************************************

SUBROUTINE plag_readstatpost(regions,iReg)

  USE modparameters
  USE moddatatypes  
  USE modglobal, ONLY: t_global
  USE modpartlag, ONLY: t_buffer_plag
  USE modbndpatch, ONLY: t_patch
  USE modgrid, ONLY: t_grid
  USE modpartlag, ONLY: t_plag 
  USE moddatastruct, ONLY: t_region
  USE moderror
  USE modmpi
  USE plag_modparameters

#include "Indexing.h" 
  USE modindexing,   ONLY: indijkmap
  USE modinterfaces, ONLY: rflo_getcelloffset,     &
                           rflo_getdimensdummy,    &
                           rflo_getpatchindices,   &
                           rflo_getpatchdirection, &
                           rflo_getpatchmapping,   &
                           rflo_readdatafileint,   &
                           rflo_readdatafilereal,  &
                           rflo_writedatafileint,  &
                           rflo_writedatafilereal

  IMPLICIT NONE
        
! ******************************************************************************
!   Declarations and definitions
! ******************************************************************************
    
! ==============================================================================
!   Arguments
! ==============================================================================
     
    TYPE(t_region), POINTER :: regions(:)  
    INTEGER, INTENT(IN) :: ireg
 
! ==============================================================================
!   Locals
! ==============================================================================

  CHARACTER(2*CHRLEN+17) :: fname
  CHARACTER(CHRLEN)      :: msg

  INTEGER :: i, j, k, l, n, ind

#ifdef MPI
  INTEGER :: status(mpi_status_size)
#endif
  INTEGER :: ilev,iregfile,ipc,jpc,kpc,ndumcells,ndim,ioff,ijoff,ijk
  INTEGER :: idcbeg,jdcbeg,kdcbeg,idcend,jdcend,kdcend,ijkbeg,ijkend
  INTEGER :: errorflag,ntav,ntavvar

  INTEGER, ALLOCATABLE, DIMENSION (:,:) :: ivar,jvar,plagvarid

  REAL(RFREAL), POINTER, DIMENSION(:,:)     :: tav
  REAL(RFREAL), ALLOCATABLE, DIMENSION(:,:) :: rvar, tavfile

  TYPE(t_global), POINTER :: global

! ******************************************************************************
!   Start, set pointers and variables
! ******************************************************************************

    global => regions(ireg)%global

    CALL registerfunction( global,'PLAG_RFLO_ReadStatPost',&
  'PLAG_ReadStatPost.F90' )

! ******************************************************************************
!   Allocate temporary data arrays 
! ******************************************************************************

    ALLOCATE( ivar(5,1),stat=errorflag )
    global%error = errorflag
    IF ( global%error /= err_none ) &
      CALL errorstop( global,err_allocate,__line__,'ivar' )
    
    ALLOCATE( rvar(2,1),stat=errorflag )
    global%error = errorflag
    IF ( global%error /= err_none ) &
      CALL errorstop( global,err_allocate,__line__,'rvar' )
    
    ALLOCATE( jvar(global%plagNStat+1,1),stat=errorflag )
    global%error = errorflag
    IF ( global%error /= err_none ) &
      CALL errorstop( global,err_allocate,__line__,'jvar' ) 
    
    ALLOCATE( plagvarid(2,global%plagNStat+1),stat=errorflag )
    global%error = errorflag
    IF ( global%error /= err_none ) &
      CALL errorstop( global,err_allocate,__line__,'plagVarId' ) 

! ******************************************************************************
!   Open statistics file (only if iReg=1.)
! ******************************************************************************

    IF (ireg == 1) THEN

      SELECT CASE( global%solutFormat )
        CASE ( format_ascii )
          WRITE(fname,'(A,1PE11.5)') &
            trim(global%inDir)//trim(global%casename)//'.plag_stata_', &
            global%timeStamp
          OPEN( if_plag_stats,file=fname,form='formatted',status='old', &
                iostat=errorflag )
      
        CASE ( format_binary )
          WRITE(fname,'(A,1PE11.5)') &
            trim(global%inDir)//trim(global%casename)//'.plag_stat_', &
            global%timeStamp
          OPEN( if_plag_stats,file=fname,form='unformatted',status='old', &
                iostat=errorflag )

        CASE default
          CALL errorstop( global,err_reached_default,__line__ )

      END SELECT ! solutFormat 

    global%error = errorflag
    IF ( global%error /= err_none ) &
      CALL errorstop( global,err_file_open,__line__,'File: '//trim(fname) )

    ENDIF ! iReg

! ******************************************************************************
!   Read current and integrated time in file, and stats ID (only if iReg=1)
! ******************************************************************************

    IF ( ireg == 1 ) THEN
      CALL rflo_readdatafilereal( global,if_plag_stats,global%solutFormat,2,1,rvar )
      
       global%integrTime = rvar(2,1) 

! ==============================================================================
!   Trap error for inconsistent variables in header 
! ==============================================================================
    
      IF ( global%flowType==flow_unsteady .AND. global%currentTime>0._rfreal ) THEN
        IF (abs(global%currentTime-rvar(1,1))/global%currentTime > 1.0e-03_rfreal) THEN
          WRITE(msg,1000) rvar(1,1),global%currentTime
          CALL errorstop( global,err_time_solution,__line__,msg//' File: '//trim(fname) )
        ENDIF ! currentTime
      ENDIF ! global%flowType

    print*,' PLAG_ReadStatPost: integrTime, currentime = ',global%integrTime,global%currentTime,rvar(1,1)

    ENDIF ! iReg

! ******************************************************************************
!   Read plagNStat and plagStatId from file
! ******************************************************************************
    
    IF ( ireg == 1 ) THEN
      IF (global%plagNStat > 0) THEN
        CALL rflo_readdatafileint( global,if_plag_stats,global%solutFormat, &
                                   global%plagNStat+1,1,jvar )
        ntavvar  = jvar(1,1)
        IF ( ntavvar /= global%plagNStat ) THEN
         CALL errorstop( global,err_stats_restart,__line__ )
        END IF ! nTavVar

        plagvarid(1,:) = jvar(2:global%plagNStat+1,1)
        plagvarid(2,:) = mod(plagvarid(1,:),10)
        plagvarid(1,:) = (plagvarid(1,:)-plagvarid(2,:))/10

        DO ind=1,2
        DO l=1,global%plagNStat
          IF ( plagvarid(ind,l) /= global%plagStatId(ind,l) ) &
            CALL errorstop( global,err_stats_restart,__line__ )
        END DO ! l
        END DO ! ind
      ENDIF ! plagNStat

    ENDIF ! iReg
      
! ******************************************************************************
!   Read statistics data from all regions 
! ******************************************************************************

! ==============================================================================
!     Get dimensions and pointers
! ==============================================================================

      ilev = regions(ireg)%currLevel
      CALL rflo_getdimensdummy( regions(ireg),ilev,idcbeg,idcend, &
                                jdcbeg,jdcend,kdcbeg,kdcend )
      CALL rflo_getcelloffset( regions(ireg),ilev,ioff,ijoff )
      ijkbeg = indijk(idcbeg,jdcbeg,kdcbeg,ioff,ijoff)
      ijkend = indijk(idcend,jdcend,kdcend,ioff,ijoff)
      ndim   = ijkend - ijkbeg + 1

      ntav = global%plagNStat

! ==============================================================================
!     Read region number and dimensions 
! ==============================================================================

      CALL rflo_readdatafileint( global,if_plag_stats,global%solutFormat,5,1,ivar )
      iregfile  = ivar(1,1)
      ipc       = ivar(2,1)
      jpc       = ivar(3,1)
      kpc       = ivar(4,1)
      ndumcells = ivar(5,1)
      
      IF (iregfile /= ireg) &
        CALL errorstop( global,err_region_number,__line__,'File: '//trim(fname) )
        
      IF ( (ipc /= regions(ireg)%levels(ilev)%grid%ipc) .OR. &
           (jpc /= regions(ireg)%levels(ilev)%grid%jpc) .OR. &
           (kpc /= regions(ireg)%levels(ilev)%grid%kpc)      ) THEN
        WRITE(msg,1005) ireg,ipc,jpc,kpc
        CALL errorstop( global,err_grid_dimensions,__line__,msg )
      ENDIF ! ipc

      IF ( ndumcells /= regions(ireg)%nDumCells ) THEN
        WRITE(msg,1010) ireg,ndumcells,regions(ireg)%nDumCells
        CALL errorstop( global,err_grid_dumcells,__line__,msg )
      ENDIF ! nDumCells

! ==============================================================================
!     read data
! ==============================================================================

      ALLOCATE( tavfile(ntav,ndim),stat=errorflag )
      global%error = errorflag
      IF ( global%error /= err_none ) &
        CALL errorstop( global,err_allocate,__line__ )

      CALL rflo_readdatafilereal( global,if_plag_stats,global%solutFormat, &
                                  ntav,ndim,tavfile )

! ==============================================================================
!    Copy statistics into data structure
! ==============================================================================
     
      IF ( ntav > 0 ) tav => regions(ireg)%levels(ilev)%plag%tav

      n = 0
      DO k=kdcbeg,kdcend
      DO j=jdcbeg,jdcend
      DO i=idcbeg,idcend
        n   = n + 1
        ijk = indijk(i,j,k,ioff,ijoff)
        DO l=1,ntav
          tav(l,ijk) = tavfile(l,n)
        ENDDO ! l
      ENDDO ! i
      ENDDO ! j
      ENDDO ! k

! ==============================================================================
!     Deallocate local array
! ==============================================================================

      IF ( ALLOCATED(tavfile) ) THEN
        DEALLOCATE( tavfile,stat=errorflag )
        global%error = errorflag
        IF ( global%error /= err_none ) &
          CALL errorstop( global,err_deallocate,__line__,'tavFile' )
      ENDIF ! tavFile

! ******************************************************************************
!   Deallocate temporary data arrays 
! ******************************************************************************

    DEALLOCATE( ivar,stat=errorflag )
    global%error = errorflag
    IF ( global%error /= err_none ) &
      CALL errorstop( global,err_deallocate,__line__,'ivar' )
    
    DEALLOCATE( rvar,stat=errorflag )
    global%error = errorflag
    IF ( global%error /= err_none ) &
      CALL errorstop( global,err_deallocate,__line__,'rvar' )
    
    DEALLOCATE( jvar,stat=errorflag )
    global%error = errorflag
    IF ( global%error /= err_none ) &
      CALL errorstop( global,err_deallocate,__line__,'jvar' )
    
    DEALLOCATE( plagvarid,stat=errorflag )
    global%error = errorflag
    IF ( global%error /= err_none ) &
      CALL errorstop( global,err_deallocate,__line__,'plagVarId' )

! ******************************************************************************
!   Finalize
! ******************************************************************************

    IF ( ireg == global%nRegions ) THEN
      CLOSE(if_plag_stats,iostat=errorflag)
      global%error = errorflag
      IF ( global%error /= err_none ) &
        CALL errorstop( global,err_file_close,__line__,'File: '//trim(fname) )
    ENDIF ! iReg

! ******************************************************************************
!   End  
! ******************************************************************************

    CALL deregisterfunction( global )

! ******************************************************************************
!   Formats 
! ******************************************************************************

1000 FORMAT('Time in file is= ',1pe12.5,' but it should be= ',e12.5,'.')
1005 FORMAT('Region ',i5,', ipc= ',i6,', jpc= ',i6,', kpc= ',i6,'.')
1010 FORMAT('Region ',i5,', # dummy cells=',i2,' but should be= ',i1)
2000 FORMAT('Integration Time in file is= ',1pe12.5,' but it should be= ',e12.5,'.')

END SUBROUTINE plag_readstatpost

! ******************************************************************************
!
! RCS Revision history:
!
! $Log: PLAG_ReadStatPost.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  2005/02/16 14:52:40  fnajjar
! Initial import
!
! ******************************************************************************