TURB_floLesGenCoFF.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: Get filter coefficients of face-face filtering.
!
! Description: The coefficients are obtained in i, j and k direction.
!              For each direction, distinction is made between the low delta
!              (1 or 2 grid-spacing) and high delta (2 or 4 grid-spacing).
!
! Input: region  = data of current region
!
! Output: turb%ffCofi1,2,4, turb%ffCofj1,2,4, turb%ffCofk1,2,4.
!
! Notes: This routine is only relevant if non-uniform filter is selected.
!
!******************************************************************************
!
! $Id: TURB_floLesGenCoFF.F90,v 1.5 2008/12/06 08:44:43 mtcampbe Exp $
!
! Copyright: (c) 2001 by the University of Illinois
!
!******************************************************************************

SUBROUTINE turb_flolesgencoff( region )

  USE moddatatypes
  USE moddatastruct, ONLY : t_region
  USE modglobal, ONLY     : t_global
  USE modinterfaces, ONLY : rflo_getdimensdummynodes, rflo_getnodeoffset
  USE turb_modinterfaces, ONLY : turb_flolesgencofflo, turb_flolesgencofclo, &
                                 turb_flolesgencoffhi, turb_flolesgencofchi
  USE modturbulence, ONLY : t_turb
  USE moderror
  USE modparameters
  USE turb_modparameters
  IMPLICIT NONE

! ... parameters
  TYPE(t_region), TARGET :: region

! ... loop variables

! ... local variables
  CHARACTER(CHRLEN)       :: rcsidentstring
  TYPE(t_global), POINTER :: global

  INTEGER           :: ibeg,iend,jbeg,jend,kbeg,kend
  INTEGER           :: idnbeg,idnend,jdnbeg,jdnend,kdnbeg,kdnend
  INTEGER           :: ilev,inoff,ijnoff,minidx,maxidx,segid
  INTEGER           :: homdir(diri:dirk),filterwidth(diri:dirk)
  TYPE(t_turb), POINTER     :: turb
  REAL(RFREAL), POINTER     :: segm(:,:),ffcofa(:,:),ffcofb(:,:)
  REAL(RFREAL), ALLOCATABLE :: ds(:)

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

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

  global => region%global
  CALL registerfunction( global,'TURB_FloLesGenCoFF',&
  'TURB_floLesGenCoFF.F90' )

! get indices, parameters and pointers ----------------------------------------

  ilev           =  region%currLevel
  homdir(:)      =  region%turbInput%homDir(:)
  filterwidth(:) =  region%turbInput%filterWidth(:)
  turb           => region%levels(ilev)%turb
  CALL rflo_getdimensdummynodes( region,ilev,idnbeg,idnend, &
                                 jdnbeg,jdnend,kdnbeg,kdnend )
  CALL rflo_getnodeoffset( region,ilev,inoff,ijnoff )

  minidx = min(idnbeg,jdnbeg,kdnbeg)-2   
  maxidx = max(idnend,jdnend,kdnend)+2   
  ALLOCATE( ds(minidx:maxidx) )

  ibeg = idnbeg
  iend = idnend
  jbeg = jdnbeg
  jend = jdnend
  kbeg = kdnbeg
  kend = kdnend

! filter coefficients in I direction

  IF (homdir(diri) == off) THEN
    IF (filterwidth(diri)==filwidth_one) THEN

! --- filter coefficients at I-faces
      segm   => region%levels(ilev)%turb%workK
      ffcofa => turb%ffCofi1I
      ffcofb => turb%ffCofi2I
      segid  =  1
      CALL turb_flolesgencofflo( global,diri,ibeg,iend,jbeg,jend,kbeg,kend, &
                       minidx,maxidx,segid,inoff,ijnoff,ds,segm,ffcofa,ffcofb )  

! --- filter coefficients at J-faces
      segm   => region%levels(ilev)%turb%workJ
      ffcofa => turb%ffCofi1J
      ffcofb => turb%ffCofi2J
      segid  =  2
      CALL turb_flolesgencofclo( global,diri,ibeg,iend,jbeg,jend,kbeg,kend, &
                       minidx,maxidx,segid,inoff,ijnoff,ds,segm,ffcofa,ffcofb )  

! --- filter coefficients at K-faces
      segm   => region%levels(ilev)%turb%workK
      ffcofa => turb%ffCofi1K
      ffcofb => turb%ffCofi2K
      segid  =  1
      CALL turb_flolesgencofclo( global,diri,ibeg,iend,jbeg,jend,kbeg,kend, &
                       minidx,maxidx,segid,inoff,ijnoff,ds,segm,ffcofa,ffcofb )  

    ELSEIF ((filterwidth(diri)==filwidth_two) .OR. &
            (filterwidth(diri)==filwidth_zero)) THEN

! --- filter coefficients at I-faces
      segm   => region%levels(ilev)%turb%workK
      ffcofa => turb%ffCofi2I
      ffcofb => turb%ffCofi4I
      segid  =  1
      CALL turb_flolesgencoffhi( global,diri,ibeg,iend,jbeg,jend,kbeg,kend, &
                       minidx,maxidx,segid,inoff,ijnoff,ds,segm,ffcofa,ffcofb )  

! --- filter coefficients at J-faces
      segm   => region%levels(ilev)%turb%workJ
      ffcofa => turb%ffCofi2J
      ffcofb => turb%ffCofi4J
      segid  =  2
      CALL turb_flolesgencofchi( global,diri,ibeg,iend,jbeg,jend,kbeg,kend, &
                       minidx,maxidx,segid,inoff,ijnoff,ds,segm,ffcofa,ffcofb )  

! --- filter coefficients at K-faces
      segm   => region%levels(ilev)%turb%workK
      ffcofa => turb%ffCofi2K
      ffcofb => turb%ffCofi4K
      segid  =  1
      CALL turb_flolesgencofchi( global,diri,ibeg,iend,jbeg,jend,kbeg,kend, &
                       minidx,maxidx,segid,inoff,ijnoff,ds,segm,ffcofa,ffcofb )  

    ENDIF
  ENDIF

! filter coefficients in J direction

  IF (homdir(dirj) == off) THEN
    IF (filterwidth(dirj)==filwidth_one) THEN

! --- filter coefficients at J-faces
      segm   => region%levels(ilev)%turb%workI
      ffcofa => turb%ffCofj1J
      ffcofb => turb%ffCofj2J
      segid  =  1
      CALL turb_flolesgencofflo( global,dirj,ibeg,iend,jbeg,jend,kbeg,kend, &
                       minidx,maxidx,segid,inoff,ijnoff,ds,segm,ffcofa,ffcofb )  

! --- filter coefficients at I-faces
      segm   => region%levels(ilev)%turb%workI
      ffcofa => turb%ffCofj1I
      ffcofb => turb%ffCofj2I
      segid  =  1
      CALL turb_flolesgencofclo( global,dirj,ibeg,iend,jbeg,jend,kbeg,kend, &
                       minidx,maxidx,segid,inoff,ijnoff,ds,segm,ffcofa,ffcofb )  

! --- filter coefficients at K-faces
      segm   => region%levels(ilev)%turb%workK
      ffcofa => turb%ffCofj1K
      ffcofb => turb%ffCofj2K
      segid  =  2
      CALL turb_flolesgencofclo( global,dirj,ibeg,iend,jbeg,jend,kbeg,kend, &
                       minidx,maxidx,segid,inoff,ijnoff,ds,segm,ffcofa,ffcofb )  

    ELSEIF ((filterwidth(dirj)==filwidth_two) .OR. &
            (filterwidth(dirj)==filwidth_zero)) THEN

! --- filter coefficients at J-faces
      segm   => region%levels(ilev)%turb%workI
      ffcofa => turb%ffCofj2J
      ffcofb => turb%ffCofj4J
      segid  =  1
      CALL turb_flolesgencoffhi( global,dirj,ibeg,iend,jbeg,jend,kbeg,kend, &
                       minidx,maxidx,segid,inoff,ijnoff,ds,segm,ffcofa,ffcofb )  

! --- filter coefficients at I-faces
      segm   => region%levels(ilev)%turb%workI
      ffcofa => turb%ffCofj2I
      ffcofb => turb%ffCofj4I
      segid  =  1
      CALL turb_flolesgencofchi( global,dirj,ibeg,iend,jbeg,jend,kbeg,kend, &
                       minidx,maxidx,segid,inoff,ijnoff,ds,segm,ffcofa,ffcofb )  

! --- filter coefficients at K-faces
      segm   => region%levels(ilev)%turb%workK
      ffcofa => turb%ffCofj2K
      ffcofb => turb%ffCofj4K
      segid  =  2
      CALL turb_flolesgencofchi( global,dirj,ibeg,iend,jbeg,jend,kbeg,kend, &
                       minidx,maxidx,segid,inoff,ijnoff,ds,segm,ffcofa,ffcofb )  

    ENDIF
  ENDIF

! filter coefficients in K direction

  IF (homdir(dirk) == off) THEN
    IF (filterwidth(dirk)==filwidth_one) THEN

! --- filter coefficients at K-faces
      segm   => region%levels(ilev)%turb%workJ
      ffcofa => turb%ffCofk1K
      ffcofb => turb%ffCofk2K
      segid  =  1
      CALL turb_flolesgencofflo( global,dirk,ibeg,iend,jbeg,jend,kbeg,kend, &
                       minidx,maxidx,segid,inoff,ijnoff,ds,segm,ffcofa,ffcofb )  

! --- filter coefficients at I-faces
      segm   => region%levels(ilev)%turb%workI
      ffcofa => turb%ffCofk1I
      ffcofb => turb%ffCofk2I
      segid  =  2
      CALL turb_flolesgencofclo( global,dirk,ibeg,iend,jbeg,jend,kbeg,kend, &
                       minidx,maxidx,segid,inoff,ijnoff,ds,segm,ffcofa,ffcofb )  

! --- filter coefficients at J-faces
      segm   => region%levels(ilev)%turb%workJ
      ffcofa => turb%ffCofk1J
      ffcofb => turb%ffCofk2J
      segid  =  1
      CALL turb_flolesgencofclo( global,dirk,ibeg,iend,jbeg,jend,kbeg,kend, &
                       minidx,maxidx,segid,inoff,ijnoff,ds,segm,ffcofa,ffcofb )  

    ELSEIF ((filterwidth(dirk)==filwidth_two) .OR. &
            (filterwidth(dirk)==filwidth_zero)) THEN

! --- filter coefficients at K-faces
      segm   => region%levels(ilev)%turb%workJ
      ffcofa => turb%ffCofk2K
      ffcofb => turb%ffCofk4K
      segid  =  1
      CALL turb_flolesgencoffhi( global,dirk,ibeg,iend,jbeg,jend,kbeg,kend, &
                       minidx,maxidx,segid,inoff,ijnoff,ds,segm,ffcofa,ffcofb )  

! --- filter coefficients at I-faces
      segm   => region%levels(ilev)%turb%workI
      ffcofa => turb%ffCofk2I
      ffcofb => turb%ffCofk4I
      segid  =  2
      CALL turb_flolesgencofchi( global,dirk,ibeg,iend,jbeg,jend,kbeg,kend, &
                       minidx,maxidx,segid,inoff,ijnoff,ds,segm,ffcofa,ffcofb )  

! --- filter coefficients at J-faces
      segm   => region%levels(ilev)%turb%workJ
      ffcofa => turb%ffCofk2J
      ffcofb => turb%ffCofk4J
      segid  =  1
      CALL turb_flolesgencofchi( global,dirk,ibeg,iend,jbeg,jend,kbeg,kend, &
                       minidx,maxidx,segid,inoff,ijnoff,ds,segm,ffcofa,ffcofb )  

    ENDIF
  ENDIF

! deallocate temporary arrays

  DEALLOCATE( ds )

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

  CALL deregisterfunction( global )

END SUBROUTINE turb_flolesgencoff

!******************************************************************************
!
! RCS Revision history:
!
! $Log: TURB_floLesGenCoFF.F90,v $
! Revision 1.5  2008/12/06 08:44:43  mtcampbe
! Updated license.
!
! Revision 1.4  2008/11/19 22:17:55  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.3  2004/08/04 02:50:49  wasistho
! removed turb%avgCoI,J,K replaced with turb%workI,J,K
!
! Revision 1.2  2004/03/12 02:55:36  wasistho
! changed rocturb routine names
!
! Revision 1.1  2004/03/08 23:35:45  wasistho
! changed turb nomenclature
!
! Revision 1.2  2003/08/29 01:41:29  wasistho
! Added TARGET attribute to region variable, since pointers are cached into it
!
! Revision 1.1  2002/10/14 23:55:29  wasistho
! Install Rocturb
!
!
!******************************************************************************