ReadMultigridSection.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: read in user input related to multigrid and successive
!          grid refinement.
!
! Description: none.
!
! Input: user input file.
!
! Output: global = start level, cycle type, iterations before refinement.
!
! Notes: none.
!
!******************************************************************************
!
! $Id: ReadMultigridSection.F90,v 1.4 2008/12/06 08:44:09 mtcampbe Exp $
!
! Copyright: (c) 2001 by the University of Illinois
!
!******************************************************************************

SUBROUTINE readmultigridsection( global )

  USE moddatatypes
  USE modglobal, ONLY     : t_global
  USE modinterfaces, ONLY : readsection
  USE moderror
  USE modparameters
  IMPLICIT NONE

! ... parameters
  TYPE(t_global), POINTER :: global

! ... local variables
  CHARACTER(10) :: keys(3)

  LOGICAL :: defined(3)

  REAL(RFREAL) :: vals(3)

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

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

! specify keywords and search for them

  keys(1) = 'START'
  keys(2) = 'CYCLE'
  keys(3) = 'REFINE'
  
  CALL readsection( global,if_input,3,keys,vals,defined )

  IF (defined(1).eqv..true.) global%startLevel = max(1,int(abs(vals(1))))
  IF (defined(2).eqv..true.) THEN
                                       global%cycleType = mgcycle_no
    IF (vals(2)>0.9 .AND. vals(2)<1.1) global%cycleType = mgcycle_v
    IF (vals(2)>1.9 .AND. vals(2)<2.1) global%cycleType = mgcycle_w
  ENDIF
  IF (defined(3).eqv..true.) global%refineIter = int(abs(vals(3))+0.5_rfreal)

! finalize

  CALL deregisterfunction( global )

END SUBROUTINE readmultigridsection

!******************************************************************************
!
! RCS Revision history:
!
! $Log: ReadMultigridSection.F90,v $
! Revision 1.4  2008/12/06 08:44:09  mtcampbe
! Updated license.
!
! Revision 1.3  2008/11/19 22:17:23  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.2  2008/10/23 18:20:55  mtcampbe
! Crazy number of changes to track and fix initialization and
! restart bugs.  Many improperly formed logical expressions
! were fixed, and bug in allocation for data associated with
! the BC_INFLOWVELTEMP boundary condition squashed in
! RFLO_ReadBcInflowVelSection.F90.
!
! Revision 1.1  2004/12/01 16:50:33  haselbac
! Initial revision after changing case
!
! Revision 1.8  2003/11/20 16:40:35  mdbrandy
! Backing out RocfluidMP changes from 11-17-03
!
! Revision 1.5  2003/08/11 21:51:17  jblazek
! Added basic global grid smoothing scheme.
!
! Revision 1.4  2003/05/15 02:57:02  jblazek
! Inlined index function.
!
! Revision 1.3  2002/09/05 17:40:20  jblazek
! Variable global moved into regions().
!
! Revision 1.2  2002/01/11 17:18:31  jblazek
! Updated description of I/O variables.
!
! Revision 1.1  2002/01/02 16:00:03  jblazek
! Added input for multigrid parameters.
!
!******************************************************************************