PLAG_ReadDisPartSection.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: read in user input related to discrete particle module.
!
! Description: none.
!
! Input: user input file.
!
! Output: regions = total number of particles, drag model,injection model.
!
! Notes: none.
!
!******************************************************************************
!
! $Id: PLAG_ReadDisPartSection.F90,v 1.7 2008/12/06 08:44:35 mtcampbe Exp $
!
! Copyright: (c) 2002 by the University of Illinois
!
!******************************************************************************

SUBROUTINE plag_readdispartsection( regions )

  USE moddatatypes
  USE moddatastruct, ONLY : t_region
  USE modglobal, ONLY     : t_global
  USE modmixture, ONLY    : t_mixt_input
  USE modpartlag, ONLY    : t_plag_input
  USE moderror
  USE modparameters

  USE plag_modparameters
  USE plag_modinterfaces, ONLY : plag_readpdffromfile

#ifdef RFLO
  USE modinterfaces, ONLY : readregionsection
#endif
#ifdef RFLU
  USE modinterfaces, ONLY: readsection
#endif

  IMPLICIT NONE

! ... parameters
  TYPE(t_region), POINTER :: regions(:)

! ... loop  variables

! ... local variables
  INTEGER, PARAMETER :: nvals_max=18

  CHARACTER(CHRLEN) :: rcsidentstring
  CHARACTER(20)     :: keys(nvals_max)

  INTEGER           :: brbeg, brend, nvals

  LOGICAL           :: defined(nvals_max)

  REAL(RFREAL)      :: vals(nvals_max)

  TYPE(t_global), POINTER :: global

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

  rcsidentstring = '$RCSfile: PLAG_ReadDisPartSection.F90,v $ $Revision: 1.7 $'

  global => regions(1)%global

  CALL registerfunction( global, 'PLAG_ReadDisPartSection',&
  'PLAG_ReadDisPartSection.F90' )

! specify keywords and search for them ----------------------------------------

  nvals   = nvals_max

  defined(:) = .false.

  keys( 1)   = 'USED'
  keys( 2)   = 'NPCLSMAX'
  keys( 3)   = 'EJECMODEL'
  keys( 4)   = 'INJCVELRATIO'
  keys( 5)   = 'SPLOAD'
  keys( 6)   = 'INJCBETA'
  keys( 7)   = 'INJCDIAMDIST'
  keys( 8)   = 'INJCDIAMMEAN'
  keys( 9)   = 'INJCDIAMMIN'
  keys(10)   = 'INJCDIAMMAX'
  keys(11)   = 'INJCSTDDEV'  
  keys(12)   = 'INTRPLMIXTMODEL'
  keys(13)   = 'NPCLSBUFFTOT'
  keys(14)   = 'NPCLSBUFFCECELLSMAX'
  keys(15)   = 'BREAKUPMODEL'
  keys(16)   = 'BREAKUPFAC'
  keys(17)   = 'BREAKUPWEBSWI'
  keys(18)   = 'FINDPCLMETHOD'

#ifdef RFLO
  CALL readregionsection( global, if_input,nvals,keys,vals, &
       brbeg,brend,defined )
#endif
#ifdef RFLU
  CALL readsection(global,if_input,nvals,keys(1:nvals),vals(1:nvals), &
       defined(1:nvals))

  brbeg = lbound(regions,1)
  brend = ubound(regions,1)
#endif

  IF (defined(1)) THEN
     IF (vals(1) < 0.1) THEN
        regions(brbeg:brend)%plagInput%readStatus = 0
     ELSE
        regions(brbeg:brend)%plagInput%readStatus = 1
     ENDIF ! vals
  ENDIF ! defined

  IF (defined(2)) &
       regions(brbeg:brend)%plagInput%nPclsMax = max(1,int(abs(vals(2))+0.5_rfreal))

  IF (defined(3)) THEN
     regions(brbeg:brend)%plagInput%ejecModel     = nint(abs(vals(3)))
     IF ( vals(3) > 0.9 .AND. vals(3) < 1.1 ) &
        regions(brbeg:brend)%plagInput%ejecModel  = plag_ejec_model1
     IF ( vals(3) > 1.9 .AND. vals(3) < 2.1 ) &
          regions(brbeg:brend)%plagInput%ejecModel  = plag_ejec_cre
  ENDIF ! defined

  IF (defined(4)) &
       regions(brbeg:brend)%plagInput%injcVelRatio = abs(vals(4))

  IF (defined(5)) &
       regions(brbeg:brend)%plagInput%spLoad       = abs(vals(5))

  IF (defined(6)) &
       regions(brbeg:brend)%plagInput%injcBeta     = abs(vals(6))

  IF (defined(7)) THEN
     regions(brbeg:brend)%plagInput%injcDiamDist    = nint(abs(vals(7)))
     IF ( vals(7) > 0.9 .AND. vals(7) < 1.1 ) &
       regions(brbeg:brend)%plagInput%injcDiamDist  = plag_injc_lognorm   
     IF ( vals(7) > 1.9 .AND. vals(7) < 2.1 ) &
       regions(brbeg:brend)%plagInput%injcDiamDist  = plag_injc_logskwd
     IF ( vals(7) > 2.9 .AND. vals(7) < 3.1 ) THEN
       regions(brbeg:brend)%plagInput%injcDiamDist  = plag_injc_pdf
       CALL plag_readpdffromfile( regions,brbeg,brend )
     ENDIF

  ENDIF ! defined

  IF (defined(8)) &
    regions(brbeg:brend)%plagInput%injcDiamMean = abs(vals(8))

  IF (defined(9)) &
    regions(brbeg:brend)%plagInput%injcDiamMin  = abs(vals(9))

  IF (defined(10)) &
    regions(brbeg:brend)%plagInput%injcDiamMax  = abs(vals(10))

  IF (defined(11)) &
    regions(brbeg:brend)%plagInput%injcStdDev   = abs(vals(11))

  IF (defined(12)) THEN
    regions(brbeg:brend)%plagInput%intrplMixtModel    = nint(abs(vals(12)))
    IF ( vals(12) > -0.1 .AND. vals(12) < 0.1 ) &
      regions(brbeg:brend)%plagInput%intrplMixtModel  = zeroth_order
    IF ( vals(12) > 0.9 .AND. vals(12) < 1.1 ) &
      regions(brbeg:brend)%plagInput%intrplMixtModel  = first_order
  ENDIF ! defined

  IF (defined(13)) &
    regions(brbeg:brend)%plagInput%nPclsBuffTot = max(1,int(abs(vals(13))+0.5_rfreal))

  IF (defined(14)) &
    regions(brbeg:brend)%plagInput%nPclsBuffCECellsMax = max(1,int(abs(vals(14))+0.5_rfreal))  

  IF (defined(15)) THEN
    regions(brbeg:brend)%plagInput%breakupModel    = nint(abs(vals(15))) 
    IF ( vals(15) > -0.1 .AND. vals(15) < 0.1 ) &
      regions(brbeg:brend)%plagInput%breakupModel  = plag_breakup_nomodel 
    IF ( vals(15) > 0.9 .AND. vals(15) < 1.1 ) &
      regions(brbeg:brend)%plagInput%breakupModel  = plag_breakup_model1
  ENDIF ! defined

  IF (defined(16)) &
    regions(brbeg:brend)%plagInput%breakupFac = abs(vals(16))
              
  IF (defined(17)) THEN
    regions(brbeg:brend)%plagInput%breakupWebSwi   = nint(abs(vals(17))) 
    IF ( vals(17) > -0.1 .AND. vals(17) < 0.1 ) &
      regions(brbeg:brend)%plagInput%breakupWebSwi = plag_breakup_nowebswi 
    IF ( vals(17) > 0.9 .AND. vals(17) < 1.1 ) &
      regions(brbeg:brend)%plagInput%breakupWebSwi = plag_breakup_webswi1
  ENDIF ! defined

  IF ( defined(18) .EQV. .true. ) THEN 
    regions(brbeg:brend)%plagInput%findPclMethod = vals(18)  
  END IF ! defined

! finalize --------------------------------------------------------------------

  CALL deregisterfunction( global )

END SUBROUTINE plag_readdispartsection
!******************************************************************************
!
! RCS Revision history:
!
! $Log: PLAG_ReadDisPartSection.F90,v $
! Revision 1.7  2008/12/06 08:44:35  mtcampbe
! Updated license.
!
! Revision 1.6  2008/11/19 22:17:48  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.5  2007/03/06 23:15:32  fnajjar
! Renamed nPclsTot to nPclsMax
!
! Revision 1.4  2005/05/17 18:35:41  fnajjar
! Further IO improvement
!
! Revision 1.3  2005/05/17 17:07:37  fnajjar
! Improved loading of values for proper error trapping
!
! Revision 1.2  2005/04/25 18:39:10  luca1
! Imposed PDF from file option for random particle ejection
!
! Revision 1.1  2004/12/01 20:58:05  fnajjar
! Initial revision after changing case
!
! Revision 1.13  2004/10/08 22:13:33  haselbac
! Added reading of findPclMethod
!
! Revision 1.12  2004/10/08 20:03:14  fnajjar
! Bug fix for nVals size and defined NVALS_MAX
!
! Revision 1.11  2004/07/29 16:58:07  fnajjar
! Inconsistent numbers in array vals leading to io clobbering
!
! Revision 1.10  2004/06/17 15:19:48  fnajjar
! Added infrastructure for ejection model and revamped DISPART input section
!
! Revision 1.9  2004/06/16 23:07:17  fnajjar
! Renamed variabled for CRE kernel
!
! Revision 1.8  2004/03/10 23:09:50  fnajjar
! Added maximum buffer size for corner-edge cells
!
! Revision 1.7  2004/03/05 22:09:03  jferry
! created global variables for peul, plag, and inrt use
!
! Revision 1.6  2004/02/26 21:02:19  haselbac
! Added RFLU support
!
! Revision 1.5  2003/09/17 21:05:13  fnajjar
! Added infrastructure for skewed Log distribution in injection model
!
! Revision 1.4  2003/09/13 20:14:22  fnajjar
! Added infrastructure for Breakup model
!
! Revision 1.3  2003/09/10 23:35:50  fnajjar
! Removed flags that are subsumed with Rocinteract
!
! Revision 1.2  2003/01/24 19:41:55  f-najjar
! Bug fix for nPclsBuffTot to read vals(14)
!
! Revision 1.1  2002/10/25 14:19:16  f-najjar
! Initial Import of Rocpart
!
!
!******************************************************************************