PLAG_CheckUserInput.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: check user input for PLAG.
!
! Description: none.
!
! Input: regions = pointer to all regions.
!
! Output: none.
!
! Notes: none.
!
!******************************************************************************
!
! $Id: PLAG_CheckUserInput.F90,v 1.7 2008/12/06 08:44:33 mtcampbe Exp $
!
! Copyright: (c) 2002 by the University of Illinois
!
!******************************************************************************

SUBROUTINE plag_checkuserinput( 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
  IMPLICIT NONE

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

! ... loop variables
  INTEGER :: icont, ireg

! ... local variables
  CHARACTER(CHRLEN) :: rcsidentstring

  INTEGER :: nregions

  TYPE(t_global), POINTER :: global

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

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

#ifdef RFLO
  global => regions(1)%global
#endif

#ifdef RFLU
  global => regions(0)%global
#endif

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

! Check for consistency with flow solver -------------------------------------

#ifdef RFLO
  nregions = global%nRegions
#endif

#ifdef RFLU
  nregions = global%nRegionsLocal
#endif

  DO ireg = 1, nregions
    IF ( global%flowType == flow_steady ) THEN
       WRITE(stdout,1000) ireg,global%flowType
       CALL errorstop( global,err_plag_module,__line__ )
    END IF ! flowType

    IF ( .NOT. regions(ireg)%mixtInput%computeTv ) THEN
      WRITE(stdout,1010) ireg,regions(ireg)%mixtInput%computeTv
      CALL errorstop( global,err_plag_module,__line__ )
    END IF ! computeTv

! - viscModel needs to be checked again because computeTv may have been turned
! - on after the previous check (only necessary for RFLO case: the RFLU case
! - this is caught in RFLU_CheckDerivedUserInput)

    IF (  regions(ireg)%mixtInput%computeTv .AND. &
        ( regions(ireg)%mixtInput%viscModel <  visc_suthr .OR.  &
          regions(ireg)%mixtInput%viscModel >  visc_antib )     ) THEN
      CALL errorstop(global,err_unknown_viscmodel,__line__)
    END IF ! viscModel

#ifdef RFLO
    IF ( regions(ireg)%plagInput%intrplMixtModel /= zeroth_order) THEN
      WRITE(stdout,1030) ireg,regions(ireg)%plagInput%intrplMixtModel
      CALL errorstop( global,err_plag_intrplmodel,__line__ )
    END IF ! intrplMixtModel
#endif 

#ifdef RFLU
    IF ( regions(ireg)%plagInput%intrplMixtModel > first_order) THEN
      WRITE(stdout,1030) ireg,regions(ireg)%plagInput%intrplMixtModel
      CALL errorstop( global,err_plag_intrplmodel,__line__ )
    END IF ! intrplMixtModel

    IF ( regions(ireg)%plagInput%intrplMixtModel /=zeroth_order .AND. &
         regions(ireg)%mixtInput%spaceOrder == 1                      ) THEN 
      CALL errorstop(global,err_plag_intrplmodel,__line__)
    END IF ! intrplMixtModel
#endif

    IF ( regions(ireg)%plagInput%breakupModel < plag_breakup_nomodel .OR. &
         regions(ireg)%plagInput%breakupModel > plag_breakup_model1  ) THEN
      WRITE(stdout,1040) ireg,regions(ireg)%plagInput%breakupModel
      CALL errorstop( global,err_plag_breakupmodel,__line__ )
    END IF ! breakupModel

    IF ( regions(ireg)%plagInput%breakupWebSwi < plag_breakup_nowebswi .OR. &
         regions(ireg)%plagInput%breakupWebSwi > plag_breakup_webswi1 ) THEN
      WRITE(stdout,1040) ireg,regions(ireg)%plagInput%breakupWebSwi
      CALL errorstop( global,err_plag_breakupwebswi,__line__ )
    END IF ! breakupModel

    IF ( regions(ireg)%plagInput%injcDiamDist < plag_injc_lognorm .OR. &
         regions(ireg)%plagInput%injcDiamDist > plag_injc_pdf) THEN
      WRITE(stdout,1050) ireg,regions(ireg)%plagInput%injcDiamDist
      CALL errorstop( global,err_plag_injcdiamdist,__line__ )
    END IF ! injcDiamDist

    IF ( regions(ireg)%plagInput%injcDiamDist == plag_injc_logskwd .AND. &
         regions(ireg)%plagInput%injcDiamMean/&
         regions(ireg)%plagInput%injcDiamMax > 0.8_rfreal ) THEN
      WRITE(stdout,1060) ireg,regions(ireg)%plagInput%injcDiamMean/&
                              regions(ireg)%plagInput%injcDiamMax
      CALL errorstop( global,err_plag_injcdiam,__line__ )
    END IF ! injcDiamDist

    IF ( regions(ireg)%plagInput%injcDiamDist == plag_injc_logskwd .AND. &
         regions(ireg)%plagInput%injcDiamMin/&
         regions(ireg)%plagInput%injcDiamMean > 0.8_rfreal ) THEN
      WRITE(stdout,1070) ireg,regions(ireg)%plagInput%injcDiamMin/&
                              regions(ireg)%plagInput%injcDiamMean
      CALL errorstop( global,err_plag_injcdiam,__line__ )
    END IF ! injcDiamDist

    IF ( regions(ireg)%plagInput%ejecModel < plag_ejec_model1 .OR. &
         regions(ireg)%plagInput%ejecModel > plag_ejec_cre  ) THEN
      WRITE(stdout,1050) ireg,regions(ireg)%plagInput%ejecModel
      CALL errorstop( global,err_plag_ejecmodel,__line__ )
    END IF ! ejecModel

    IF ( regions(ireg)%plagInput%findPclMethod < find_pcl_method_traj_fast .OR. &
         regions(ireg)%plagInput%findPclMethod > find_pcl_method_lohner  ) THEN
      WRITE(stdout,1050) ireg,regions(ireg)%plagInput%findPclMethod
      CALL errorstop( global,err_plag_findpcl,__line__ )
    END IF ! ejecModel

  END DO ! iReg

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

  CALL deregisterfunction( global )

1000 FORMAT('Region ',i5,', flowType  ',i1)
1010 FORMAT('Region ',i5,', computeTv ',l1)
1030 FORMAT('Region ',i5,', intrplMixtModel ',i1)
1040 FORMAT('Region ',i5,', breakupModel ',i1)
1050 FORMAT('Region ',i5,', injectionModel ',i1)
1060 FORMAT('Region ',i5,', injcDiamMean/injcDiamMax  = ',f12.5)
1070 FORMAT('Region ',i5,', injcDiamMin /injcDiamMean = ',f12.5)

END SUBROUTINE plag_checkuserinput

!******************************************************************************
!
! RCS Revision history:
!
! $Log: PLAG_CheckUserInput.F90,v $
! Revision 1.7  2008/12/06 08:44:33  mtcampbe
! Updated license.
!
! Revision 1.6  2008/11/19 22:17:45  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.5  2005/11/30 22:18:04  fnajjar
! Added checks for intrplMixtModel
!
! Revision 1.4  2005/07/18 20:46:29  fnajjar
! Bug fix of nRegions for proper handling with MPI
!
! Revision 1.3  2005/04/27 18:35:57  fnajjar
! Included trap error for findPclMethod
!
! 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:22  fnajjar
! Initial revision after changing case
!
! Revision 1.12  2004/07/30 22:47:36  jferry
! Implemented Equilibrium Eulerian method for Rocflu
!
! Revision 1.11  2004/06/17 15:19:03  fnajjar
! Added infrastructure for ejection model
!
! Revision 1.10  2004/06/17 14:31:25  fnajjar
! Redefined error parameter from ERR_PLAG_INJCMODEL to ERR_PLAG_INCJDIAMDIST
!
! Revision 1.9  2004/06/16 23:03:49  fnajjar
! Renamed variabled for CRE kernel
!
! Revision 1.8  2004/03/05 22:09:03  jferry
! created global variables for peul, plag, and inrt use
!
! Revision 1.7  2004/03/03 23:55:40  jferry
! Allowed particles to be run with Euler case
!
! Revision 1.6  2003/09/18 20:18:42  fnajjar
! Change msg to STDOUT for WRITE statement
!
! Revision 1.5  2003/09/18 20:16:53  fnajjar
! Bug fix for ratio in injection model
!
! Revision 1.4  2003/09/17 21:05:45  fnajjar
! Added error trap for injection model
!
! Revision 1.3  2003/09/13 20:14:21  fnajjar
! Added infrastructure for Breakup model
!
! Revision 1.2  2003/09/10 23:35:50  fnajjar
! Removed flags that are subsumed with Rocinteract
!
! Revision 1.1  2002/10/25 14:14:44  f-najjar
! Initial Import of Rocpart
!
!******************************************************************************