rflumap.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: Driver routine for rflumap. 
!
! Description: None.
!
! Input: 
!   caseString  String with casename
!   mapOption   Mapping mode
!   nRegions    Number of regions
!   nProcs      Number of processes
!   verbLevel   Verbosity level
!
! Output: None.
!
! Notes: None.
!
! ******************************************************************************
!
! $Id: rflumap.F90,v 1.6 2008/12/06 08:44:57 mtcampbe Exp $
!
! Copyright: (c) 2002-2005 by the University of Illinois
!
! ******************************************************************************

SUBROUTINE rflumap(caseString,mapOption,nRegions,nProcs,verbLevel)

  USE moddatatypes
  USE modparameters
  USE moderror
  USE modglobal, ONLY: t_global
  USE moddatastruct, ONLY: t_level,t_region 
  
  USE rflu_moddimensions
  USE rflu_modregionmapping
  
#ifdef GENX
  USE rflu_modrocstaradmin, ONLY: rflu_genx_readctrlfile
  USE rflu_modrocstario, ONLY: rflu_genx_buildrocinpanestrings, & 
                            rflu_genx_closerocinctrlfiles, &
                            rflu_genx_openrocinctrlfiles, & 
                            rflu_genx_writerocinctrlfiles
#endif  
  
  USE modinterfaces, ONLY: rflu_builddatastruct, &
                           rflu_creategrid, &
                           rflu_destroygrid, &
                           rflu_getuserinput, & 
                           rflu_initglobal, & 
                           rflu_printheader, & 
                           rflu_printwarninfo, &
                           rflu_readrestartinfo, & 
                           rflu_setrestarttimeflag, & 
                           rflu_writeversionstring
  
  IMPLICIT NONE
  
! ******************************************************************************
! Definitions and declarations
! ******************************************************************************

! ==============================================================================
! Arguments
! ==============================================================================

  CHARACTER(*) :: casestring
  INTEGER, INTENT(IN) :: nprocs,nregions,mapoption,verblevel

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

  CHARACTER(CHRLEN) :: casename,panestringsurf,panestringvol,rcsidentstring
  INTEGER, PARAMETER :: map_initial = 1, & 
                        map_final   = 2
  INTEGER :: errorflag,ifile,ireg,iproc,nregionslocal
  TYPE(t_global), POINTER :: global
  TYPE(t_level), POINTER :: levels(:) 
  TYPE(t_region), POINTER :: pregion 

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

  rcsidentstring = '$RCSfile: rflumap.F90,v $ $Revision: 1.6 $'
  
! ******************************************************************************
! Initialize global data
! ******************************************************************************  
  
  ALLOCATE(global,stat=errorflag)
  IF ( errorflag /= err_none ) THEN 
    WRITE(stderr,'(A,1X,A)') solver_name,'ERROR - Pointer allocation failed.'
    stop
  END IF ! errorFlag 

  casename = casestring(1:len(casestring))
    
  CALL rflu_initglobal(casename,verblevel,crazy_value_int,global)

#ifdef GENX
  CALL rflu_genx_readctrlfile(global)
#endif

! ******************************************************************************
! Print header
! ******************************************************************************

  CALL rflu_printheader(global)
  CALL rflu_writeversionstring(global) 
                                  
! ******************************************************************************
! Build region-to-process mapping and write mapping to file
! ******************************************************************************
    
! ==============================================================================
! Initial mapping
! ==============================================================================

  IF ( mapoption == map_initial ) THEN 
    global%nRegions = nregions
    global%nProcs   = nprocs
    
    CALL rflu_createregionmapping(global,maptype_proc2reg)
    CALL rflu_buildregionmappingsimple(global)
    CALL rflu_checkregionmapping(global)
    CALL rflu_openregionmappingfile(global)
    CALL rflu_writeregionmappingfile(global)
    CALL rflu_closeregionmappingfile(global)
    CALL rflu_destroyregionmapping(global,maptype_proc2reg)

! ==============================================================================
! Final mapping
! ==============================================================================

  ELSE IF ( mapoption == map_final ) THEN
    CALL rflu_readregionmappingfile(global,mapfile_readmode_peek,-1)
    
#ifdef GENX    
    CALL rflu_genx_openrocinctrlfiles(global)
#endif    
    
! ------------------------------------------------------------------------------
!   Loop over processes
! ------------------------------------------------------------------------------    
    
    DO iproc = 1,global%nProcs
      CALL rflu_createregionmapping(global,maptype_reg)
      CALL rflu_readregionmappingfile(global,mapfile_readmode_all,iproc-1)
    
      CALL rflu_builddatastruct(global,levels)
      CALL rflu_applyregionmapping(global,levels)

      CALL rflu_getuserinput(levels(1)%regions)      
      CALL rflu_readrestartinfo(global)
      CALL rflu_setrestarttimeflag(global)      

! --- Loop over regions -------------------------------------------------------- 
                 
      panestringvol  = ''           
      panestringsurf = ''           
                  
      DO ireg = 1,global%nRegionsLocal
        pregion => levels(1)%regions(ireg)
    
        CALL rflu_readdimensions(pregion)
        CALL rflu_creategrid(pregion)

#ifdef GENX   
        CALL rflu_genx_buildrocinpanestrings(pregion,panestringvol, & 
                                             panestringsurf)
#endif        
        
        CALL rflu_destroygrid(pregion)
      END DO ! iReg                            
                 
#ifdef GENX    
      CALL rflu_genx_writerocinctrlfiles(global,iproc,panestringvol, & 
                                         panestringsurf)      
#endif      

      CALL rflu_destroyregionmapping(global,maptype_reg)
    END DO ! iProc        
            
#ifdef GENX
    CALL rflu_genx_closerocinctrlfiles(global)
#endif   

! ==============================================================================
! Invalid mapping option
! ==============================================================================
  
  ELSE 
    CALL errorstop(global,err_reached_default,__line__)  
  END IF ! mapOption

! ******************************************************************************
! Print info about warnings
! ******************************************************************************
  
  CALL rflu_printwarninfo(global)

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

END SUBROUTINE rflumap

! ******************************************************************************
!
! RCS Revision history:
!
! $Log: rflumap.F90,v $
! Revision 1.6  2008/12/06 08:44:57  mtcampbe
! Updated license.
!
! Revision 1.5  2008/11/19 22:18:12  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.4  2006/04/07 15:19:25  haselbac
! Removed tabs
!
! Revision 1.3  2006/02/06 23:55:55  haselbac
! Added comm argument to RFLU_InitGlobal
!
! Revision 1.2  2005/05/03 03:11:01  haselbac
! Converted to C++ reading of command-line
!
! Revision 1.1  2005/04/18 14:57:56  haselbac
! Initial revision
!
! ******************************************************************************