include/Geant4/G4PSFlatSurfaceCurrent3D.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 G4PSFlatSurfaceCurrent3D_h
0030 #define G4PSFlatSurfaceCurrent3D_h 1
0031
0032 #include "G4PSFlatSurfaceCurrent.hh"
0033 ///////////////////////////////////////////////////////////////////////////////
0034 // (Description)
0035 //   This is a primitive scorer class for scoring Surface Current.
0036 //  Current version assumes only for G4Box shape, and the surface
0037 //  is defined at the -Z plane of the box.
0038 //   The current is given in the unit of area.
0039 //    e.g.  (Number of tracks)/mm2.
0040 //
0041 // Surface is defined at the -Z surface.
0042 // Direction                  -Z   +Z
0043 //   0  IN || OUT            ->|<-  |      fCurrent_InOut
0044 //   1  IN                   ->|    |      fCurrent_In
0045 //   2  OUT                    |<-  |      fCurrent_Out
0046 //
0047 //
0048 // Created: 2008-08-14  Tsukasa ASO
0049 // 2010-07-22   Introduce Unit specification.
0050 ///////////////////////////////////////////////////////////////////////////////
0051
0052 class G4PSFlatSurfaceCurrent3D : public G4PSFlatSurfaceCurrent
0053 {
0054  public:
0055   G4PSFlatSurfaceCurrent3D(G4String name, G4int direction, G4int ni = 1,
0056                            G4int nj = 1, G4int nk = 1, G4int depi = 2,
0057                            G4int depj = 1, G4int depk = 0);
0058   G4PSFlatSurfaceCurrent3D(G4String name, G4int direction, const G4String& unit,
0059                            G4int ni = 1, G4int nj = 1, G4int nk = 1,
0060                            G4int depi = 2, G4int depj = 1, G4int depk = 0);
0061   ~G4PSFlatSurfaceCurrent3D() override = default;
0062
0063  protected:
0064   G4int GetIndex(G4Step*) override;
0065
0066  private:
0067   G4int fDepthi, fDepthj, fDepthk;
0068 };
0069 #endif