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