module m_pcpNode !$$$ subprogram documentation block ! . . . . ! subprogram: module m_pcpNode ! prgmmr: j guo ! org: NASA/GSFC, Global Modeling and Assimilation Office, 610.3 ! date: 2016-05-18 ! ! abstract: class-module of obs-type pcpNode (precipitation) ! ! program history log: ! 2016-05-18 j guo - added this document block for the initial polymorphic ! implementation. ! ! input argument list: see Fortran 90 style document below ! ! output argument list: see Fortran 90 style document below ! ! attributes: ! language: Fortran 90 and/or above ! machine: ! !$$$ end subprogram documentation block ! module interface: use m_obsdiagNode, only: obs_diag use m_obsdiagNode, only: obs_diags use kinds , only: i_kind,r_kind use mpeu_util, only: assert_,die,perr,warn,tell use m_obsNode, only: obsNode implicit none private public:: pcpNode type,extends(obsNode):: pcpNode !type(pcp_ob_type),pointer :: llpoint => NULL() type(obs_diag), pointer :: diags => NULL() real(r_kind) :: obs ! observed precipitation value real(r_kind) :: err2 ! error variances squared real(r_kind) :: raterr2 ! ratio of error variances squared !real(r_kind) :: time ! observation time in sec real(r_kind) :: ges ! guess observation value real(r_kind) :: wij(4) ! horizontal interpolation weights real(r_kind),dimension(:),pointer :: predp => NULL() ! predictors (npredp) real(r_kind),dimension(:),pointer :: dpcp_dvar => NULL() ! error variances squared (nsig5) integer(i_kind) :: ij(4) ! horizontal locations integer(i_kind) :: icxp ! type of precipitation rate observation !logical :: luse ! flag indicating if ob is used in pen. !integer(i_kind) :: idv,iob ! device id and obs index for sorting !real (r_kind) :: elat, elon ! earth lat-lon for redistribution !real (r_kind) :: dlat, dlon ! earth lat-lon for redistribution contains procedure,nopass:: mytype procedure:: setHop => obsNode_setHop_ procedure:: xread => obsNode_xread_ procedure:: xwrite => obsNode_xwrite_ procedure:: isvalid => obsNode_isvalid_ procedure:: gettlddp => gettlddp_ procedure, nopass:: headerRead => obsHeader_read_ procedure, nopass:: headerWrite => obsHeader_write_ procedure:: init => obsNode_init_ procedure:: clean => obsNode_clean_ end type pcpNode public:: pcpNode_typecast public:: pcpNode_nextcast interface pcpNode_typecast; module procedure typecast_ ; end interface interface pcpNode_nextcast; module procedure nextcast_ ; end interface public:: pcpNode_appendto interface pcpNode_appendto; module procedure appendto_ ; end interface character(len=*),parameter:: MYNAME="m_pcpNode" #include "myassert.H" #include "mytrace.H" contains function typecast_(aNode) result(ptr_) !-- cast a class(obsNode) to a type(pcpNode) use m_obsNode, only: obsNode implicit none type(pcpNode ),pointer:: ptr_ class(obsNode),pointer,intent(in):: aNode ptr_ => null() if(.not.associated(aNode)) return ! logically, typecast of a null-reference is a null pointer. select type(aNode) type is(pcpNode) ptr_ => aNode end select return end function typecast_ function nextcast_(aNode) result(ptr_) !-- cast an obsNode_next(obsNode) to a type(pcpNode) use m_obsNode, only: obsNode,obsNode_next implicit none type(pcpNode ),pointer:: ptr_ class(obsNode),target ,intent(in):: aNode class(obsNode),pointer:: inode_ inode_ => obsNode_next(aNode) ptr_ => typecast_(inode_) return end function nextcast_ subroutine appendto_(aNode,oll) !-- append aNode to linked-list oLL use m_obsNode , only: obsNode use m_obsLList, only: obsLList,obsLList_appendNode implicit none type(pcpNode),pointer,intent(in):: aNode type(obsLList),intent(inout):: oLL class(obsNode),pointer:: inode_ inode_ => aNode call obsLList_appendNode(oLL,inode_) inode_ => null() end subroutine appendto_ ! obsNode implementations function mytype() implicit none character(len=:),allocatable:: mytype mytype="[pcpNode]" end function mytype subroutine obsHeader_read_(iunit,mobs,jread,istat) use gridmod, only: nsig5 use pcpinfo, only: npredp implicit none integer(i_kind),intent(in ):: iunit integer(i_kind),intent(out):: mobs integer(i_kind),intent(out):: jread integer(i_kind),intent(out):: istat character(len=*),parameter:: myname_=myname//'.obsHeader_read_' integer(i_kind):: mpredp,msig5 _ENTRY_(myname_) read(iunit,iostat=istat) mobs,jread, mpredp,msig5 if(istat==0 .and. (npredp/=mpredp .or. nsig5/=msig5)) then call perr(myname_,'unmatched dimension information, npredp or nsig5') if(npredp/=mpredp) then call perr(myname_,' expecting npredp =',npredp) call perr(myname_,' but read mpredp =',mpredp) endif if(nsig5/=msig5) then call perr(myname_,' expecting nsig5 =',nsig5) call perr(myname_,' but read msig5 =',msig5) endif call die(myname_) endif _EXIT_(myname_) return end subroutine obsHeader_read_ subroutine obsHeader_write_(junit,mobs,jwrite,jstat) use gridmod, only: nsig5 use pcpinfo, only: npredp implicit none integer(i_kind),intent(in ):: junit integer(i_kind),intent(in ):: mobs integer(i_kind),intent(in ):: jwrite integer(i_kind),intent(out):: jstat character(len=*),parameter:: myname_=myname//'.obsHeader_write_' _ENTRY_(myname_) write(junit,iostat=jstat) mobs,jwrite, npredp,nsig5 _EXIT_(myname_) return end subroutine obsHeader_write_ subroutine obsNode_init_(aNode) use gridmod, only: nsig5 use pcpinfo, only: npredp implicit none class(pcpNode),intent(out):: aNode character(len=*),parameter:: myname_=myname//'.obsNode_init_' _ENTRY_(myname_) !aNode = _obsNode_() aNode%llpoint => null() aNode%luse = .false. aNode%time = 0._r_kind aNode%elat = 0._r_kind aNode%elon = 0._r_kind aNode%idv =-1 aNode%iob =-1 !-aNode%dlev = 0._r_kind !-aNode%ich =-1._i_kind allocate(aNode%predp(npredp), & aNode%dpcp_dvar(1:nsig5) ) _EXIT_(myname_) return end subroutine obsNode_init_ subroutine obsNode_clean_(aNode) implicit none class(pcpNode),intent(inout):: aNode character(len=*),parameter:: myname_=myname//'.obsNode_clean_' _ENTRY_(myname_) !_TRACEV_(myname_,'%mytype() =',aNode%mytype()) if(associated(aNode%predp )) deallocate(aNode%predp) if(associated(aNode%dpcp_dvar)) deallocate(aNode%dpcp_dvar) _EXIT_(myname_) return end subroutine obsNode_clean_ subroutine obsNode_xread_(aNode,iunit,istat,diagLookup,skip) use m_obsdiagNode, only: obsdiagLookup_locate implicit none class(pcpNode) , intent(inout):: aNode integer(i_kind) , intent(in ):: iunit integer(i_kind) , intent( out):: istat type(obs_diags) , intent(in ):: diagLookup logical,optional, intent(in ):: skip character(len=*),parameter:: myname_=MYNAME//'.obsNode_xread_' logical:: skip_ _ENTRY_(myname_) skip_=.false. if(present(skip)) skip_=skip istat=0 if(skip_) then read(iunit,iostat=istat) if(istat/=0) then call perr(myname_,'skipping read(%(res,err2,...)), iostat =',istat) _EXIT_(myname_) return endif else read(iunit,iostat=istat) aNode%obs , & aNode%err2 , & aNode%raterr2, & aNode%ges , & aNode%icxp , & aNode%predp(:) , & aNode%dpcp_dvar(:), & aNode%wij(:) , & aNode%ij(:) if (istat/=0) then call perr(myname_,'read(%(res,err2,...)), iostat =',istat) _EXIT_(myname_) return end if aNode%diags => obsdiagLookup_locate(diagLookup,aNode%idv,aNode%iob,1_i_kind) if(.not.associated(aNode%diags)) then call perr(myname_,'obsdiagLookup_locate(), %idv =',aNode%idv) call perr(myname_,' %iob =',aNode%iob) call die(myname_) endif endif _EXIT_(myname_) return end subroutine obsNode_xread_ subroutine obsNode_xwrite_(aNode,junit,jstat) implicit none class(pcpNode),intent(in):: aNode integer(i_kind),intent(in ):: junit integer(i_kind),intent( out):: jstat character(len=*),parameter:: myname_=MYNAME//'.obsNode_xwrite_' _ENTRY_(myname_) jstat=0 write(junit,iostat=jstat) aNode%obs , & aNode%err2 , & aNode%raterr2, & aNode%ges , & aNode%icxp , & aNode%predp(:) , & aNode%dpcp_dvar(:), & aNode%wij(:) , & aNode%ij(:) if (jstat/=0) then call perr(myname_,'write(%(res,err2,...)), iostat =',jstat) _EXIT_(myname_) return end if _EXIT_(myname_) return end subroutine obsNode_xwrite_ subroutine obsNode_setHop_(aNode) use m_cvgridLookup, only: cvgridLookup_getiw implicit none class(pcpNode),intent(inout):: aNode ! character(len=*),parameter:: myname_=MYNAME//'::obsNode_setHop_' !_ENTRY_(myname_) call cvgridLookup_getiw(aNode%elat,aNode%elon,aNode%ij,aNode%wij) !_EXIT_(myname_) return end subroutine obsNode_setHop_ function obsNode_isvalid_(aNode) result(isvalid_) implicit none logical:: isvalid_ class(pcpNode),intent(in):: aNode ! character(len=*),parameter:: myname_=MYNAME//'::obsNode_isvalid_' !_ENTRY_(myname_) isvalid_=associated(aNode%diags) !_EXIT_(myname_) return end function obsNode_isvalid_ pure subroutine gettlddp_(aNode,jiter,tlddp,nob) use kinds, only: r_kind implicit none class(pcpNode), intent(in):: aNode integer(kind=i_kind),intent(in):: jiter real(kind=r_kind),intent(inout):: tlddp integer(kind=i_kind),optional,intent(inout):: nob tlddp = tlddp + aNode%diags%tldepart(jiter)*aNode%diags%tldepart(jiter) if(present(nob)) nob=nob+1 return end subroutine gettlddp_ end module m_pcpNode