RADI_UserInput.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 RADI user input and store it in RADI data structure.
!
! Description: RADI simulation parameters are first set to default values.
!              They are then overruled by user input parameters. Based
!              on this, derived RADI variables are defined. Finally,
!              necessary checkings are performed against inconsistencies.
!
! Input: regions = user input in all regions
!
! Output: regions = RADI user input, parameters and derived variables
!
! Notes: none.
!
!******************************************************************************
!
! $Id: RADI_UserInput.F90,v 1.3 2008/12/06 08:44:38 mtcampbe Exp $
!
! Copyright: (c) 2001 by the University of Illinois
!
!******************************************************************************

#ifdef RFLO
SUBROUTINE radi_userinput( regions )
#endif
#ifdef RFLU
SUBROUTINE radi_userinput
#endif

  USE moddatastruct, ONLY      : t_region
  USE modglobal, ONLY          : t_global
  USE radi_modinterfaces, ONLY : radi_initinputvalues, radi_readinputfile, &
                                 radi_derivedinputvalues, radi_checkparaminput
  USE moderror
  USE modparameters
  USE radi_modparameters
  IMPLICIT NONE

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

! ... loop variables
  INTEGER :: ireg

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

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

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

! initialize parameters --------------------------------------------------

#ifdef RFLO
  CALL radi_initinputvalues( regions )
#endif
#ifdef RFLU
  CALL radi_initinputvalues
#endif

! read user input

#ifdef RFLO
  CALL radi_readinputfile( regions )
#endif
#ifdef RFLU
  CALL radi_readinputfile
#endif

! perform global test whether radiation is active in any region

  DO ireg=1,global%nRegions
    IF (regions(ireg)%radiInput%radiModel /= radi_model_none) THEN
      global%radiActive = .true.
    ENDIF
  ENDDO

  IF (global%radiActive) THEN

! - set RADI derived parameters or variables based on user input

#ifdef RFLO
    CALL radi_derivedinputvalues( regions )
#endif
#ifdef RFLU
    CALL radi_derivedinputvalues
#endif

! - check user input and parameters set in the code

#ifdef RFLO
    CALL radi_checkparaminput( regions )
#endif
#ifdef RFLU
    CALL radi_checkparaminput
#endif

  ENDIF  ! radiActive

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

  CALL deregisterfunction( global )

END SUBROUTINE radi_userinput

!******************************************************************************
!
! RCS Revision history:
!
! $Log: RADI_UserInput.F90,v $
! Revision 1.3  2008/12/06 08:44:38  mtcampbe
! Updated license.
!
! Revision 1.2  2008/11/19 22:17:50  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.1  2004/09/22 02:35:50  wasistho
! changed file nomenclature from lower to upper case
!
! Revision 1.2  2003/08/01 22:16:25  wasistho
! prepared rocrad for Genx
!
! Revision 1.1  2003/07/17 01:16:59  wasistho
! initial activation rocrad
!
!
!
!******************************************************************************