ModBuildFileNames.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 utility routines for building file names.
!
! Description: None
!
! Notes: None.
!
! ******************************************************************************
!
! $Id: ModBuildFileNames.F90,v 1.5 2008/12/06 08:44:18 mtcampbe Exp $
!
! Copyright: (c) 2004 by the University of Illinois
!
! ******************************************************************************

MODULE modbuildfilenames

  USE modparameters
  USE moddatatypes
  USE modglobal, ONLY: t_global
  USE moderror

  IMPLICIT NONE

! ******************************************************************************
! Declarations and definitions
! ******************************************************************************  

! ==============================================================================
! Public data
! ==============================================================================

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

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

! ==============================================================================
! Public functions
! ==============================================================================

  PUBLIC :: buildfilenamebasic, &
            buildfilenameplain, & 
            buildfilenameplainsteady, &
            buildfilenameplainunsteady, &
            buildfilenamesteady, &
            buildfilenameunsteady, & 
            buildregionidstring

! ==============================================================================
! Private functions
! ==============================================================================
                
! ******************************************************************************
! Routines
! ******************************************************************************
                
  CONTAINS




! ******************************************************************************
!
! Purpose: Build basic file name, that is, file name consisting only of 
!   directory, case name, extension, and region id.
!
! Description: None.
!
! Input: 
!   global      Global pointer
!   dest        Integer parameter indicating destination directory
!   ext         Extension (including ".")
!   regId       Region index
!
! Output: 
!   fileName    File name
!
! Notes: None.
!
! ******************************************************************************

  SUBROUTINE buildfilenamebasic(global,dest,ext,regId,fileName)

    IMPLICIT NONE
  
! ******************************************************************************
!   Declarations and definitions
! ******************************************************************************  

! ==============================================================================
!   Local variables
! ==============================================================================

    CHARACTER(CHRLEN) :: deststring,regidstring
  
! ==============================================================================
!   Arguments
! ==============================================================================

    CHARACTER(*), INTENT(IN) :: ext
    INTEGER, INTENT(IN) :: dest,regid
    TYPE(t_global), POINTER :: global 

    CHARACTER(CHRLEN), INTENT(OUT) :: filename  
  
! ******************************************************************************
!   Start
! ******************************************************************************

    CALL registerfunction(global,'BuildFileNameBasic',&
         'ModBuildFileNames.F90')

! ******************************************************************************
!   Build file name
! ******************************************************************************

    IF ( dest == filedest_indir ) THEN 
      WRITE(deststring,'(A)') global%inDir
    ELSE IF ( dest == filedest_outdir ) THEN
      WRITE(deststring,'(A)') global%outDir
    ELSE 
      CALL errorstop(global,err_filedest_invalid,&
           __line__)
    END IF ! dest

    CALL buildregionidstring(global,regid,regidstring)

    WRITE(filename,'(A)') trim(deststring)//trim(global%caseName)// & 
                          trim(ext)//'_'//trim(regidstring)
    
! ******************************************************************************
!   End
! ******************************************************************************

    CALL deregisterfunction(global)     
  
  END SUBROUTINE buildfilenamebasic








! ******************************************************************************
!
! Purpose: Build plain file name, that is, file name consisting only of 
!   directory, case name, and extension.
!
! Description: None.
!
! Input: 
!   global      Global pointer
!   dest        Integer parameter indicating destination directory
!   ext         Extension (including ".")
!
! Output: 
!   fileName    File name
!
! Notes: None.
!
! ******************************************************************************

  SUBROUTINE buildfilenameplain(global,dest,ext,fileName)

    IMPLICIT NONE
  
! ******************************************************************************
!   Declarations and definitions
! ******************************************************************************  

! ==============================================================================
!   Local variables
! ==============================================================================

    CHARACTER(CHRLEN) :: deststring
  
! ==============================================================================
!   Arguments
! ==============================================================================

    CHARACTER(*), INTENT(IN) :: ext
    INTEGER, INTENT(IN) :: dest
    TYPE(t_global), POINTER :: global 

    CHARACTER(CHRLEN), INTENT(OUT) :: filename  
  
! ******************************************************************************
!   Start
! ******************************************************************************

    CALL registerfunction(global,'BuildFileNamePlain',&
         'ModBuildFileNames.F90')

! ******************************************************************************
!   Build file name
! ******************************************************************************

    IF ( dest == filedest_indir ) THEN 
      WRITE(deststring,'(A)') global%inDir
    ELSE IF ( dest == filedest_outdir ) THEN
      WRITE(deststring,'(A)') global%outDir
    ELSE 
      CALL errorstop(global,err_filedest_invalid,&
           __line__)
    END IF ! dest

    WRITE(filename,'(A)') trim(deststring)//trim(global%caseName)//trim(ext)   
    
! ******************************************************************************
!   End
! ******************************************************************************
  
    CALL deregisterfunction(global)     
  
  END SUBROUTINE buildfilenameplain








! ******************************************************************************
!
! Purpose: Build plain file name with stamp, that is, file name consisting 
!   only of directory, case name, iteration stamp, and extension.
!
! Description: None.
!
! Input: 
!   global      Global pointer
!   dest        Integer parameter indicating destination directory
!   ext         Extension (including ".")
!   it          Iteration counter
!
! Output: 
!   fileName    File name
!
! Notes: None.
!
! ******************************************************************************

  SUBROUTINE buildfilenameplainsteady(global,dest,ext,it,fileName)

    IMPLICIT NONE
  
! ******************************************************************************
!   Declarations and definitions
! ******************************************************************************  

! ==============================================================================
!   Local variables
! ==============================================================================

    CHARACTER(CHRLEN) :: deststring
  
! ==============================================================================
!   Arguments
! ==============================================================================

    CHARACTER(*), INTENT(IN) :: ext
    INTEGER, INTENT(IN) :: dest,it
    TYPE(t_global), POINTER :: global 

    CHARACTER(CHRLEN), INTENT(OUT) :: filename  
  
! ******************************************************************************
!   Start
! ******************************************************************************

    CALL registerfunction(global,'BuildFileNamePlainSteady',&
         'ModBuildFileNames.F90')

! ******************************************************************************
!   Build file name
! ******************************************************************************

    IF ( dest == filedest_indir ) THEN 
      WRITE(deststring,'(A)') global%inDir
    ELSE IF ( dest == filedest_outdir ) THEN
      WRITE(deststring,'(A)') global%outDir
    ELSE 
      CALL errorstop(global,err_filedest_invalid,&
           __line__)
    END IF ! dest

    WRITE(filename,'(A,A,I6.6,A)') & 
      trim(deststring)//trim(global%caseName),'_',it,trim(ext) 
    
! ******************************************************************************
!   End
! ******************************************************************************

    CALL deregisterfunction(global)     
  
  END SUBROUTINE buildfilenameplainsteady








! ******************************************************************************
!
! Purpose: Build plain file name with stamp, that is, file name consisting 
!   only of directory, case name, time stamp, and extension.
!
! Description: None.
!
! Input: 
!   global      Global pointer
!   dest        Integer parameter indicating destination directory
!   ext         Extension (including ".")
!   tm          Time stamp
!
! Output: 
!   fileName    File name
!
! Notes: None.
!
! ******************************************************************************

  SUBROUTINE buildfilenameplainunsteady(global,dest,ext,tm,fileName)

    IMPLICIT NONE
  
! ******************************************************************************
!   Declarations and definitions
! ******************************************************************************  

! ==============================================================================
!   Local variables
! ==============================================================================

    CHARACTER(CHRLEN) :: deststring
  
! ==============================================================================
!   Arguments
! ==============================================================================

    CHARACTER(*), INTENT(IN) :: ext
    INTEGER, INTENT(IN) :: dest
    REAL(RFREAL), INTENT(IN) :: tm
    TYPE(t_global), POINTER :: global 

    CHARACTER(CHRLEN), INTENT(OUT) :: filename  

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

    CALL registerfunction(global,'BuildFileNamePlainUnsteady',&
         'ModBuildFileNames.F90')

! ******************************************************************************
!   Build file name
! ******************************************************************************

    IF ( dest == filedest_indir ) THEN 
      WRITE(deststring,'(A)') global%inDir
    ELSE IF ( dest == filedest_outdir ) THEN
      WRITE(deststring,'(A)') global%outDir
    ELSE 
      CALL errorstop(global,err_filedest_invalid,&
           __line__)
    END IF ! dest

    WRITE(filename,'(A,A,1PE11.5,A)') & 
      trim(deststring)//trim(global%caseName),'_',tm,trim(ext) 

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

    CALL deregisterfunction(global)     
  
  END SUBROUTINE buildfilenameplainunsteady








! ******************************************************************************
!
! Purpose: Build file name for steady flow, that is, file name consisting of 
!   directory, case name, extension, region id, and iteration counter.
!
! Description: None.
!
! Input: 
!   global      Global pointer
!   dest        Integer parameter indicating destination directory
!   ext         Extension (including ".")
!   regId       Region index
!   it          Iteration counter
!
! Output: 
!   fileName    File name
!
! Notes: None.
!
! ******************************************************************************

  SUBROUTINE buildfilenamesteady(global,dest,ext,regId,it,fileName)

    IMPLICIT NONE
  
! ******************************************************************************
!   Declarations and definitions
! ******************************************************************************  

! ==============================================================================
!   Local variables
! ==============================================================================

    CHARACTER(CHRLEN) :: deststring,regidstring
  
! ==============================================================================
!   Arguments
! ==============================================================================

    CHARACTER(*), INTENT(IN) :: ext
    INTEGER, INTENT(IN) :: dest,regid,it
    TYPE(t_global), POINTER :: global 

    CHARACTER(CHRLEN), INTENT(OUT) :: filename  
  
! ******************************************************************************
!   Start
! ******************************************************************************

    CALL registerfunction(global,'BuildFileNameSteady',&
         'ModBuildFileNames.F90')

! ******************************************************************************
!   Build file name
! ******************************************************************************

    IF ( dest == filedest_indir ) THEN 
      WRITE(deststring,'(A)') global%inDir
    ELSE IF ( dest == filedest_outdir ) THEN
      WRITE(deststring,'(A)') global%outDir
    ELSE 
      CALL errorstop(global,err_filedest_invalid,&
           __line__)
    END IF ! dest

    CALL buildregionidstring(global,regid,regidstring)

    WRITE(filename,'(A,I6.6)') trim(deststring)//trim(global%caseName)// & 
                               trim(ext)//'_'//trim(regidstring)//'_',it
    
! ******************************************************************************
!   End
! ******************************************************************************

    CALL deregisterfunction(global)     
  
  END SUBROUTINE buildfilenamesteady







! ******************************************************************************
!
! Purpose: Build file name for unsteady flow, that is, file name consisting of 
!   directory, case name, extension, region id, and time stamp.
!
! Description: None.
!
! Input: 
!   global      Global pointer
!   dest        Integer parameter indicating destination directory
!   ext         Extension (including ".")
!   regId       Region index
!   tm          Time stamp
!
! Output: 
!   fileName    File name
!
! Notes: None.
!
! ******************************************************************************
 
  SUBROUTINE buildfilenameunsteady(global,dest,ext,regId,tm,fileName)

    IMPLICIT NONE
  
! ******************************************************************************
!   Declarations and definitions
! ******************************************************************************  

! ==============================================================================
!   Local variables
! ==============================================================================

    CHARACTER(CHRLEN) :: deststring,regidstring
  
! ==============================================================================
!   Arguments
! ==============================================================================

    CHARACTER(*), INTENT(IN) :: ext
    INTEGER, INTENT(IN) :: dest,regid
    REAL(RFREAL), INTENT(IN) :: tm
    TYPE(t_global), POINTER :: global 

    CHARACTER(CHRLEN), INTENT(OUT) :: filename  
  
! ******************************************************************************
!   Start
! ******************************************************************************

    CALL registerfunction(global,'BuildFileNameUnsteady',&
         'ModBuildFileNames.F90')

! ******************************************************************************
!   Build file name
! ******************************************************************************

    IF ( dest == filedest_indir ) THEN 
      WRITE(deststring,'(A)') global%inDir
    ELSE IF ( dest == filedest_outdir ) THEN
      WRITE(deststring,'(A)') global%outDir
    ELSE 
      CALL errorstop(global,err_filedest_invalid,&
           __line__)
    END IF ! dest

    CALL buildregionidstring(global,regid,regidstring)

    WRITE(filename,'(A,1PE11.5)') trim(deststring)//trim(global%caseName)// & 
                                  trim(ext)//'_'//trim(regidstring)//'_',tm
    
! ******************************************************************************
!   End
! ******************************************************************************

    CALL deregisterfunction(global)     
  
  END SUBROUTINE buildfilenameunsteady








! ******************************************************************************
!
! Purpose: Build region id string.
!
! Description: None.
!
! Input: 
!   global      Global pointer
!   regId       Region index
!
! Output: 
!   regIdString Region string
!
! Notes: None.
!
! ******************************************************************************
 
  SUBROUTINE buildregionidstring(global,regId,regIdString)

    IMPLICIT NONE
  
! ******************************************************************************
!   Declarations and definitions
! ******************************************************************************  

! ==============================================================================
!   Local variables
! ==============================================================================
  
! ==============================================================================
!   Arguments
! ==============================================================================

    INTEGER, INTENT(IN) :: regid
    TYPE(t_global), POINTER :: global 

    CHARACTER(CHRLEN), INTENT(OUT) :: regidstring 
  
! ******************************************************************************
!   Start
! ******************************************************************************

    CALL registerfunction(global,'BuildRegionIdString',&
         'ModBuildFileNames.F90')

! ******************************************************************************
!   Write region id into region string
! ******************************************************************************

    WRITE(regidstring,'(I5.5)') regid
    
! ******************************************************************************
!   End
! ******************************************************************************

    CALL deregisterfunction(global)     
  
  END SUBROUTINE buildregionidstring







END MODULE modbuildfilenames

! ******************************************************************************
!
! RCS Revision history:
!
! $Log: ModBuildFileNames.F90,v $
! Revision 1.5  2008/12/06 08:44:18  mtcampbe
! Updated license.
!
! Revision 1.4  2008/11/19 22:17:29  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.3  2006/04/07 15:19:18  haselbac
! Removed tabs
!
! Revision 1.2  2004/10/19 19:28:38  haselbac
! Added BuildRegionIdString bcos needed in GENX modules, cosmetics
!
! Revision 1.1  2004/06/16 20:00:43  haselbac
! Initial revision
!
! ******************************************************************************