RFLU_ModPETScAdmin.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: Suite of routines to handle interaction with PETSc.
!
! Description: None.
!
! Notes: None. 
!
! ******************************************************************************
!
! $Id: RFLU_ModPETScAdmin.F90,v 1.4 2008/12/06 08:44:23 mtcampbe Exp $
!
! Copyright: (c) 2004 by the University of Illinois
!
! ******************************************************************************

MODULE rflu_modpetscadmin

  USE modglobal, ONLY: t_global 
  USE modparameters
  USE moddatatypes
  USE moderror
  USE modbndpatch, ONLY: t_patch
  USE moddatastruct, ONLY: t_region
  USE modgrid, ONLY: t_grid
  USE modmpi

  IMPLICIT NONE
   
  PRIVATE
  PUBLIC ::  rflu_petsc_finalize, & 
             rflu_petsc_init
      
#include "include/finclude/petsc.h"    
         
! ******************************************************************************
! Declarations and definitions
! ******************************************************************************  
     
  CHARACTER(CHRLEN) :: & 
    RCSIdentString = '$RCSfile: RFLU_ModPETScAdmin.F90,v $ $Revision: 1.4 $'               
       
! ******************************************************************************
! Routines
! ******************************************************************************

  CONTAINS
  




! ******************************************************************************
!
! Purpose: Finalize PETSc.
!
! Description: None.
!
! Input:
!   global      Pointer to global data
!
! Output: None.
!
! Notes: None.
!
! ******************************************************************************

  SUBROUTINE rflu_petsc_finalize(global)

    IMPLICIT NONE

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

! ==============================================================================
!   Parameters      
! ==============================================================================

    TYPE(t_global), POINTER :: global
    
! ==============================================================================
!   Locals      
! ==============================================================================

    INTEGER :: errorflag

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

    CALL registerfunction(global,'RFLU_PETSC_Finalize',&
  'RFLU_ModPETScAdmin.F90')

    IF ( global%myProcid == masterproc .AND. & 
         global%verbLevel > verbose_low ) THEN
      WRITE(stdout,'(A,1X,A)') solver_name,'Finalizing PETSc...' 
    END IF ! global%verbLevel

! ******************************************************************************
!   Initialize PETSc
! ******************************************************************************

    CALL petscfinalize(errorflag)
    global%error = errorflag
    IF ( global%error /= err_none ) THEN 
      CALL errorstop(global,err_petsc_output,__line__)
    END IF ! global%error    

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

    IF ( global%myProcid == masterproc .AND. & 
         global%verbLevel > verbose_low ) THEN  
      WRITE(stdout,'(A,1X,A)') solver_name,'Finalizing PETSc done.'
    END IF ! global%verbLevel

    CALL deregisterfunction(global)

  END SUBROUTINE rflu_petsc_finalize






! ******************************************************************************
!
! Purpose: Initialize PETSc.
!
! Description: None.
!
! Input:
!   global      Pointer to global data
!
! Output: None.
!
! Notes: None.
!
! ******************************************************************************

  SUBROUTINE rflu_petsc_init(global)

    IMPLICIT NONE

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

! ==============================================================================
!   Parameters      
! ==============================================================================

    TYPE(t_global), POINTER :: global
    
! ==============================================================================
!   Locals      
! ==============================================================================

    INTEGER :: errorflag

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

    CALL registerfunction(global,'RFLU_PETSC_Init',&
  'RFLU_ModPETScAdmin.F90')

    IF ( global%myProcid == masterproc .AND. & 
         global%verbLevel > verbose_low ) THEN
      WRITE(stdout,'(A,1X,A)') solver_name,'Initializing PETSc...' 
    END IF ! global%verbLevel

! ******************************************************************************
!   Initialize PETSc
! ******************************************************************************

    CALL petscinitialize(petsc_null_character,errorflag)
    global%error = errorflag
    IF ( global%error /= err_none ) THEN 
      CALL errorstop(global,err_petsc_output,__line__)
    END IF ! global%error    

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

    IF ( global%myProcid == masterproc .AND. & 
         global%verbLevel > verbose_low ) THEN  
      WRITE(stdout,'(A,1X,A)') solver_name,'Initializing PETSc done.'
    END IF ! global%verbLevel

    CALL deregisterfunction(global)

  END SUBROUTINE rflu_petsc_init
  
  
  

! ******************************************************************************
! End
! ******************************************************************************
  
END MODULE rflu_modpetscadmin


! ******************************************************************************
!
! RCS Revision history:
!
! $Log: RFLU_ModPETScAdmin.F90,v $
! Revision 1.4  2008/12/06 08:44:23  mtcampbe
! Updated license.
!
! Revision 1.3  2008/11/19 22:17:34  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.2  2006/04/07 15:19:20  haselbac
! Removed tabs
!
! Revision 1.1  2004/12/19 15:40:45  haselbac
! Initial revision
!
! ******************************************************************************