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