!-------------------------------------------------------------------
! manages reading and interpolation of prescribed ozone
! Created by: Francis Vitt
!-------------------------------------------------------------------
module prescribed_ozone 7,5
use shr_kind_mod
, only : r8 => shr_kind_r8
use abortutils, only : endrun
use spmd_utils, only : masterproc
use tracer_data, only : trfld, trfile
use cam_logfile, only : iulog
implicit none
private
save
type(trfld), pointer :: fields(:)
type(trfile) :: file
public :: prescribed_ozone_init
public :: prescribed_ozone_adv
public :: write_prescribed_ozone_restart
public :: read_prescribed_ozone_restart
public :: has_prescribed_ozone
public :: prescribed_ozone_register
public :: init_prescribed_ozone_restart
public :: prescribed_ozone_readnl
logical :: has_prescribed_ozone = .false.
character(len=8), parameter :: ozone_name = 'ozone'
character(len=16) :: fld_name = 'ozone'
character(len=256) :: filename = ' '
character(len=256) :: filelist = ' '
character(len=256) :: datapath = ' '
character(len=32) :: data_type = 'SERIAL'
logical :: rmv_file = .false.
integer :: start_ymd = 0
integer :: start_tod = 0
contains
!-------------------------------------------------------------------
!-------------------------------------------------------------------
subroutine prescribed_ozone_register() 1,3
use ppgrid, only: pver
use phys_buffer, only: pbuf_add
integer :: oz_idx
if (has_prescribed_ozone) then
call pbuf_add(ozone_name,'physpkg',1,pver,1,oz_idx)
endif
endsubroutine prescribed_ozone_register
!-------------------------------------------------------------------
!-------------------------------------------------------------------
subroutine prescribed_ozone_init() 1,7
use tracer_data, only : trcdata_init
use cam_history, only : addfld, phys_decomp
use ppgrid, only : pver
use error_messages, only: handle_err
use ppgrid, only: pcols, pver, begchunk, endchunk
implicit none
integer :: ndx, istat
character(len=32) :: specifier(1)
if ( has_prescribed_ozone ) then
if ( masterproc ) then
write(iulog,*) 'ozone is prescribed in :'//trim(filename)
endif
else
return
endif
specifier(1) = trim(ozone_name)//':'//trim(fld_name)
file%in_pbuf = .true.
call trcdata_init( specifier, filename, filelist, datapath, fields, file, &
rmv_file, start_ymd, start_tod, data_type )
call addfld(ozone_name,'mol/mol ', pver, &
'I', 'prescribed ozone', phys_decomp )
end subroutine prescribed_ozone_init
!-------------------------------------------------------------------
!-------------------------------------------------------------------
subroutine prescribed_ozone_readnl(nlfile) 1,15
use namelist_utils, only: find_group_name
use units, only: getunit, freeunit
use mpishorthand
character(len=*), intent(in) :: nlfile ! filepath for file containing namelist input
! Local variables
integer :: unitn, ierr
character(len=*), parameter :: subname = 'prescribed_ozone_readnl'
character(len=16) :: prescribed_ozone_name
character(len=256) :: prescribed_ozone_file
character(len=256) :: prescribed_ozone_filelist
character(len=256) :: prescribed_ozone_datapath
character(len=32) :: prescribed_ozone_type
logical :: prescribed_ozone_rmfile
integer :: prescribed_ozone_ymd
integer :: prescribed_ozone_tod
namelist /prescribed_ozone_nl/ &
prescribed_ozone_name, &
prescribed_ozone_file, &
prescribed_ozone_filelist, &
prescribed_ozone_datapath, &
prescribed_ozone_type, &
prescribed_ozone_rmfile, &
prescribed_ozone_ymd, &
prescribed_ozone_tod
!-----------------------------------------------------------------------------
! Initialize namelist variables from local module variables.
prescribed_ozone_name = fld_name
prescribed_ozone_file = filename
prescribed_ozone_filelist = filelist
prescribed_ozone_datapath = datapath
prescribed_ozone_type = data_type
prescribed_ozone_rmfile = rmv_file
prescribed_ozone_ymd = start_ymd
prescribed_ozone_tod = start_tod
! Read namelist
if (masterproc) then
unitn = getunit()
open( unitn, file=trim(nlfile), status='old' )
call find_group_name(unitn, 'prescribed_ozone_nl', status=ierr)
if (ierr == 0) then
read(unitn, prescribed_ozone_nl, iostat=ierr)
if (ierr /= 0) then
call endrun(subname // ':: ERROR reading namelist')
end if
end if
close(unitn)
call freeunit(unitn)
end if
#ifdef SPMD
! Broadcast namelist variables
call mpibcast(prescribed_ozone_name, len(prescribed_ozone_name), mpichar, 0, mpicom)
call mpibcast(prescribed_ozone_file, len(prescribed_ozone_file), mpichar, 0, mpicom)
call mpibcast(prescribed_ozone_filelist, len(prescribed_ozone_filelist), mpichar, 0, mpicom)
call mpibcast(prescribed_ozone_datapath, len(prescribed_ozone_datapath), mpichar, 0, mpicom)
call mpibcast(prescribed_ozone_type, len(prescribed_ozone_type), mpichar, 0, mpicom)
call mpibcast(prescribed_ozone_rmfile, 1, mpilog, 0, mpicom)
call mpibcast(prescribed_ozone_ymd, 1, mpiint, 0, mpicom)
call mpibcast(prescribed_ozone_tod, 1, mpiint, 0, mpicom)
#endif
! Update module variables with user settings.
fld_name = prescribed_ozone_name
filename = prescribed_ozone_file
filelist = prescribed_ozone_filelist
datapath = prescribed_ozone_datapath
data_type = prescribed_ozone_type
rmv_file = prescribed_ozone_rmfile
start_ymd = prescribed_ozone_ymd
start_tod = prescribed_ozone_tod
! Turn on prescribed volcanics if user has specified an input dataset.
if (len_trim(filename) > 0 ) has_prescribed_ozone = .true.
end subroutine prescribed_ozone_readnl
!-------------------------------------------------------------------
!-------------------------------------------------------------------
subroutine prescribed_ozone_adv( state ) 1,12
use tracer_data, only : advance_trcdata
use physics_types,only : physics_state
use ppgrid, only : begchunk, endchunk
use ppgrid, only : pcols, pver
use string_utils, only : to_lower, GLC
use cam_history, only : outfld
use physconst, only : amass => mwdry ! molecular weight dry air ~ kg/kmole
use physconst, only : boltz ! J/K/molecule
implicit none
type(physics_state), intent(in):: state(begchunk:endchunk)
integer :: c,ncol
real(r8) :: to_mmr(pcols,pver)
real(r8), parameter :: molmass = 47.9981995_r8
if( .not. has_prescribed_ozone ) return
call advance_trcdata( fields, file, state )
! copy prescribed tracer fields into state svariable with the correct units
do c = begchunk,endchunk
ncol = state(c)%ncol
select case ( to_lower(trim(fields(1)%units(:GLC(fields(1)%units)))) )
case ("molec/cm3","/cm3","molecules/cm3","cm^-3","cm**-3")
to_mmr(:ncol,:) = (molmass*1.e6_r8*boltz*state(c)%t(:ncol,:))/(amass*state(c)%pmiddry(:ncol,:))
case ('kg/kg','mmr')
to_mmr(:ncol,:) = 1._r8
case ('mol/mol','mole/mole','vmr','fraction')
to_mmr(:ncol,:) = molmass/amass
case default
write(iulog,*) 'prescribed_ozone_adv: units = ',trim(fields(1)%units) ,' are not recognized'
call endrun('prescribed_ozone_adv: units are not recognized')
end select
fields(1)%data(:ncol,:,c+fields(1)%chnk_offset) = to_mmr(:ncol,:) * fields(1)%data(:ncol,:,c+fields(1)%chnk_offset) ! mmr
call outfld( ozone_name, (amass/molmass)*fields(1)%data(:ncol,:,c+fields(1)%chnk_offset), ncol, state(c)%lchnk )
enddo
end subroutine prescribed_ozone_adv
!-------------------------------------------------------------------
subroutine init_prescribed_ozone_restart( piofile ) 1,2
use pio, only : file_desc_t
use tracer_data, only : init_trc_restart
implicit none
type(file_desc_t),intent(inout) :: pioFile ! pio File pointer
call init_trc_restart( 'prescribed_ozone', piofile, file )
end subroutine init_prescribed_ozone_restart
!-------------------------------------------------------------------
subroutine write_prescribed_ozone_restart( piofile ) 1,2
use tracer_data, only : write_trc_restart
use pio, only : file_desc_t
implicit none
type(file_desc_t) :: piofile
call write_trc_restart( piofile, file )
end subroutine write_prescribed_ozone_restart
!-------------------------------------------------------------------
subroutine read_prescribed_ozone_restart( pioFile ) 1,2
use tracer_data, only : read_trc_restart
use pio, only : file_desc_t
implicit none
type(file_desc_t) :: piofile
call read_trc_restart( 'prescribed_ozone', piofile, file )
end subroutine read_prescribed_ozone_restart
end module prescribed_ozone