PLAG_InjcMakeParticle.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: set the next particle diameter and superparticle loading
!          for the multiphase injection algorithm.
!
! Description: none.
!
! Input: region     = current region
!        injcDiamDist  = injection model type
!        diam       = particle diameter
!        spLoad     = superparticle loading
!
! Output: diam and spLoad 
!
! Notes: none.
!
!******************************************************************************
!
! $Id: PLAG_InjcMakeParticle.F90,v 1.5 2008/12/06 08:44:33 mtcampbe Exp $
!
! Copyright: (c) 2002 by the University of Illinois
!
!******************************************************************************

SUBROUTINE plag_injcmakeparticle( region, injcDiamDist, diam, spLoad )

  USE moddatatypes  
  USE moddatastruct, ONLY : t_region
  USE modglobal, ONLY     : t_global
  USE modpartlag, ONLY    : t_plag_input
  USE modrandom, ONLY     : t_rand_data, rand1uniform, rand1lognormal,rand1imposedpdf
  USE moderror
  USE modparameters
  USE plag_modparameters
  IMPLICIT NONE

! ... parameters
  TYPE(t_region) :: region
  
  INTEGER        :: injcdiamdist
  REAL(RFREAL)   :: diam, spload

! ... loop variables

! ... local variables
  CHARACTER(CHRLEN) :: rcsidentstring
  
  REAL(RFREAL) :: diammeanlog, injcdiammean, injcstddev
  REAL(RFREAL) :: alpha, diampeaklog, injcdiammax, injcdiammin, &
                  injcdiampeak, power,valmax
  INTEGER      :: locmaxpdf
  
  TYPE(t_plag_input), POINTER :: plaginput
  TYPE(t_global),     POINTER :: global
  REAL(RFREAL),       POINTER :: pdfvalues(:,:) 
  
!******************************************************************************

  rcsidentstring = '$RCSfile: PLAG_InjcMakeParticle.F90,v $ $Revision: 1.5 $'
  
  global => region%global
  
  CALL registerfunction( global, 'PLAG_InjcMakeParticle',&
  'PLAG_InjcMakeParticle.F90' )

! Select injection model ------------------------------------------------------

  SELECT CASE(injcdiamdist)

!- Compute particle diameter based on Log normal distribution -----------------
  
    CASE (plag_injc_lognorm)
      injcdiammean = region%plagInput%injcDiamMean
      injcstddev   = region%plagInput%injcStdDev 
         
      diammeanlog  = log(injcdiammean)
      diam = rand1lognormal(diammeanlog,injcstddev,region%randData)
      spload = region%plagInput%spLoad

!- Compute particle diameter based on skewed Log distribution -----------------
  
    CASE (plag_injc_logskwd)
      injcdiampeak = region%plagInput%injcDiamMean
      injcdiammin  = region%plagInput%injcDiamMin
      injcdiammax  = region%plagInput%injcDiamMax
      injcstddev   = region%plagInput%injcStdDev 
      
      power        = 2.0_rfreal
      diampeaklog  = log(injcdiampeak)
           
      alpha = diampeaklog + injcstddev*injcstddev*power/ &
          ( (injcdiammax/injcdiampeak)**power - 1.0_rfreal)

      diam   = plag_rand1logskewed(injcdiampeak, injcstddev, injcdiammin, &
                               injcdiammax, alpha, power, region%randData ) 
      spload = region%plagInput%spLoad

   CASE (plag_injc_pdf)
      pdfvalues => region%plagInput%PDF%pdfvalues
      locmaxpdf =  region%plagInput%PDF%locMax
      valmax    =  region%plagInput%PDF%valMax

      diam   = rand1imposedpdf(region%randData,pdfvalues,locmaxpdf,valmax)
      spload = region%plagInput%spLoad
               
    CASE default
      CALL errorstop( global,err_reached_default,__line__ )
       
  END SELECT
     
! finalize --------------------------------------------------------------------

  CALL deregisterfunction( global )
    
CONTAINS

!******************************************************************************
  REAL(RFREAL) FUNCTION plag_rand1logskewed(dPeak,sDev,dMin,dMax,alpha, &
       power,rdata)
!******************************************************************************
! Skewed logarithmic distribution
! dPeak = peak
! sdev  = standard deviation
! dMin  = minimum
! dMax  = maximum
! alpha = median
! power = shape parameter

  REAL(RFREAL), INTENT(IN)  :: dmax,dpeak,dmin,sdev,alpha,power
  TYPE(t_rand_data), INTENT(INOUT) :: rdata

  INTEGER, PARAMETER :: itermax = 1000
  INTEGER   :: iter

  REAL(RFREAL) :: dlognorm, fskewedratio, xdistrand

  DO iter = 1, itermax 
    dlognorm = rand1lognormal(alpha,sdev,rdata)    

! decide to either accept or reject dLogNorm ----------------------------------

    IF ( dlognorm >= dmin .AND. dlognorm <= dmax ) THEN
      xdistrand = rand1uniform(rdata)

      fskewedratio = 1.0_rfreal - ( (1.0_rfreal-(dlognorm/dmax)**power) &
                                  * (1.0_rfreal-(dmin/dlognorm)**power) )
      IF ( xdistrand > fskewedratio ) THEN
        plag_rand1logskewed = dlognorm
        goto 8
      END IF ! xDistRand
      
    END IF ! dLogNorm

  END DO  ! iTer

  WRITE(stdout,'(A)') solver_name//'### WARNING: PLAG_rand1LogSkewed failed!'
  WRITE(stdout,'(A)') solver_name//'### Setting random value to peak'
  
  plag_rand1logskewed = dpeak
   
8 CONTINUE

  END FUNCTION plag_rand1logskewed
!******************************************************************************

END SUBROUTINE plag_injcmakeparticle

!******************************************************************************
!
! RCS Revision history:
!
! $Log: PLAG_InjcMakeParticle.F90,v $
! Revision 1.5  2008/12/06 08:44:33  mtcampbe
! Updated license.
!
! Revision 1.4  2008/11/19 22:17:46  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.3  2005/05/31 21:36:38  fnajjar
! Bug Fix to add spload for PLAG_INJC_PDF model
!
! 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:57:41  fnajjar
! Initial revision after changing case
!
! Revision 1.4  2004/06/16 23:06:33  fnajjar
! Renamed variabled for CRE kernel
!
! Revision 1.3  2003/11/21 22:35:51  fnajjar
! Update Random Number Generator
!
! Revision 1.2  2003/09/17 21:05:13  fnajjar
! Added infrastructure for skewed Log distribution in injection model
!
! Revision 1.1  2002/10/25 14:16:31  f-najjar
! Initial Import of Rocpart
!
!******************************************************************************