include/Geant4/G4PSPassageCellFlux.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 //
0027 //
0028
0029 #ifndef G4PSPassageCellFlux_h
0030 #define G4PSPassageCellFlux_h 1
0031
0032 #include "G4VPrimitivePlotter.hh"
0033 #include "G4THitsMap.hh"
0034
0035 ////////////////////////////////////////////////////////////////////////////////
0036 // (Description)
0037 //   This is a primitive scorer class for scoring cell flux.
0038 //   The Cell Flux is defined by  a track length divided by a geometry
0039 //   volume, where only tracks passing through the geometry are taken
0040 //  into account. e.g. the unit of Cell Flux is mm/mm3.
0041 //
0042 //   If you want to score all tracks in the geometry volume,
0043 //  please use G4PSCellFlux.
0044 //
0045 // Created: 2005-11-14  Tsukasa ASO, Akinori Kimura.
0046 // 2010-07-22   Introduce Unit specification.
0047 // 2010-07-22   Add weighted option
0048 // 2020-10-06   Use G4VPrimitivePlotter and fill 1-D histo of kinetic energy (x)
0049 //              vs. cell flux * track weight (y)                (Makoto Asai)
0050 //
0051 ///////////////////////////////////////////////////////////////////////////////
0052
0053 class G4PSPassageCellFlux : public G4VPrimitivePlotter
0054 {
0055  public:
0056   G4PSPassageCellFlux(G4String name, G4int depth = 0);
0057   G4PSPassageCellFlux(G4String name, const G4String& unit, G4int depth = 0);
0058   ~G4PSPassageCellFlux() override = default;
0059
0060   inline void Weighted(G4bool flg = true) { weighted = flg; }
0061   // Multiply track weight
0062
0063  public:
0064   void Initialize(G4HCofThisEvent*) override;
0065   void clear() override;
0066   void PrintAll() override;
0067
0068   virtual void SetUnit(const G4String& unit);
0069
0070  protected:
0071   G4bool ProcessHits(G4Step*, G4TouchableHistory*) override;
0072   virtual G4bool IsPassed(G4Step*);
0073   virtual G4double ComputeVolume(G4Step*, G4int idx);
0074   virtual void DefineUnitAndCategory();
0075
0076  private:
0077   G4int HCID;
0078   G4int fCurrentTrkID;
0079   G4double fCellFlux;
0080   G4THitsMap<G4double>* EvtMap;
0081   G4bool weighted;
0082 };
0083
0084 #endif