include/Geant4/G4PSCylinderSurfaceCurrent.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 G4PSCylinderSurfaceCurrent_h
0030 #define G4PSCylinderSurfaceCurrent_h 1
0031
0032 #include "G4VPrimitivePlotter.hh"
0033 #include "G4THitsMap.hh"
0034
0035 #include "G4Tubs.hh"
0036 #include "G4PSDirectionFlag.hh"
0037
0038 ////////////////////////////////////////////////////////////////////////////////
0039 // (Description)
0040 //   This is a primitive scorer class for scoring Surface Current.
0041 //  Current version assumes only for G4Tubs shape, and the surface
0042 //  is defined at the inner plane of the tubs.
0043 //   The current is given in the unit of area.
0044 //    e.g.  (Number of tracks)/mm2.
0045 //
0046 // Surface is defined at the  inner surface of the tube.
0047 // Direction                   R    R+dR
0048 //   0  IN || OUT            ->|<-  |      fCurrent_InOut
0049 //   1  IN                   ->|    |      fCurrent_In
0050 //   2  OUT                    |<-  |      fCurrent_Out
0051 //
0052 //
0053 // Created: 2007-03-21  Tsukasa ASO
0054 // 2010-07-22   Introduce Unit specification.
0055 // 2020-10-06   Use G4VPrimitivePlotter and fill 1-D histo of kinetic energy (x)
0056 //              vs. surface current * track weight (y)             (Makoto Asai)
0057 //
0058 ///////////////////////////////////////////////////////////////////////////////
0059
0060 class G4PSCylinderSurfaceCurrent : public G4VPrimitivePlotter
0061 {
0062  public:
0063   G4PSCylinderSurfaceCurrent(G4String name, G4int direction, G4int depth = 0);
0064   G4PSCylinderSurfaceCurrent(G4String name, G4int direction,
0065                              const G4String& unit, G4int depth = 0);
0066   ~G4PSCylinderSurfaceCurrent() override = default;
0067
0068   inline void Weighted(G4bool flg = true) { weighted = flg; }
0069   // Multiply track weight
0070
0071   inline void DivideByArea(G4bool flg = true) { divideByArea = flg; }
0072   // Divided by Area.
0073
0074   void Initialize(G4HCofThisEvent*) override;
0075   void clear() override;
0076   void PrintAll() override;
0077
0078   virtual void SetUnit(const G4String& unit);
0079
0080  protected:
0081   G4bool ProcessHits(G4Step*, G4TouchableHistory*) override;
0082   G4int IsSelectedSurface(G4Step*, G4Tubs*);
0083   virtual void DefineUnitAndCategory();
0084
0085  private:
0086   G4int HCID;
0087   G4int fDirection;
0088   G4THitsMap<G4double>* EvtMap;
0089   G4bool weighted;
0090   G4bool divideByArea;
0091 };
0092
0093 #endif