RFLU_DecideNeedBGradFace.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: Determine whether need boundary face gradients and related functions
!
! Description: None.
!
! Input:
!   pRegion                     Pointer to region data
!   pPatch                      Pointer to Patch data
!
! Output: 
!
! Notes: None.
!
!******************************************************************************
!
! $Id: RFLU_DecideNeedBGradFace.F90,v 1.3 2008/12/06 08:44:12 mtcampbe Exp $
!
! Copyright: (c) 2003-2004 by the University of Illinois
!
!******************************************************************************

LOGICAL FUNCTION rflu_decideneedbgradface(pRegion,pPatch)

  USE moddatatypes
  USE moderror
  USE modparameters
  USE modglobal, ONLY: t_global
  USE modbndpatch, ONLY: t_patch
  USE moddatastruct, ONLY: t_region
      
  IMPLICIT NONE

! *****************************************************************************
! Declarations and definitions
! *****************************************************************************

! =============================================================================
! Arguments
! =============================================================================

  TYPE(t_patch), POINTER :: ppatch
  TYPE(t_region), POINTER :: pregion

! =============================================================================
! Locals
! =============================================================================

  CHARACTER(CHRLEN) :: rcsidentstring
  TYPE(t_global), POINTER :: global

! *****************************************************************************
! Start
! *****************************************************************************

  global => pregion%global

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

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

! *****************************************************************************
! Initialize
! *****************************************************************************

  rflu_decideneedbgradface = .false.
  
! *****************************************************************************
! Determine whether need boundary face gradients 
! *****************************************************************************

! =============================================================================
! Flow Model - true if Navier Stokes
! =============================================================================

  IF ( pregion%mixtInput%flowModel == flow_navst ) THEN
    rflu_decideneedbgradface = .true.
  END IF ! pRegion%mixtInput%flowModel 

! =============================================================================
! Boundary Condition Kind - true if NSCBC
! =============================================================================

  IF ( ppatch%bcKind == bc_kind_nscbc ) THEN
    rflu_decideneedbgradface = .true.
  END IF ! pPatch%bcKind

! =============================================================================
! Virtual boundary - always false
! =============================================================================

  IF ( ppatch%bcType == bc_virtual ) THEN
    rflu_decideneedbgradface = .false.
  END IF ! pPatch%bcType

! *****************************************************************************
! End
! *****************************************************************************

  CALL deregisterfunction(global)

END FUNCTION rflu_decideneedbgradface

!******************************************************************************
!
! RCS Revision history:
!
! $Log: RFLU_DecideNeedBGradFace.F90,v $
! Revision 1.3  2008/12/06 08:44:12  mtcampbe
! Updated license.
!
! Revision 1.2  2008/11/19 22:17:25  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.1  2006/08/19 15:37:35  mparmar
! Initial revision
!
!******************************************************************************