chook.f

Go to the documentation of this file.

#include "cmain.f"
#include "chookHybAS.f"
#include "ctemplCeren.f"
      include "kxplsph.f"
!  *************************************** hook for Beginning of a Run
!  * At this moment, all (system-level) initialization for this run
!  * has been ended.  After this routine is executed, the system goes into the
!  * event creation loop.
!  *
      subroutine chookbgrun
      implicit none
#include "Zmanagerp.h"

 
!         If you feel writing the parameters on stderr is
!         a bother, comment out the next or
!         use other device than ErrorOut.
!         Also you may comment out all output routines below.

!            namelist output
      call cwriteparam(errorout, 0)
!            primary information
      call cprintprim(errorout)
!            observation level information
      call cprintobs(errorout)
      end
#if defined NEXT486
#define IMAG_P dimag
#elif defined PCLinux
#define IMAG_P dimag
#else
#define IMAG_P imag
#endif


!     *********************************** hook for Beginning of  1 event
!     *  All system-level initialization for 1 event generation has been
!     *  eneded at this moment.
!     *  After this is executed, event generation starts.
!     *
      subroutine chookbgevent
      implicit none
#include "Zglobalc.h"
#include "Ztrack.h"
#include "Ztrackp.h"
#include  "Zobs.h"
#include  "Zobsp.h"
#include "Zobsv.h"
#include "Zincidentp.h"

      type(track):: primary
      type(coord):: angle1ry

      common /zprivate/ primary, angle1ry
      integer ndiscard
      common /zprivate2/ ndiscard


      integer icon
      real*8  leng, xp, yp, zp, oa2, rmax, r
      save rmax
      data rmax/0.d0/

      if(rmax .eq. 0.d0) then
         oa2 = imag_p(azimuth)/2.0
         rmax = obssites(noofsites).pos.radiallen* oa2*torad
         ndiscard = 0
      endif

      call cqincident(primary, angle1ry)
!      see if the 1ry is directed outside of the
!      area covered by the injection area.
      call kxplsph( primary.pos.xyz.r(1), primary.pos.xyz.r(2), 
     *              primary.pos.xyz.r(3),
     *              primary.vec.w.r(1), primary.vec.w.r(2), 
     *              primary.vec.w.r(3), 
     *              obssites(noofsites).pos.radiallen,
     *              leng, icon )


      if(icon .eq. 1) then
         xp = primary.pos.xyz.r(1) + leng*primary.vec.w.r(1)
         yp = primary.pos.xyz.r(2) + leng*primary.vec.w.r(2)
         zp = primary.pos.xyz.r(3) + leng*primary.vec.w.r(3)
         r = sqrt( (xp-obssites(noofsites).pos.xyz.r(1))**2 +
     *            (yp-obssites(noofsites).pos.xyz.r(2))**2 +
     *            (zp-obssites(noofsites).pos.xyz.r(3))**2 )
        if(r .gt.  rmax) icon = -1
      endif
      if(icon  .ne. 1) then
!          clear the stack to discard this 1ry.
         call cinitstack
         ndiscard = ndiscard + 1
      endif
      end
  

!     ************************************ hook for observation
!     *  One particle information is brought here by the system.
!     *  All information of the particle is in aTrack
!     *
      subroutine chookobs(aTrack, id)
!
!     Note that every real variable is in double  precision so
!     that you may output it in sigle precision to save the memory.
!     In some cases it is essential to put it in sigle (say,
!     for gnuplot).
! 
      implicit none
#include "Ztrack.h"
      integer id  ! input.  1 ==> aTrack is going out from
!                                 outer boundery.
!                           2 ==> reached at an observation level
!                           3 ==> reached at inner boundery.
      type(track):: aTrack

      type(track):: primary
      type(coord):: angle1ry
      common /zprivate/ primary, angle1ry


!
!     For id =2, you need not output the z value, because it is always
!     0 (within the computational accuracy).
!
      if(id .eq. 2 .and. atrack.p.code .ne. 7 
     *     .and. atrack.p.code .ne. 8 ) then
!            output typical quantities.
        write(*, '(3i5,1p,g14.6)')
     *  atrack.where,   !  observation level. integer*2.  1 is highest.
     *  atrack.p.code,    !  ptcl code.  integer*2.
     *  atrack.p.charge,  !  charge,  integer*2 
!     *  sngl(aTrack.t), !  relateive arrival time in nsec (NOT sec).
!                        !  if TimeStructure is F, nonsense.
     *  sngl( atrack.p.fm.p(4)-atrack.p.mass )  ! kinetic energy in GeV.
!     *  sngl(aTrack.pos.xyz.r(1)), sngl(aTrack.pos.xyz.r(2)), !  x, y in m
!     *  sngl(aTrack.pos.xyz.r(3)), !  z
!     *  sngl(aTrack.vec.w.r(1)),  ! direc. cos.x in the current detector system.
!     *  sngl(aTrack.vec.w.r(2)),  ! direc. cos.y
!     *  sngl(aTrack.vec.w.r(3)),  ! direc. cos.z
!     *  sngl(aTrack.vec.coszenith), ! cos of zenith angle
!     *  sngl(primary.vec.coszenith)   
      endif
!         you may need in some case other information such as
!       aTrack.p.subcode   ! sub code of the particle integer*2
!       aTrack.p.mass      ! mass 
!       aTrack.wgt         ! weight of the particle (may not be 1. if
                           ! ThinSampling =T)
!       aTrack.p.fm.p(1)      ! momentum x component.  Note. Momentum is
!                            given in the  Earth xyz system.

!       aTrack.p.fm.p(2)      !          y
!       aTrack.p.fm.p(3)      !          z

      end

!    *********************************** hook for end of 1 event
!    * At this moment, 1 event generation has been ended.
!    *
      subroutine chookenevent

      implicit none
#include "Ztrack.h"
#include "Ztrackv.h"
#include "Zobs.h"
#include "Zobsp.h"
#include "Zobsv.h"

      integer i
      if(observeas) then
!                   electron size in B approx.
         write(*, *) (asobssites(i).esize, i=1, noofassites)
!                   size weighted age
         write(*, *) (asobssites(i).age,   i=1, noofassites) 
      endif

      end


!     ********************************* hook for end of a run
!     *  all events have been created or time lacks
!     *
      subroutine chookenrun
      implicit none
      integer ndiscard
      common /zprivate2/ ndiscard

      call  cprintstatus
      write(0, *) ' discarded primaries=', ndiscard

      end
!     ********************************* hook for trace
!     *  This is called only when trace > 60
!     *  User should manage the trace information here.
!     *  If you use this, you may need some output for trace
!     *  at the beginning of 1 event generatio and at the end of  1 event
!     *  generation so that you can identfy each event.
!     *
!     *
      subroutine chooktrace
            implicit none

#include  "Ztrack.h"
#include  "Ztrackv.h"
#include  "Ztrackp.h"
#include  "Zobs.h"
#include  "Zobsv.h"

      real*4 h1,  h2
!
!    Every time a particle is moved in the atmosphere, this routine is called,
!    if trace > 60. 
!         For a one track segment,
!     TrackBefMove  has  track information at the beginning of the segment.
!     MoveTrack    has   track information at the end of the segment.
!   
!     You can know the  information a track contains in the 
!     chookObs routine. (Note however, no conversion of coordinate
!     has been done.  The values are in the Earth xyz system.)
!     Besides quantities explained there, you can use, for a  given 'track'
!
!     atrack.pos.xyz.x, atrack.pos.xyz.y, atrack.pos.xyz.z    (x,y.z)
!     atrack.pos.radiallen   (distance from the center of the earth)
!     atrack.pos.depth       (vertical depth)
!     atrack.pos.height      (vertical heigth from sea level)  
!

      h1 = trackbefmove.pos.height- obssites(noofsites).pos.height
      h2 = movedtrack.pos.height - obssites(noofsites).pos.height

      end
!     ********************* this is the hook called when
!       an electron made an interaction.
!
      subroutine chookeint(never)
            implicit none

#include  "Ztrack.h"
#include  "Ztrackv.h"
!  #include  "Ztrackp.h"
      
      integer never   ! input & output
      
!         don't make never = 1, if you want to get
!         information after an electron made interaction
!         if this is made non zero, this routine will never be called.
!
!   MovedTrack is the electron that made interaction
!   Pwork contains produced particles.
!   Nproduced has the number of particles in Pwork
!   IntInfArray(ProcessNo) contains the type of interaction
!
!        default setting
      never = 1
!
!        IntInfArray(ProcessNo).process will have one of
!       'brems', 'mscat', 'bscat',or  'anihi'
!
      end

!     ********************* this is the hook called when
!       a gamma ray made an interaction.
!
      subroutine chookgint(never)
            implicit none

#include  "Ztrack.h"
#include  "Ztrackv.h"
!  #include  "Ztrackp.h"
      
      integer never   ! input & output
      
!         don't make never = 1, if you want to get
!         information after a gamma ray made interaction
!         if this is made non zero, this routine will never be called.
!
!   MovedTrack is the gamma that made interaction
!   Pwork contains produced particles.
!   Nproduced has the number of particles in Pwork
!   IntInfArray(ProcessNo) contains the type of interaction
!
!        default setting
      never = 1
!         IntInfArray(ProcessNo).process will have one of
!        'pair', 'comp', 'photoe' or 'photop'
!       
      end

!     ********************* this is the hook called when
!       non e-g particle made an interaction.
!
      subroutine chooknepint(never)
            implicit none

#include  "Ztrack.h"
#include  "Ztrackv.h"
!  #include  "Ztrackp.h"
      
      integer never   ! input & output
      
!         don't make never = 1, if you want to get
!         information after a non-e-g particle  made interaction
!         if this is made non zero, this routine will never be called.
!
!   MovedTrack is the particle that made interaction
!   Pwork contains produced particles.
!   Nproduced has the number of particles in Pwork
!   IntInfArray(ProcessNo) contains the type of interaction
!
!        default setting
      never = 1
!
!        IntInfArray(ProcessNo).process  will have
!             'col' or 'decay'
      end