PLAG_ModStats.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: Collection of routines for particle statistics on Eulerian grid.
!
! Description: None.
!
! Notes: None. 
!
! ******************************************************************************
!
! $Id: PLAG_ModStats.F90,v 1.4 2008/12/06 08:44:34 mtcampbe Exp $
!
! Copyright: (c) 2005 by the University of Illinois
!
! ******************************************************************************

MODULE plag_modstats

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

#ifdef RFLO
#include "Indexing.h"  
  USE modinterfaces, ONLY: rflo_getcelloffset, &
                           rflo_getdimensdummy
#endif
  
  USE plag_modeulerian, ONLY: plag_calceulerianfield
 
  IMPLICIT NONE
  
! ******************************************************************************
! Definitions and declarations
! ******************************************************************************

! ==============================================================================
! Private data
! ==============================================================================

  CHARACTER(CHRLEN), PRIVATE :: & 
    RCSIdentString = '$RCSfile: PLAG_ModStats.F90,v $ $Revision: 1.4 $'        

! ==============================================================================
! Public functions
! ==============================================================================
  
  PUBLIC :: plag_createstat,  & 
            plag_destroystat, & 
            plag_initstat

! ==============================================================================
! Private functions
! ==============================================================================

!  PRIVATE :: 

! ******************************************************************************
! Routines
! ******************************************************************************

  CONTAINS
  
  
  
  
  
  
  
  
  
  

  





! *******************************************************************************
!
! Purpose: Create statistics.
!
! Description: None.
!
! Input:
!   pRegion             Pointer to region
!   pPlag               Pointer to plag
!
! Output: None.
!
! Notes: None.
!
! ******************************************************************************

  SUBROUTINE plag_createstat(pRegion,pPlag)

    IMPLICIT NONE
        
! ******************************************************************************
!   Declarations and definitions
! ******************************************************************************
    
! ==============================================================================
!   Arguments
! ==============================================================================
    
#ifdef RFLO
    TYPE(t_region) :: pregion 
#endif

#ifdef RFLU
    TYPE(t_region), POINTER :: pregion
#endif

    TYPE(t_plag), POINTER :: pplag

! ==============================================================================
!   Locals
! ==============================================================================

#ifdef RFLO
    INTEGER :: idcbeg, idcend, jdcbeg, jdcend, kdcbeg, kdcend  
    INTEGER :: ilev,icelloffset, ijcelloffset   
#endif

    INTEGER :: errorflag,ibc,iec,ntav
    TYPE(t_global), POINTER :: global
    TYPE(t_grid), POINTER :: pgrid
    
! ******************************************************************************
!   Start, set pointers and variables
! ******************************************************************************
    
    global => pregion%global
    
    CALL registerfunction(global,'PLAG_CreateStat',&
  'PLAG_ModStats.F90')

    ntav =global%plagNStat     

#ifdef RFLO
    ilev  = pregion%currLevel
    pgrid => pregion%levels(ilev)%grid

    CALL rflo_getdimensdummy( pregion,ilev,idcbeg,idcend, &
                              jdcbeg,jdcend,kdcbeg,kdcend )
    CALL rflo_getcelloffset( pregion,ilev,icelloffset,ijcelloffset )
    ibc = indijk(idcbeg,jdcbeg,kdcbeg,icelloffset,ijcelloffset)
    iec = indijk(idcend,jdcend,kdcend,icelloffset,ijcelloffset)
#endif

#ifdef RFLU
    pgrid => pregion%grid
    ibc = 1
    iec = pgrid%nCells
#endif
  
! ******************************************************************************
!   Allocate memory
! ******************************************************************************

    ALLOCATE(pplag%tav(ntav,ibc:iec),stat=errorflag)
    global%error = errorflag
    IF ( global%error /= err_none ) THEN 
      CALL errorstop(global,err_allocate,__line__,'pPlag%tav')
    END IF ! global%error 

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

    CALL deregisterfunction(global)

  END SUBROUTINE plag_createstat 






! *******************************************************************************
!
! Purpose: Destroy statistics.
!
! Description: None.
!
! Input:
!   pRegion             Pointer to region
!   pPlag               Pointer to plag
!
! Output: None.
!
! Notes: None.
!
! ******************************************************************************

  SUBROUTINE plag_destroystat(pRegion,pPlag)

    IMPLICIT NONE
        
! ******************************************************************************
!   Declarations and definitions
! ******************************************************************************
    
! ==============================================================================
!   Arguments
! ==============================================================================
    
#ifdef RFLO
    TYPE(t_region) :: pregion 
#endif

#ifdef RFLU
    TYPE(t_region), POINTER :: pregion
#endif

    TYPE(t_plag), POINTER :: pplag
    
! ==============================================================================
!   Locals
! ==============================================================================
    
    INTEGER :: errorflag
    TYPE(t_global), POINTER :: global    

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

    global => pregion%global
    
    CALL registerfunction(global,'PLAG_DestroyStat',&
  'PLAG_ModStats.F90')

! ******************************************************************************
!   Deallocate memory
! ******************************************************************************

    DEALLOCATE(pplag%tav,stat=errorflag)
    global%error = errorflag
    IF ( global%error /= err_none ) THEN 
      CALL errorstop(global,err_deallocate,__line__,'pPlag%tav')
    END IF ! global%error
  
! ******************************************************************************
!   Nullify memory
! ******************************************************************************

    nullify(pplag%tav)
 
! ******************************************************************************
!   End  
! ******************************************************************************

    CALL deregisterfunction(global)

  END SUBROUTINE plag_destroystat  





! *******************************************************************************
!
! Purpose: Initialize statistics.
!
! Description: None.
!
! Input:
!   pRegion             Pointer to region
!   pPlag               Pointer to plag
!
! Output: None.
!
! Notes: None.
!
! ******************************************************************************

  SUBROUTINE plag_initstat(pRegion,pPlag)

    IMPLICIT NONE
        
! ******************************************************************************
!   Declarations and definitions
! ******************************************************************************
    
! ==============================================================================
!   Arguments
! ==============================================================================
     
#ifdef RFLO
    TYPE(t_region) :: pregion
#endif

#ifdef RFLU
    TYPE(t_region), POINTER :: pregion
#endif

    TYPE(t_plag), POINTER :: pplag
  
! ==============================================================================
!   Locals
! ==============================================================================

#ifdef RFLO
    INTEGER :: idcbeg, idcend, jdcbeg, jdcend, kdcbeg, kdcend  
    INTEGER :: ilev,icelloffset, ijcelloffset   
#endif

    INTEGER :: errorflag,ibc,iec,icell,ivar,nvars
    TYPE(t_global), POINTER :: global
    TYPE(t_grid), POINTER :: pgrid

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

    global => pregion%global
 
    CALL registerfunction(global,'PLAG_InitStat',&
  'PLAG_ModStats.F90')

    nvars = global%plagNStat      

#ifdef RFLO
    ilev  = pregion%currLevel
    pgrid => pregion%levels(ilev)%grid

    CALL rflo_getdimensdummy( pregion,ilev,idcbeg,idcend, &
                              jdcbeg,jdcend,kdcbeg,kdcend )
    CALL rflo_getcelloffset( pregion,ilev,icelloffset,ijcelloffset )
    ibc = indijk(idcbeg,jdcbeg,kdcbeg,icelloffset,ijcelloffset)
    iec = indijk(idcend,jdcend,kdcend,icelloffset,ijcelloffset)
#endif

#ifdef RFLU
    pgrid => pregion%grid
    ibc = 1
    iec = pgrid%nCells
#endif

! ******************************************************************************
!   Initialize memory
! ******************************************************************************
        
    DO icell = ibc,iec
      DO ivar = 1, nvars
        pplag%tav(ivar,icell) = 0.0_rfreal
      END DO ! iVar                  
    END DO ! iCell                      

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

    CALL deregisterfunction(global)

  END SUBROUTINE plag_initstat








END MODULE plag_modstats

! ******************************************************************************
!
! RCS Revision history:
!
! $Log: PLAG_ModStats.F90,v $
! Revision 1.4  2008/12/06 08:44:34  mtcampbe
! Updated license.
!
! Revision 1.3  2008/11/19 22:17:47  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.2  2006/04/07 15:19:23  haselbac
! Removed tabs
!
! Revision 1.1  2005/01/08 20:44:32  fnajjar
! Initial import for PLAG statistics
!
! ******************************************************************************