include/Geant4/G4PSSphereSurfaceFlux.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 G4PSSphereSurfaceFlux_h
0030 #define G4PSSphereSurfaceFlux_h 1
0031
0032 #include "G4VPrimitiveScorer.hh"
0033 #include "G4THitsMap.hh"
0034
0035 #include "G4Sphere.hh"
0036 #include "G4PSDirectionFlag.hh"
0037 ////////////////////////////////////////////////////////////////////////////////
0038 // (Description)
0039 //   This is a primitive scorer class for scoring Surface Flux.
0040 //  Flux version assumes only for G4Sphere shape, and the surface
0041 //  is defined at the inside of the sphere.
0042 //   The current is given in the unit of area.
0043 //    e.g.  (Number of tracks)/mm2.
0044 //
0045 // Surface is defined  at the inside of sphere.
0046 // Direction                  -Rmin   +Rmax
0047 //   0  IN || OUT            ->|<-     |      fFlux_InOut
0048 //   1  IN                   ->|       |      fFlux_In
0049 //   2  OUT                    |<-     |      fFlux_Out
0050 //
0051 // Created: 2005-11-14  Tsukasa ASO, Akinori Kimura.
0052 //   17-Nov-2005 Bug fix. square definition.
0053 // 29-Mar-2007  T.Aso,  Bug fix for momentum direction for out-going flux.
0054 // 2010-07-22   Introduce Unit specification.
0055 // 2010-07-22   Add weighted and divideByArea options
0056 //
0057 ///////////////////////////////////////////////////////////////////////////////
0058
0059 class G4PSSphereSurfaceFlux : public G4VPrimitiveScorer
0060 {
0061  public:
0062   G4PSSphereSurfaceFlux(G4String name, G4int direction, G4int depth = 0);
0063   G4PSSphereSurfaceFlux(G4String name, G4int direction, const G4String& unit,
0064                         G4int depth = 0);
0065   ~G4PSSphereSurfaceFlux() override = default;
0066
0067   inline void Weighted(G4bool flg = true) { weighted = flg; }
0068   // Multiply track weight
0069
0070   inline void DivideByArea(G4bool flg = true) { divideByArea = flg; }
0071   // Divided by Area.
0072
0073   void Initialize(G4HCofThisEvent*) override;
0074   void clear() override;
0075   void PrintAll() override;
0076
0077   virtual void SetUnit(const G4String& unit);
0078
0079  protected:
0080   G4bool ProcessHits(G4Step*, G4TouchableHistory*) override;
0081   G4int IsSelectedSurface(G4Step*, G4Sphere*);
0082   virtual void DefineUnitAndCategory();
0083
0084  private:
0085   G4int HCID;
0086   G4int fDirection;
0087   G4THitsMap<G4double>* EvtMap;
0088   G4bool weighted;
0089   G4bool divideByArea;
0090 };
0091
0092 #endif