RFLU_ResidualNorm.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: Compute the L2-norm of the density changes.
!
! Description: None.
!
! Input: 
!   regions     Array of regions
!
! Output: None.
!
! Notes: None.
!
! ******************************************************************************
!
! $Id: RFLU_ResidualNorm.F90,v 1.8 2008/12/06 08:44:30 mtcampbe Exp $
!
! Copyright: (c) 2002-2005 by the University of Illinois
!
! ******************************************************************************

SUBROUTINE rflu_residualnorm(regions)

  USE moddatatypes
  USE moddatastruct, ONLY: t_region
  USE modglobal, ONLY: t_global
  USE moderror
  USE modmpi
  USE modparameters

  IMPLICIT NONE

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

! ==============================================================================
! Arguments
! ==============================================================================

  TYPE(t_region), POINTER :: regions(:)

! ==============================================================================
! Locals
! ==============================================================================

  CHARACTER(CHRLEN) :: rcsidentstring
  INTEGER :: errorflag,icg,ireg
  REAL(RFREAL) :: dr,drsum,drsumtot
  REAL(RFREAL), DIMENSION(:,:), POINTER :: pcv,pcvold
  TYPE(t_global), POINTER :: global

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

  rcsidentstring = '$RCSfile: RFLU_ResidualNorm.F90,v $ $Revision: 1.8 $'

  global => regions(1)%global

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

! ******************************************************************************
! Sum density changes over local regions 
! ******************************************************************************

  drsum = 0.0_rfreal

  DO ireg = 1,global%nRegionsLocal
    pcv    => regions(ireg)%mixt%cv
    pcvold => regions(ireg)%mixt%cvOld

    DO icg = 1,regions(ireg)%grid%nCells
      dr    = pcv(cv_mixt_dens,icg) - pcvold(cv_mixt_dens,icg)
      drsum = drsum + dr*dr
    END DO ! icg
  END DO ! iReg

! ******************************************************************************
! Reduce across processes 
! ******************************************************************************

  IF ( global%nRegions > 1 ) THEN 
    CALL mpi_allreduce(drsum,drsumtot,1,mpi_rfreal,mpi_sum,global%mpiComm, &
                       errorflag)
    global%error = errorflag
    IF ( global%error /= err_none ) THEN 
      CALL errorstop(global,err_mpi_output,__line__)
    END IF ! global%error
  ELSE
    drsumtot = drsum
  END IF ! global%nRegions

! ******************************************************************************
! Finalize
! ******************************************************************************

  global%residual = sqrt(drsumtot)

  IF ( global%currentIter == 1 ) THEN
    global%resInit = global%residual
  END IF ! global

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

  CALL deregisterfunction(global)

END SUBROUTINE rflu_residualnorm

! ******************************************************************************
!
! RCS Revision history:
!
! $Log: RFLU_ResidualNorm.F90,v $
! Revision 1.8  2008/12/06 08:44:30  mtcampbe
! Updated license.
!
! Revision 1.7  2008/11/19 22:17:43  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.6  2006/04/07 15:19:22  haselbac
! Removed tabs
!
! Revision 1.5  2005/04/15 15:07:24  haselbac
! Converted to MPI
!
! Revision 1.4  2002/09/09 15:51:56  haselbac
! global now under region
!
! Revision 1.3  2002/07/25 14:30:40  haselbac
! Added FEM call to find proper residual norm for parallel runs
!
! Revision 1.2  2002/06/14 20:19:59  haselbac
! Deleted ModLocal, changed local%nRegions to global%nRegionsLocal
!
! Revision 1.1  2002/05/04 17:01:59  haselbac
! Initial revision
!
! ******************************************************************************