include/Geant4/G4PSVolumeFlux.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // Class G4PSVolumeFlux
0027 //
0028 // Class description:
0029 //  Scorer that scores number of tracks coming into the associated volume.
0030 //  Optionally number of tracks can be divided by the surface area to
0031 //  score the volume current and divided by cos(theta) for volume flux
0032 //  where theta is the incident angle
0033 //
0034 //  - Created   M. Asai, Sept. 2020
0035
0036 #ifndef G4PSVolumeFlux_h
0037 #define G4PSVolumeFlux_h 1
0038
0039 #include "G4VPrimitivePlotter.hh"
0040 #include "G4THitsMap.hh"
0041 #include "G4PSDirectionFlag.hh"
0042
0043 class G4PSVolumeFlux : public G4VPrimitivePlotter
0044 {
0045  public:
0046   G4PSVolumeFlux(G4String name, G4int direction = 1, G4int depth = 0);
0047   ~G4PSVolumeFlux() override = default;
0048
0049  public:
0050   void Initialize(G4HCofThisEvent*) override;
0051   void clear() override;
0052   void PrintAll() override;
0053
0054   void SetDivAre(G4bool val) { divare = val; }
0055   void SetDivCos(G4bool val) { divcos = val; }
0056
0057  protected:
0058   G4bool ProcessHits(G4Step*, G4TouchableHistory*) override;
0059
0060  private:
0061   G4int HCID{-1};
0062   G4int fDirection;
0063   G4THitsMap<G4double>* EvtMap{nullptr};
0064   G4bool divare = false;  // divide by the surface area
0065   G4bool divcos = false;  // divide by cos(theta)
0066 };
0067
0068 #endif