PERI_CheckParamInput.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 PERI parameters either specified by user or set in the code.
!
! Description: The checking includes the existency and order of parameters.
!
! Input: regions = input parameters contained in periInput of all regions.
!
! Output: Error msg.
!
! Notes: none.
!
!******************************************************************************
!
! $Id: PERI_CheckParamInput.F90,v 1.5 2008/12/06 08:44:36 mtcampbe Exp $
!
! Copyright: (c) 2001 by the University of Illinois
!
!******************************************************************************

SUBROUTINE peri_checkparaminput( regions )

  USE moddatatypes
  USE moddatastruct, ONLY : t_region
  USE modglobal, ONLY     : t_global
  USE modperiodic, ONLY   : t_peri_input
  USE modbndpatch, ONLY   : t_patch
  USE moderror
  USE modmpi
  USE modparameters
  USE peri_modparameters
  IMPLICIT NONE

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

! ... loop variables
  INTEGER :: ireg

! ... local variables
  CHARACTER(CHRLEN)       :: rcsidentstring
  TYPE(t_global), POINTER      :: global
  TYPE(t_peri_input), POINTER  :: input  
  TYPE(t_patch), POINTER       :: patches(:)

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

  rcsidentstring = '$RCSfile: PERI_CheckParamInput.F90,v $'

  global => regions(1)%global
  CALL registerfunction( global,'PERI_CheckParamInput',&
  'PERI_CheckParamInput.F90' )

! check fixed parameters setting ---------------------------------------------

  IF (cpr_rho /= 1 .OR. &
      cpr_ruc /= 2 .OR. &
      cpr_rvc /= 3 .OR. &
      cpr_uve /= 4 .OR. &
      cpr_vve /= 5 .OR. &
      cpr_tmp /= 6 .OR. &
      cpr_prs /= 7) THEN
    CALL errorstop( global,err_peri_fixparam,__line__,'cprVar id inconsistent' )
  ENDIF   

  IF (global%nProcAlloc /= global%nRegions) THEN
    CALL errorstop( global,err_peri_mpi,__line__, &
        'nProcAlloc should be = nRegions due to PERI_pgradUpdate procedure' )
  ENDIF
 
! check PERI parameter selection regionwise

#ifdef RFLO
  DO ireg=1,global%nRegions
    IF (regions(ireg)%procid==global%myProcid .AND. &   ! region active and
        regions(ireg)%active==active) THEN              ! on my processor

      patches => regions(ireg)%levels(1)%patches(:)
#endif
#ifdef RFLU
  DO ireg = lbound(regions,1),ubound(regions,1)

      patches => regions(ireg)%patches(:)
#endif

! --- check if injection (cpr) or noslip wall (channel) bc on correct patch

      IF ((patches(1)%bcType >= bc_injection  .AND. &
         patches(1)%bcType <= bc_injection+bc_range) .OR. &
        (patches(2)%bcType >= bc_injection  .AND. &
         patches(2)%bcType <= bc_injection+bc_range) .OR. &
        (patches(5)%bcType >= bc_injection  .AND. &
         patches(5)%bcType <= bc_injection+bc_range) .OR. &
        (patches(6)%bcType >= bc_injection  .AND. &
         patches(6)%bcType <= bc_injection+bc_range)) THEN
        CALL errorstop( regions(ireg)%global,err_peri_cprbc,__line__, &
                      'cpr injection bc should be on patch 3 and 4' )
      ENDIF

      IF ((patches(1)%bcType >= bc_noslipwall  .AND. &
         patches(1)%bcType <= bc_noslipwall+bc_range) .OR. &
        (patches(2)%bcType >= bc_noslipwall  .AND. &
         patches(2)%bcType <= bc_noslipwall+bc_range) .OR. &
        (patches(5)%bcType >= bc_noslipwall  .AND. &
         patches(5)%bcType <= bc_noslipwall+bc_range) .OR. &
        (patches(6)%bcType >= bc_noslipwall  .AND. &
         patches(6)%bcType <= bc_noslipwall+bc_range)) THEN
        CALL errorstop( regions(ireg)%global,err_peri_input,__line__, &
                      'channel noslip wall bc should be on patch 3 and 4' )
      ENDIF

! --- peri input check
    
      input => regions(ireg)%periInput

      IF ((input%flowKind < peri_flow_none).AND. &
          (input%flowKind > peri_flow_channel)) THEN
        CALL errorstop( global,err_peri_input,__line__, &
        'flowkind out of range' )
      ENDIF

      IF (input%flowKind == peri_flow_bola) THEN
        CALL errorstop( global,err_peri_input,__line__, &
        'boundary layer flow is not ready yet' )
      ENDIF

#ifdef RFLO
      IF (input%split(jcoord) /= off) THEN
        IF (input%split(icoord)/=off .OR. input%split(kcoord)/=off) THEN
          CALL errorstop( global,err_peri_input,__line__, &
          'cannot combine splitting domain in wall normal with other directions' )
        ENDIF
      ENDIF
#endif

      IF (input%flowKind == peri_flow_cpr) THEN
        IF (input%nVar /= cpr_nvar) THEN
          CALL errorstop( global,err_peri_input,__line__,'cpr nVar /= 7' )
        ENDIF
        IF (input%minjRate /= &
          patches(3)%mixt%vals(bcdat_inject_mfrate,0)) THEN
          CALL errorstop( global,err_peri_cprbc,__line__, &
          'mass injection rate in inj. patches different' )
        ENDIF
        IF (input%bulkmFlux < 0._rfreal) THEN
          CALL errorstop( global,err_peri_input,__line__,'cpr bulk mflux < 0' )
        ENDIF
        IF (input%cprEpsilon < 0._rfreal) THEN
          CALL errorstop( global,err_peri_input,__line__,'cpr epsilon < 0' )
        ENDIF
        IF (input%headPres < 0._rfreal) THEN
          CALL errorstop( global,err_peri_input,__line__,'cpr head pres. < 0' )
        ENDIF
        IF (input%headTemp < 0._rfreal) THEN
          CALL errorstop( global,err_peri_input,__line__,'cpr head temp. < 0' )
        ENDIF
      ELSEIF (input%flowKind == peri_flow_channel) THEN
        IF ((input%pgradType < 0) .OR. (input%pgradType > 1)) THEN
          CALL errorstop( global,err_peri_input,__line__, &
                          'PGRADTYPE should be 0 or 1' )
        ENDIF
      ENDIF

#ifdef RFLO
    ENDIF ! region active
#endif
  ENDDO   ! iReg

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

  CALL deregisterfunction( global )

END SUBROUTINE peri_checkparaminput

!******************************************************************************
!
! RCS Revision history:
!
! $Log: PERI_CheckParamInput.F90,v $
! Revision 1.5  2008/12/06 08:44:36  mtcampbe
! Updated license.
!
! Revision 1.4  2008/11/19 22:17:49  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.3  2006/08/19 15:40:08  mparmar
! Renamed patch variables
!
! Revision 1.2  2004/06/11 21:49:40  wasistho
! prepared for RFLU
!
! Revision 1.1  2004/06/08 23:56:56  wasistho
! changed nomenclature
!
! Revision 1.4  2003/10/17 20:25:39  wasistho
! generalize check of nregions = nprocs
!
! Revision 1.3  2003/09/18 01:56:17  wasistho
! added ijksplit and pgradType in PERI_PgradUpdate
!
! Revision 1.2  2003/04/03 00:31:07  wasistho
! enable channel flow
!
! Revision 1.1.1.1  2003/03/29 03:36:30  wasistho
! install ROCPERI
!
!
!
!******************************************************************************