INRT_DefineScouring.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: Defines the interaction Scouring
!
! Description: none.
!
! Input: region = data of current region.
!
! Output: modifies region%inrtInput%inrts
!
! Notes:
!
!   Whereas INRT_Initialize sets up everything generic to all interactions,
!   this routine sets up things specific to this interaction.
!
!   In particular, this is where the designer
!
!   (a) gives values for all the interactions parameters (or leaves them
!       as default values given in INRT_Initialize).  These parameters are
!       described in ModInteract.
!
!   (b) defines the Edges of the interaction.  Here the type of an Edge is
!       given (i.e., whether it transports mass, momentum, or energy), as well
!       as the indices of the Nodes at either end.  For each momentum Edge
!       he must call the routine INRT_FinishMomentumEdge.
!
!******************************************************************************
!
! $Id: INRT_DefineScouring.F90,v 1.5 2008/12/06 08:44:31 mtcampbe Exp $
!
! Copyright: (c) 2003 by the University of Illinois
!
!******************************************************************************

SUBROUTINE inrt_definescouring( region )

  USE moddatatypes
  USE moddatastruct, ONLY : t_region
  USE modglobal,     ONLY : t_global
  USE modinteract
  USE moderror
  USE inrt_modparameters

  USE inrt_modinterfaces, ONLY : inrt_allocateauxillary
  IMPLICIT NONE

! ... parameters
  TYPE(t_region), INTENT(INOUT) :: region

! ... loop variables
  INTEGER :: iplag,ipeul,iedge

! ... local variables
  INTEGER, PARAMETER :: nedges_max = 20

  CHARACTER(CHRLEN) :: rcsidentstring

  INTEGER :: nedges,nplag,npeul
  INTEGER :: matindplag,matindpeul
  INTEGER :: ipeularr(nedges_max),iplagarr(nedges_max)

  TYPE(t_inrt_input),    POINTER :: input
  TYPE(t_inrt_interact), POINTER :: inrt
  TYPE(t_inrt_edge),     POINTER :: edge
  TYPE(t_global),        POINTER :: global

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

  rcsidentstring = '$RCSfile: INRT_DefineScouring.F90,v $ $Revision: 1.5 $'

  global => region%global

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

! begin -----------------------------------------------------------------------

! allocate memory for edges, switches and data

  input => region%inrtInput
  inrt  => input%inrts(inrt_type_scouring)

  inrt%name = "Scouring"

  nplag = input%nPlag
  npeul = input%nPeul

! loop over smoke types iPeul looking for corresponding iPlag

  iedge = 0
  DO ipeul = 1,npeul

#ifdef RFLO
#ifdef PEUL
    matindpeul = region%peulInput%ptypes(ipeul)%material%index
#endif
#endif
#ifdef RFLU
    matindpeul = region%specInput%specType(ipeul)%pMaterial%index
#endif

    DO iplag = 1,nplag

#ifdef PLAG
      matindplag = region%plagInput%materialIndex(iplag)
#endif

      IF (matindplag == matindpeul) THEN

        iedge = iedge + 1

        IF (iedge > nedges_max) &
          CALL errorstop( global,err_exceeds_decl_mem,__line__ )

        ipeularr(iedge) = ipeul
        iplagarr(iedge) = iplag

        EXIT

      END IF ! matIndPlag

    END DO ! iPlag

  END DO ! iPeul

  nedges = iedge

  CALL inrt_allocateauxillary(global,inrt,nedges, &
    inrt_swi_scouring_total,inrt_dat_scouring_total0 + nedges)

! set parameters for this interaction:  see comment in ModInteract

! ** for this interaction, all parameters keep their default values **

! define Edges

  DO iedge = 1,nedges

    edge => inrt%edges(iedge)

    edge%tEdge    = inrt_edge_mass
    edge%iNode(1) = input%indPeul0 + ipeularr(iedge)
    edge%iNode(2) = input%indPlag0 + iplagarr(iedge)

  END DO ! iEdge

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

  CALL deregisterfunction( global )

END SUBROUTINE inrt_definescouring

!******************************************************************************
!
! RCS Revision history:
!
! $Log: INRT_DefineScouring.F90,v $
! Revision 1.5  2008/12/06 08:44:31  mtcampbe
! Updated license.
!
! Revision 1.4  2008/11/19 22:17:44  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.3  2006/02/15 20:39:49  wasistho
! put plag within ifdef
!
! Revision 1.2  2006/02/15 20:17:57  wasistho
! put peul within ifdef
!
! Revision 1.1  2004/12/01 21:56:24  fnajjar
! Initial revision after changing case
!
! Revision 1.5  2004/07/23 22:43:16  jferry
! Integrated rocspecies into rocinteract
!
! Revision 1.4  2003/04/02 22:32:03  jferry
! codified Activeness and Permission structures for rocinteract
!
! Revision 1.3  2003/03/24 23:30:52  jferry
! overhauled rocinteract to allow interaction design to use user input
!
! Revision 1.2  2003/03/11 16:09:39  jferry
! Added comments
!
! Revision 1.1  2003/03/04 22:12:35  jferry
! Initial import of Rocinteract
!
!******************************************************************************