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