G4PSPassageCellFlux.hh

Go to the documentation of this file.

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
//
//
 
#ifndef G4PSPassageCellFlux_h
#define G4PSPassageCellFlux_h 1
 
#include "G4VPrimitivePlotter.hh"
#include "G4THitsMap.hh"
 
////////////////////////////////////////////////////////////////////////////////
// (Description)
//   This is a primitive scorer class for scoring cell flux.
//   The Cell Flux is defined by  a track length divided by a geometry
//   volume, where only tracks passing through the geometry are taken
//  into account. e.g. the unit of Cell Flux is mm/mm3.
//
//   If you want to score all tracks in the geometry volume,
//  please use G4PSCellFlux.
//
// Created: 2005-11-14  Tsukasa ASO, Akinori Kimura.
// 2010-07-22   Introduce Unit specification.
// 2010-07-22   Add weighted option
// 2020-10-06   Use G4VPrimitivePlotter and fill 1-D histo of kinetic energy (x)
//              vs. cell flux * track weight (y)                (Makoto Asai)
//
///////////////////////////////////////////////////////////////////////////////
 
class G4PSPassageCellFlux : public G4VPrimitivePlotter
{
 public:
  G4PSPassageCellFlux(const G4String& name, G4int depth = 0);
  G4PSPassageCellFlux(const G4String& name, const G4String& unit, G4int depth = 0);
  ~G4PSPassageCellFlux() override = default;
 
  inline void Weighted(G4bool flg = true) { weighted = flg; }
  // Multiply track weight
 
 public:
  void Initialize(G4HCofThisEvent*) override;
  void clear() override;
  void PrintAll() override;
 
  virtual void SetUnit(const G4String& unit);
 
 protected:
  G4bool ProcessHits(G4Step*, G4TouchableHistory*) override;
  virtual G4bool IsPassed(G4Step*);
  virtual G4double ComputeVolume(G4Step*, G4int idx);
  virtual void DefineUnitAndCategory();
 
 private:
  G4int HCID;
  G4int fCurrentTrkID;
  G4double fCellFlux;
  G4THitsMap<G4double>* EvtMap;
  G4bool weighted;
};
 
#endif