Files
GEOS-Chem-adjoint-v35-note/code/global_o3_mod.f
2018-08-28 00:46:26 -04:00

221 lines
8.5 KiB
Fortran

! $Id: global_o3_mod.f,v 1.1 2009/06/09 21:51:53 daven Exp $
MODULE GLOBAL_O3_MOD
!
!******************************************************************************
! Module GLOBAL_O3_MOD contains variables and routines for reading the
! global monthly mean O3 concentration from disk. These are needed for the
! offline sulfate/aerosol simulation. (rjp, bmy, 3/27/03, 1/14/09)
!
! Module Variables:
! ===========================================================================
! (1 ) O3 (REAL*8) : Stores global monthly mean O3 field
!
! Module Routines:
! ===========================================================================
! (1 ) GET_GLOBAL_O3 : Reads global monthly mean HO3 from disk
! (2 ) INIT_GLOBAL_O3 : Allocates & initializes the HO3 array
! (3 ) CLEANUP_GLOBAL_O3 : Deallocates the HO3 array
!
! GEOS-CHEM modules referenced by global_O3_mod.f
! ============================================================================
! (1 ) bpch2_mod.f : Module containing routines for binary punch file I/O
! (2 ) directory_mod.f : Module containing GEOS-CHEM data & met field dirs
! (2 ) error_mod.f : Module containing NaN and other error check routines
! (3 ) transfer_mod.f : Module containing routines to cast & resize arrays
!
! NOTES:
! (1 ) Now references "directory_mod.f" (bmy, 7/20/04)
! (2 ) Now reads O3 data from "sulfate_sim_200508/offline" dir (bmy, 8/30/05)
! (3 ) Now make sure all USE statements are USE, ONLY (bmy, 10/3/05)
! (4 ) Bug fixes in GET_GLOBAL_O3 (bmy, 12/1/05)
! (5 ) Now reads O3 from MERGE files, which include stratospheric O3 from
! COMBO, for GEOS-3 and GEOS-4 met fields (phs, 1/19/07)
! (6 ) Bug fix in GET_GLOBAL_O3 (bmy, 1/14/09)
!******************************************************************************
!
IMPLICIT NONE
!=================================================================
! MODULE PRIVATE DECLARATIONS -- keep certain internal variables
! and routines from being seen outside "global_o3_mod.f"
!=================================================================
! PRIVATE module variables
PRIVATE :: INIT_GLOBAL_O3
!=================================================================
! MODULE VARIABLES
!=================================================================
! Array to store global monthly mean OH field
REAL*8, ALLOCATABLE :: O3(:,:,:)
!=================================================================
! MODULE ROUTINES -- follow below the "CONTAINS" statement
!=================================================================
CONTAINS
!------------------------------------------------------------------------------
SUBROUTINE GET_GLOBAL_O3( THISMONTH )
!
!******************************************************************************
! Subroutine GET_GLOBAL_O3 reads monthly mean O3 data fields.
! These are needed for simulations such as offline sulfate/aerosol.
! (bmy, 3/23/03, 1/14/09)
!
! Arguments as Input:
! ===========================================================================
! (1 ) THISMONTH (INTEGER) : Current month number (1-12)
!
! NOTES:
! (1 ) Minor bug fix in FORMAT statements (bmy, 3/23/03)
! (2 ) Cosmetic changes (bmy, 3/27/03)
! (3 ) Now references DATA_DIR from "directory_mod.f" (bmy, 7/20/04)
! (4 ) Now reads O3 data from "sulfate_sim_200508/offline" dir (bmy, 8/30/05)
! (5 ) Now make sure all USE statements are USE, ONLY (bmy, 10/3/05)
! (6 ) Tracer number for O3 is now 51. Also need to call TRANSFER_3D_TROP
! since the new O3 data file only goes up to LLTROP. (bmy, 11/18/05)
! (7 ) Modified to include stratospheric O3 -- Requires access to new
! MERGE.O3* files. (phs, 1/19/07)
! (8 ) Renamed GRID30LEV to GRIDREDUCED (bmy, 2/7/07)
! (9 ) Bug fix: don't call TRANSFER_3D if you use GRIDREDUCED (bmy, 1/14/09)
!******************************************************************************
!
! References to F90 modules
USE BPCH2_MOD, ONLY : GET_NAME_EXT, GET_RES_EXT
USE BPCH2_MOD, ONLY : GET_TAU0, READ_BPCH2
USE DIRECTORY_MOD, ONLY : DATA_DIR
USE TRANSFER_MOD, ONLY : TRANSFER_3D
IMPLICIT NONE
# include "CMN_SIZE" ! Size parameters
! Arguments
INTEGER, INTENT(IN) :: THISMONTH
! Local variables
REAL*4 :: ARRAY(IGLOB,JGLOB,LGLOB)
REAL*4 :: ARRAY2(IGLOB,JGLOB,LLPAR)
REAL*8 :: XTAU
CHARACTER(LEN=255) :: FILENAME
! First time flag
LOGICAL, SAVE :: FIRST = .TRUE.
!=================================================================
! GET_GLOBAL_O3 begins here!
!=================================================================
! Allocate O3 array, if this is the first call
IF ( FIRST ) THEN
CALL INIT_GLOBAL_O3
FIRST = .FALSE.
ENDIF
#if defined( GRIDREDUCED )
! Filename for 30-level model
FILENAME = TRIM( DATA_DIR ) //
& 'sulfate_sim_200508/offline/MERGE.O3.30L.' //
& GET_NAME_EXT() // '.' // GET_RES_EXT()
! Echo some information to the standard output
WRITE( 6, 110 ) TRIM( FILENAME )
110 FORMAT( ' - GET_GLOBAL_O3: Reading ', a )
! Get the TAU0 value for the start of the given month
! Assume "generic" year 1985 (TAU0 = [0, 744, ... 8016])
XTAU = GET_TAU0( THISMONTH, 1, 1985 )
! Read O3 data (v/v) from the binary punch file (tracer #51)
CALL READ_BPCH2( FILENAME, 'IJ-AVG-$', 51,
& XTAU, IGLOB, JGLOB,
& LLPAR, ARRAY2, QUIET=.TRUE. )
! Assign data from ARRAY to the module variable O3
! (don't have to fold layers in the stratosphere)
O3 = ARRAY2
#else
! Filename for full vertical grid
FILENAME = TRIM( DATA_DIR ) //
& 'sulfate_sim_200508/offline/MERGE.O3.' //
& GET_NAME_EXT() // '.' // GET_RES_EXT()
! Echo some information to the standard output
WRITE( 6, 110 ) TRIM( FILENAME )
110 FORMAT( ' - GET_GLOBAL_O3: Reading ', a )
! Get the TAU0 value for the start of the given month
! Assume "generic" year 1985 (TAU0 = [0, 744, ... 8016])
XTAU = GET_TAU0( THISMONTH, 1, 1985 )
! Read O3 data (v/v) from the binary punch file (tracer #51)
CALL READ_BPCH2( FILENAME, 'IJ-AVG-$', 51,
& XTAU, IGLOB, JGLOB,
& LGLOB, ARRAY, QUIET=.TRUE. )
! Assign data from ARRAY to the module variable O3
! (folding layers in the stratosphere)
CALL TRANSFER_3D( ARRAY, O3 )
#endif
! Return to calling program
END SUBROUTINE GET_GLOBAL_O3
!------------------------------------------------------------------------------
SUBROUTINE INIT_GLOBAL_O3
!
!******************************************************************************
! Subroutine INIT_GLOBAL_O3 allocates the O3 module array.
! (bmy, 7/13/04, 1/19/07)
!
! NOTES:
! (1 ) Now references ALLOC_ERR from "error_mod.f" (bmy, 7/13/04)
! (2 ) Now dimension O3 with LLTROP (bmy, 12/1/05)
! (3 ) Now dimension O3 with LLPAR (phs, 1/19/07)
!******************************************************************************
!
! References to F90 modules
USE ERROR_MOD, ONLY : ALLOC_ERR
# include "CMN_SIZE" ! Size parameters
! Local variables
INTEGER :: AS
!=================================================================
! INIT_GLOBAL_O3 begins here!
!=================================================================
ALLOCATE( O3( IIPAR, JJPAR, LLPAR ), STAT=AS )
IF ( AS /= 0 ) CALL ALLOC_ERR( 'O3' )
O3 = 0d0
! Return to calling program
END SUBROUTINE INIT_GLOBAL_O3
!------------------------------------------------------------------------------
SUBROUTINE CLEANUP_GLOBAL_O3
!
!******************************************************************************
! Subroutine CLEANUP_GLOBAL_O3 deallocates the O3 array. (bmy, 7/13/04)
!******************************************************************************
!
!=================================================================
! CLEANUP_GLOBAL_O3 begins here!
!=================================================================
IF ( ALLOCATED( O3 ) ) DEALLOCATE( O3 )
! Return to calling program
END SUBROUTINE CLEANUP_GLOBAL_O3
!------------------------------------------------------------------------------
END MODULE GLOBAL_O3_MOD