RFLU_ModBFaceGradAccessList.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: Suite of routines to build boundary-face gradient access list.
!
! Description: None.
!
! Notes: 
!   1. The routine which builds the access lists MUST be called after the face 
!      lists have been built. 
!
!*******************************************************************************
!
! $Id: RFLU_ModBFaceGradAccessList.F90,v 1.7 2008/12/06 08:44:20 mtcampbe Exp $
!
! Copyright: (c) 2003-2004 by the University of Illinois
!
!*******************************************************************************

MODULE rflu_modbfacegradaccesslist

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

  IMPLICIT NONE

  PRIVATE
  PUBLIC :: rflu_nullifybfacegradaccesslist, & 
            rflu_createbfacegradaccesslist, & 
            rflu_buildbfacegradaccesslist, & 
            rflu_destroybfacegradaccesslist
  
! ******************************************************************************
! Declarations and definitions
! ******************************************************************************  
      
  CHARACTER(CHRLEN) :: & 
    RCSIdentString = '$RCSfile: RFLU_ModBFaceGradAccessList.F90,v $ $Revision: 1.7 $' 
              
! *****************************************************************************
! Routines
! *****************************************************************************

  CONTAINS
  


! ******************************************************************************
!   Nullify boundary-face gradient access list
! ******************************************************************************
  
    SUBROUTINE rflu_nullifybfacegradaccesslist(pRegion)

      IMPLICIT NONE

! ******************************************************************************
!     Declarations and definitions
! ******************************************************************************
      
! ==============================================================================
!     Arguments
! ==============================================================================
  
      TYPE(t_region), POINTER :: pregion  
  
! ==============================================================================
!     Locals
! ==============================================================================  

      INTEGER :: errorflag,ipatch
      TYPE(t_grid), POINTER :: pgrid
      TYPE(t_patch), POINTER :: ppatch
      TYPE(t_global), POINTER :: global

! ******************************************************************************
!     Start
! ******************************************************************************      
        
      global => pregion%global  
        
      CALL registerfunction(global,'RFLU_NullifyBFaceGradAccessList',&
  'RFLU_ModBFaceGradAccessList.F90') 
        
      IF ( global%myProcid == masterproc .AND. &
           global%verbLevel > verbose_none ) THEN                 
        WRITE(stdout,'(A,1X,A)') solver_name, &
              'Nullifying boundary-face gradient access list...'
      END IF ! global%verbLevel

! ******************************************************************************
!     Set grid pointer
! ******************************************************************************

      pgrid => pregion%grid     
                
! ******************************************************************************
!     Loop over patches
! ******************************************************************************
          
      DO ipatch = 1,pgrid%nPatches
        ppatch => pregion%patches(ipatch)

! TEMPORARY : removing usage of bf2bg from everywhere
!        NULLIFY(pPatch%bf2bg)
!        NULLIFY(pPatch%bf2bgTot)
      END DO ! iPatch          
        
! ******************************************************************************
!     End
! ******************************************************************************

      IF ( global%myProcid == masterproc .AND. &
           global%verbLevel > verbose_none ) THEN 
        WRITE(stdout,'(A,1X,A)') solver_name, &
              'Nullifying boundary-face gradient access list done.'
      END IF ! global%verbLevel  
  
      CALL deregisterfunction(global)  
  
    END SUBROUTINE rflu_nullifybfacegradaccesslist




! ******************************************************************************
!   Create boundary-face gradient access list
! ******************************************************************************
  
    SUBROUTINE rflu_createbfacegradaccesslist(pRegion)

      IMPLICIT NONE

! ******************************************************************************
!     Declarations and definitions
! ******************************************************************************
      
! ==============================================================================
!     Arguments
! ==============================================================================
  
      TYPE(t_region), POINTER :: pregion  
  
! ==============================================================================
!     Locals
! ==============================================================================  

      INTEGER :: errorflag,ipatch
      TYPE(t_grid), POINTER :: pgrid
      TYPE(t_patch), POINTER :: ppatch
      TYPE(t_global), POINTER :: global

! ******************************************************************************
!     Start
! ******************************************************************************      
        
      global => pregion%global  
        
      CALL registerfunction(global,'RFLU_CreateBFaceGradAccessList',&
  'RFLU_ModBFaceGradAccessList.F90') 
        
      IF ( global%myProcid == masterproc .AND. &
           global%verbLevel > verbose_none ) THEN                 
        WRITE(stdout,'(A,1X,A)') solver_name, &
              'Creating boundary-face gradient access list...'
      END IF ! global%verbLevel

! ******************************************************************************
!     Set grid pointer
! ******************************************************************************

      pgrid => pregion%grid     
                
! ******************************************************************************
!     Loop over patches
! ******************************************************************************
          
      DO ipatch = 1,pgrid%nPatches
        ppatch => pregion%patches(ipatch)

! TEMPORARY : removing usage of bf2bg from everywhere
!        ALLOCATE(pPatch%bf2bg(BF2BG_BEG:BF2BG_END),STAT=errorFlag)
!        global%error = errorFlag   
!        IF ( global%error /= ERR_NONE ) THEN 
!          CALL ErrorStop(global,ERR_ALLOCATE,__LINE__,'pPatch%bf2bg')          
!        END IF ! global%error
        
! TEMPORARY : removing usage of bf2bg from everywhere
!        ALLOCATE(pPatch%bf2bgTot(BF2BG_BEG:BF2BG_END),STAT=errorFlag)
!        global%error = errorFlag   
!        IF ( global%error /= ERR_NONE ) THEN 
!          CALL ErrorStop(global,ERR_ALLOCATE,__LINE__,'pPatch%bf2bgTot')          
!        END IF ! global%error        
      END DO ! iPatch        
        
! ******************************************************************************
!     End
! ******************************************************************************

      IF ( global%myProcid == masterproc .AND. &
           global%verbLevel > verbose_none ) THEN 
        WRITE(stdout,'(A,1X,A)') solver_name, &
              'Creating boundary-face gradient access list done.'
      END IF ! global%verbLevel  
  
      CALL deregisterfunction(global)  
  
    END SUBROUTINE rflu_createbfacegradaccesslist
    



  
! ******************************************************************************
!   Build boundary-face gradient access list
! ****************************************************************************** 
    
    SUBROUTINE rflu_buildbfacegradaccesslist(pRegion)

      IMPLICIT NONE

! ******************************************************************************
!     Declarations and definitions
! ******************************************************************************
      
! ==============================================================================
!     Arguments
! ==============================================================================

      TYPE(t_region), POINTER :: pregion

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

      INTEGER :: bf2bglast,bf2bgtotlast,ipatch
      TYPE(t_global), POINTER :: global
      TYPE(t_grid), POINTER :: pgrid
      TYPE(t_patch), POINTER :: ppatch

! ******************************************************************************
!     Start
! ******************************************************************************

      global => pregion%global

      CALL registerfunction(global,'RFLU_BuildBFaceGradAccessList',&
  'RFLU_ModBFaceGradAccessList.F90')

      IF ( global%myProcid == masterproc .AND. & 
           global%verbLevel > verbose_none ) THEN    
        WRITE(stdout,'(A,1X,A)') solver_name, & 
              'Building boundary-face gradient access lists...'
      END IF ! global%verbLevel

! ******************************************************************************
!     Set grid pointer
! ******************************************************************************

      pgrid => pregion%grid  

! ==============================================================================
!     Loop over patches
! ==============================================================================

      DO ipatch = 1,pgrid%nPatches
        ppatch => pregion%patches(ipatch)

        IF ( ipatch /= 1 ) THEN    
! TEMPORARY : removing usage of bf2bg from everywhere
!          pPatch%bf2bg(BF2BG_BEG) = bf2bgLast + 1        
!          pPatch%bf2bg(BF2BG_END) = pPatch%bf2bg(BF2BG_BEG) & 
!                                  + pPatch%nBFaces - 1

! TEMPORARY : removing usage of bf2bg from everywhere
!          pPatch%bf2bgTot(BF2BG_BEG) = bf2bgTotLast + 1        
!          pPatch%bf2bgTot(BF2BG_END) = pPatch%bf2bgTot(BF2BG_BEG) & 
!                                     + pPatch%nBFacesTot - 1
        ELSE             
! TEMPORARY : removing usage of bf2bg from everywhere
!          pPatch%bf2bg(BF2BG_BEG) = 1 
!          pPatch%bf2bg(BF2BG_END) = pPatch%nBFaces
 
! TEMPORARY : removing usage of bf2bg from everywhere         
!          pPatch%bf2bgTot(BF2BG_BEG) = 1 
!          pPatch%bf2bgTot(BF2BG_END) = pPatch%nBFacesTot              
        END IF ! iPatch

! TEMPORARY : removing usage of bf2bg from everywhere
!        bf2bgLast    = pPatch%bf2bg(BF2BG_END) 
!        bf2bgTotLast = pPatch%bf2bgTot(BF2BG_END)            
      END DO ! iPatch

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

      IF ( global%myProcid == masterproc .AND. & 
           global%verbLevel > verbose_none ) THEN  
        WRITE(stdout,'(A,1X,A)') solver_name, & 
              'Building boundary-face gradient access lists done.'
      END IF ! global%verbLevel

      CALL deregisterfunction(global)

    END SUBROUTINE rflu_buildbfacegradaccesslist
    
      
      
  
 


! ******************************************************************************
!   Destroy boundary-face gradient access list
! ******************************************************************************
  
    SUBROUTINE rflu_destroybfacegradaccesslist(pRegion)

      IMPLICIT NONE

! ******************************************************************************
!     Declarations and definitions
! ******************************************************************************
      
! ==============================================================================
!     Arguments
! ==============================================================================
  
      TYPE(t_region), POINTER :: pregion  
  
! ==============================================================================
!     Locals
! ==============================================================================  

      INTEGER :: errorflag,ipatch
      TYPE(t_grid), POINTER :: pgrid
      TYPE(t_patch), POINTER :: ppatch
      TYPE(t_global), POINTER :: global

! ******************************************************************************
!     Start
! ******************************************************************************      
        
      global => pregion%global  
        
      CALL registerfunction(global,'RFLU_DestroyBFaceGradAccessList',&
  'RFLU_ModBFaceGradAccessList.F90') 
        
      IF ( global%myProcid == masterproc .AND. &
           global%verbLevel > verbose_none ) THEN                 
        WRITE(stdout,'(A,1X,A)') solver_name, &
              'Destroying boundary-face gradient access list...'
      END IF ! global%verbLevel

! ******************************************************************************
!     Set grid pointer
! ******************************************************************************

      pgrid => pregion%grid     
                
! ******************************************************************************
!     Loop over patches
! ******************************************************************************
        
      DO ipatch = 1,pgrid%nPatches
        ppatch => pregion%patches(ipatch)
      
! TEMPORARY : removing usage of bf2bg from everywhere
!        DEALLOCATE(pPatch%bf2bg,STAT=errorFlag)
!        global%error = errorFlag   
!        IF ( global%error /= ERR_NONE ) THEN 
!          CALL ErrorStop(global,ERR_DEALLOCATE,__LINE__,'pPatch%bf2bg')          
!        END IF ! global%error
 
! TEMPORARY : removing usage of bf2bg from everywhere       
!        DEALLOCATE(pPatch%bf2bgTot,STAT=errorFlag)
!        global%error = errorFlag   
!        IF ( global%error /= ERR_NONE ) THEN 
!          CALL ErrorStop(global,ERR_DEALLOCATE,__LINE__,'pPatch%bf2bgTot')          
!        END IF ! global%error        
      END DO ! iPatch          
        
! ******************************************************************************
!     Nullify memory
! ******************************************************************************

      CALL rflu_nullifybfacegradaccesslist(pregion)

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

      IF ( global%myProcid == masterproc .AND. &
           global%verbLevel > verbose_none ) THEN 
        WRITE(stdout,'(A,1X,A)') solver_name, &
              'Destroying boundary-face gradient access list done.'
      END IF ! global%verbLevel  
  
      CALL deregisterfunction(global)  
  
    END SUBROUTINE rflu_destroybfacegradaccesslist
 




! ******************************************************************************
! End
! ******************************************************************************
  
END MODULE rflu_modbfacegradaccesslist


! ******************************************************************************
!
! RCS Revision history:
!
!   $Log: RFLU_ModBFaceGradAccessList.F90,v $
!   Revision 1.7  2008/12/06 08:44:20  mtcampbe
!   Updated license.
!
!   Revision 1.6  2008/11/19 22:17:31  mtcampbe
!   Added Illinois Open Source License/Copyright
!
!   Revision 1.5  2006/08/19 15:39:21  mparmar
!   Removed bf2bg,bf2bgTot
!
!   Revision 1.4  2004/05/25 01:34:16  haselbac
!   Added code for bf2bgTot array; needed for Rocturb Sij access
!
!   Revision 1.3  2004/01/22 16:03:58  haselbac
!   Made contents of modules PRIVATE, only procs PUBLIC, to avoid errors on ALC and titan
!
!   Revision 1.2  2003/12/09 03:58:01  haselbac
!   Bug fix for building of bf2bg list (no virtual faces)
!
!   Revision 1.1  2003/11/03 03:51:54  haselbac
!   Initial revision
!
! ******************************************************************************