Rocstar-legacy/RFLU__ModRocstarUtils_8F90_source.html

 ! *********************************************************************

 ! * 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: Utility routines for Rocflu-GENX interface.

 !

 ! Description: None

 !

 ! Notes:

 !   1. This module must only be compiled when GENX=1.

 !

 ! ******************************************************************************

 !

 ! $Id: RFLU_ModGENXUtils.F90,v 1.5 2008/12/06 08:44:22 mtcampbe Exp $

 !

 ! Copyright: (c) 2004 by the University of Illinois

 !

 ! ******************************************************************************


 MODULE rflu_modrocstarutils


   USE moddatatypes

   USE modparameters


   IMPLICIT NONE


   include 'roccomf90.h'


   PRIVATE

   PUBLIC :: rflu_genx_buildpaneid, &

             rflu_genx_buildtimestring, &

             rflu_genx_getfilestemsurf, &

             rflu_genx_getfilestemvol, &

             rflu_genx_getfilestemgridsurf, &

             rflu_genx_getfilestemgridvol, &

             rflu_genx_getfilestemgspsurf, &

             rflu_genx_getfilestemgspvol, &

             rflu_genx_getfilestemmixtsurf, &

             rflu_genx_getfilestemmixtvol, &

             rflu_genx_setcnstrtype


 ! ******************************************************************************

 ! Declarations and definitions

 ! ******************************************************************************


 ! ==============================================================================

 ! Private

 ! ==============================================================================


   CHARACTER(CHRLEN) :: &

     RCSIdentString = '$RCSfile: RFLU_ModGENXUtils.F90,v $ $Revision: 1.5 $'


 ! ==============================================================================

 ! Public

 ! ==============================================================================


   INTEGER, PARAMETER, PUBLIC :: GENX_TIME_STRING_LEN = 9


 ! ******************************************************************************

 ! Contained routines

 ! ******************************************************************************


   CONTAINS


 ! ******************************************************************************

 !

 ! Purpose: Build unique identifier for each pane.

 !

 ! Description: None.

 !

 ! Input:

 !   iRegion     Region index

 !   iPatch      Patch index

 !

 ! Output:

 !   paneId      Pane identifier

 !

 ! Notes:

 !   1. Pane id must not be zero, so add unit offset.

 !   2. If the mapping is changed, the inverse mapping in the routine

 !      RFLU_GENX_GetPatchId must also be changed.

 !

 ! ******************************************************************************


   SUBROUTINE rflu_genx_buildpaneid(iRegion,iPatch,paneId)


     IMPLICIT NONE


 ! ******************************************************************************

 !   Declarations and definitions

 ! ******************************************************************************


 ! ==============================================================================

 !   Arguments

 ! ==============================================================================


     INTEGER, INTENT(IN) :: ipatch,iregion

     INTEGER, INTENT(OUT) :: paneid


 ! ******************************************************************************

 !   Start

 ! ******************************************************************************


     paneid = 1 + iregion*region_index_offset + ipatch


 ! ******************************************************************************

 !   End

 ! ******************************************************************************


   END SUBROUTINE rflu_genx_buildpaneid


 ! ******************************************************************************

 !

 ! Purpose: Build unique identifier for each pane.

 !

 ! Description: None.

 !

 ! Input:

 !   iRegion     Region index

 !   iPatch      Patch index

 !

 ! Output:

 !   paneId      Pane identifier

 !

 ! Notes: None.

 !

 ! ******************************************************************************


   SUBROUTINE rflu_genx_buildtimestring(time,timeString)


     IMPLICIT NONE


 ! ******************************************************************************

 !   Declarations and definitions

 ! ******************************************************************************


 ! ==============================================================================

 !   Arguments

 ! ==============================================================================


     REAL(RFREAL), INTENT(IN) :: time

     CHARACTER(GENX_TIME_STRING_LEN), INTENT(OUT) :: timestring


 ! ==============================================================================

 !   Locals

 ! ==============================================================================


     CHARACTER(15) :: tempstring


 ! ******************************************************************************

 !   Start

 ! ******************************************************************************


     WRITE(tempstring,'(E12.6)') 1.0e9_rfreal*time


     timestring = tempstring(11:12)//'.'//tempstring(3:8)


 ! ******************************************************************************

 !   End

 ! ******************************************************************************


   END SUBROUTINE rflu_genx_buildtimestring


 ! ******************************************************************************

 !

 ! Purpose: Get file stem for surface files.

 !

 ! Description: None.

 !

 ! Input: None.

 !

 ! Output:

 !   fileStem    File stem

 !

 ! Notes: None.

 !

 ! ******************************************************************************


   SUBROUTINE rflu_genx_getfilestemsurf(fileStem)


     IMPLICIT NONE


 ! ******************************************************************************

 !   Declarations and definitions

 ! ******************************************************************************


 ! ==============================================================================

 !   Arguments

 ! ==============================================================================


     CHARACTER(*), INTENT(OUT) :: filestem


 ! ******************************************************************************

 !   Start

 ! ******************************************************************************


     filestem = 'ifluid'


 ! ******************************************************************************

 !   End

 ! ******************************************************************************


   END SUBROUTINE rflu_genx_getfilestemsurf


 ! ******************************************************************************

 !

 ! Purpose: Get file stem for volume files.

 !

 ! Description: None.

 !

 ! Input: None.

 !

 ! Output:

 !   fileStem    File stem

 !

 ! Notes: None.

 !

 ! ******************************************************************************


   SUBROUTINE rflu_genx_getfilestemvol(fileStem)


     IMPLICIT NONE


 ! ******************************************************************************

 !   Declarations and definitions

 ! ******************************************************************************


 ! ==============================================================================

 !   Arguments

 ! ==============================================================================


     CHARACTER(*), INTENT(OUT) :: filestem


 ! ******************************************************************************

 !   Start

 ! ******************************************************************************


     filestem = 'fluid'


 ! ******************************************************************************

 !   End

 ! ******************************************************************************


   END SUBROUTINE rflu_genx_getfilestemvol


 ! ******************************************************************************

 !

 ! Purpose: Get file stem for surface grid file.

 !

 ! Description: None.

 !

 ! Input: None.

 !

 ! Output:

 !   fileStem    File stem

 !

 ! Notes: None.

 !

 ! ******************************************************************************


   SUBROUTINE rflu_genx_getfilestemgridsurf(fileStem)


     IMPLICIT NONE


 ! ******************************************************************************

 !   Declarations and definitions

 ! ******************************************************************************


 ! ==============================================================================

 !   Arguments

 ! ==============================================================================


     CHARACTER(*), INTENT(OUT) :: filestem


 ! ******************************************************************************

 !   Start

 ! ******************************************************************************


     CALL rflu_genx_getfilestemsurf(filestem)


     filestem = trim(filestem)//'-grid'


 ! ******************************************************************************

 !   End

 ! ******************************************************************************


   END SUBROUTINE rflu_genx_getfilestemgridsurf


 ! ******************************************************************************

 !

 ! Purpose: Get file stem for volume grid file.

 !

 ! Description: None.

 !

 ! Input: None.

 !

 ! Output:

 !   fileStem    File stem

 !

 ! Notes: None.

 !

 ! ******************************************************************************


   SUBROUTINE rflu_genx_getfilestemgridvol(fileStem)


     IMPLICIT NONE


 ! ******************************************************************************

 !   Declarations and definitions

 ! ******************************************************************************


 ! ==============================================================================

 !   Arguments

 ! ==============================================================================


     CHARACTER(*), INTENT(OUT) :: filestem


 ! ******************************************************************************

 !   Start

 ! ******************************************************************************


     CALL rflu_genx_getfilestemvol(filestem)


     filestem = trim(filestem)//'-grid'


 ! ******************************************************************************

 !   End

 ! ******************************************************************************


   END SUBROUTINE rflu_genx_getfilestemgridvol


 ! ******************************************************************************

 !

 ! Purpose: Get file stem for surface grid speed file.

 !

 ! Description: None.

 !

 ! Input: None.

 !

 ! Output:

 !   fileStem    File stem

 !

 ! Notes: None.

 !

 ! ******************************************************************************


   SUBROUTINE rflu_genx_getfilestemgspsurf(fileStem)


     IMPLICIT NONE


 ! ******************************************************************************

 !   Declarations and definitions

 ! ******************************************************************************


 ! ==============================================================================

 !   Arguments

 ! ==============================================================================


     CHARACTER(*), INTENT(OUT) :: filestem


 ! ******************************************************************************

 !   Start

 ! ******************************************************************************


     CALL rflu_genx_getfilestemsurf(filestem)


     filestem = trim(filestem)//'-gsp'


 ! ******************************************************************************

 !   End

 ! ******************************************************************************


   END SUBROUTINE rflu_genx_getfilestemgspsurf


 ! ******************************************************************************

 !

 ! Purpose: Get file stem for volume grid speed file.

 !

 ! Description: None.

 !

 ! Input: None.

 !

 ! Output:

 !   fileStem    File stem

 !

 ! Notes: None.

 !

 ! ******************************************************************************


   SUBROUTINE rflu_genx_getfilestemgspvol(fileStem)


     IMPLICIT NONE


 ! ******************************************************************************

 !   Declarations and definitions

 ! ******************************************************************************


 ! ==============================================================================

 !   Arguments

 ! ==============================================================================


     CHARACTER(*), INTENT(OUT) :: filestem


 ! ******************************************************************************

 !   Start

 ! ******************************************************************************


     CALL rflu_genx_getfilestemvol(filestem)


     filestem = trim(filestem)//'-gsp'


 ! ******************************************************************************

 !   End

 ! ******************************************************************************


   END SUBROUTINE rflu_genx_getfilestemgspvol


 ! ******************************************************************************

 !

 ! Purpose: Get file stem for mixture solution file.

 !

 ! Description: None.

 !

 ! Input: None.

 !

 ! Output:

 !   fileStem    File stem

 !

 ! Notes: None.

 !

 ! ******************************************************************************


   SUBROUTINE rflu_genx_getfilestemmixtsurf(fileStem)


     IMPLICIT NONE


 ! ******************************************************************************

 !   Declarations and definitions

 ! ******************************************************************************


 ! ==============================================================================

 !   Arguments

 ! ==============================================================================


     CHARACTER(*), INTENT(OUT) :: filestem


 ! ******************************************************************************

 !   Start

 ! ******************************************************************************


     CALL rflu_genx_getfilestemsurf(filestem)


     filestem = trim(filestem)//'-mixt'


 ! ******************************************************************************

 !   End

 ! ******************************************************************************


   END SUBROUTINE rflu_genx_getfilestemmixtsurf


 ! ******************************************************************************

 !

 ! Purpose: Get file stem for mixture solution file.

 !

 ! Description: None.

 !

 ! Input: None.

 !

 ! Output:

 !   fileStem    File stem

 !

 ! Notes: None.

 !

 ! ******************************************************************************


   SUBROUTINE rflu_genx_getfilestemmixtvol(fileStem)


     IMPLICIT NONE


 ! ******************************************************************************

 !   Declarations and definitions

 ! ******************************************************************************


 ! ==============================================================================

 !   Arguments

 ! ==============================================================================


     CHARACTER(*), INTENT(OUT) :: filestem


 ! ******************************************************************************

 !   Start

 ! ******************************************************************************


     CALL rflu_genx_getfilestemvol(filestem)


     filestem = trim(filestem)//'-mixt'


 ! ******************************************************************************

 !   End

 ! ******************************************************************************


   END SUBROUTINE rflu_genx_getfilestemmixtvol


 ! ******************************************************************************

 !

 ! Purpose: Set constraint type.

 !

 ! Description: None.

 !

 ! Input: None.

 !

 ! Output:

 !   movePatchDir        Direction in which patch is allowed to move.

 !

 ! Notes: None.

 !

 ! ******************************************************************************


   INTEGER FUNCTION rflu_genx_setcnstrtype(movePatchDir)


     IMPLICIT NONE


 ! ******************************************************************************

 !   Declarations and definitions

 ! ******************************************************************************


 ! ==============================================================================

 !   Arguments

 ! ==============================================================================


     INTEGER, INTENT(IN) :: movepatchdir


 ! ******************************************************************************

 !   Start

 ! ******************************************************************************


     SELECT CASE ( movepatchdir )

       CASE ( movepatch_dir_none )

         rflu_genx_setcnstrtype =    2

       CASE ( movepatch_dir_x )

         rflu_genx_setcnstrtype =  120

       CASE ( movepatch_dir_y )

         rflu_genx_setcnstrtype =  121

       CASE ( movepatch_dir_z )

         rflu_genx_setcnstrtype =  122

       CASE ( movepatch_dir_xy )

         rflu_genx_setcnstrtype = -122

       CASE ( movepatch_dir_xz )

         rflu_genx_setcnstrtype = -121

       CASE ( movepatch_dir_yz )

         rflu_genx_setcnstrtype = -120

       CASE ( movepatch_dir_xyz )

         rflu_genx_setcnstrtype =    0

       CASE default

         rflu_genx_setcnstrtype =    2

     END SELECT ! movePatchDir


 ! ******************************************************************************

 !   End

 ! ******************************************************************************


   END FUNCTION rflu_genx_setcnstrtype


 END MODULE rflu_modrocstarutils


 ! ******************************************************************************

 !

 ! RCS Revision history:

 !

 ! $Log: RFLU_ModGENXUtils.F90,v $

 ! Revision 1.5  2008/12/06 08:44:22  mtcampbe

 ! Updated license.

 !

 ! Revision 1.4  2008/11/19 22:17:33  mtcampbe

 ! Added Illinois Open Source License/Copyright

 !

 ! Revision 1.3  2006/04/07 15:19:19  haselbac

 ! Removed tabs

 !

 ! Revision 1.2  2005/06/09 20:21:17  haselbac

 ! Added function to set constraint type

 !

 ! Revision 1.1  2004/10/19 19:27:04  haselbac

 ! Initial revision

 !

 ! ******************************************************************************


modparameters
Definition: ModParameters.F90:42

rflu_modrocstarutils::rflu_genx_getfilestemgspsurf
subroutine, public rflu_genx_getfilestemgspsurf(fileStem)
Definition: RFLU_ModRocstarUtils.F90:408

rflu_modrocstarutils::rflu_genx_getfilestemsurf
subroutine, public rflu_genx_getfilestemsurf(fileStem)
Definition: RFLU_ModRocstarUtils.F90:211

rflu_modrocstarutils::rflu_genx_getfilestemgspvol
subroutine, public rflu_genx_getfilestemgspvol(fileStem)
Definition: RFLU_ModRocstarUtils.F90:458

rflu_modrocstarutils::rflu_genx_buildtimestring
subroutine, public rflu_genx_buildtimestring(time, timeString)
Definition: RFLU_ModRocstarUtils.F90:157

rflu_modrocstarutils::rflu_genx_getfilestemmixtvol
subroutine, public rflu_genx_getfilestemmixtvol(fileStem)
Definition: RFLU_ModRocstarUtils.F90:558

rflu_modrocstarutils::rflu_genx_getfilestemvol
subroutine, public rflu_genx_getfilestemvol(fileStem)
Definition: RFLU_ModRocstarUtils.F90:258

rflu_modrocstarutils::rflu_genx_getfilestemgridvol
subroutine, public rflu_genx_getfilestemgridvol(fileStem)
Definition: RFLU_ModRocstarUtils.F90:357

rflu_modrocstarutils::rflu_genx_getfilestemgridsurf
subroutine, public rflu_genx_getfilestemgridsurf(fileStem)
Definition: RFLU_ModRocstarUtils.F90:307

rflu_modrocstarutils::rflu_genx_setcnstrtype
INTEGER function, public rflu_genx_setcnstrtype(movePatchDir)
Definition: RFLU_ModRocstarUtils.F90:606

rflu_modrocstarutils::rflu_genx_buildpaneid
subroutine, public rflu_genx_buildpaneid(iRegion, iPatch, paneId)
Definition: RFLU_ModRocstarUtils.F90:108

rflu_modrocstarutils::rflu_genx_getfilestemmixtsurf
subroutine, public rflu_genx_getfilestemmixtsurf(fileStem)
Definition: RFLU_ModRocstarUtils.F90:507

moddatatypes
Definition: ModDataTypes.F90:40

rflu_modrocstarutils
Definition: RFLU_ModRocstarUtils.F90:40