chem6/include/PrimaryKiller.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 /// \file PrimaryKiller.hh
0027 /// \brief Definition of the PrimaryKiller class
0028
0029 // This example is provided by the Geant4-DNA collaboration
0030 // Any report or published results obtained using the Geant4-DNA software
0031 // shall cite the following Geant4-DNA collaboration publication:
0032 // Med. Phys. 37 (2010) 4692-4708
0033 // J. Comput. Phys. 274 (2014) 841-882
0034 // The Geant4-DNA web site is available at http://geant4-dna.org
0035 //
0036
0037 #ifndef CHEM6_PrimaryKiller_h
0038 #define CHEM6_PrimaryKiller_h 1
0039
0040 #include <G4THitsMap.hh>
0041 #include <G4UImessenger.hh>
0042 #include <G4VPrimitiveScorer.hh>
0043 #include <G4UnitsTable.hh>
0044
0045 class G4UIcmdWithADoubleAndUnit;
0046 class G4UIcmdWith3VectorAndUnit;
0047
0048 /** \file PrimaryKiller.hh*/
0049
0050 // Description:
0051 //   Kill the primary particle:
0052 //   - either after a given energy loss
0053 //   - or after the primary particle has reached a given energy
0054
0055 class PrimaryKiller final : public G4VPrimitiveScorer, public G4UImessenger {
0056 public:
0057   explicit PrimaryKiller(const G4String &name, G4int depth = 0);
0058
0059   ~PrimaryKiller() override = default;
0060
0061   /** Set energy under which the particle should be
0062    killed*/
0063   inline void SetEnergyThreshold(const G4double energy) { fKineticE_Min = energy; }
0064
0065   /** Set the energy loss from which the primary is
0066    killed*/
0067   inline void SetMinLossEnergyLimit(double energy) { fELossRange_Min = energy; }
0068
0069   /** Set the energy loss from which the event is
0070    aborted*/
0071   inline void SetMaxLossEnergyLimit(double energy) { fELossRange_Max = energy; }
0072
0073   /** Method related to G4UImessenger
0074       used to control energy cuts through macro file
0075    */
0076   void SetNewValue(G4UIcommand *command, G4String newValue) override;
0077
0078   void Initialize(G4HCofThisEvent *) override {fELoss = 0.;};
0079
0080   void EndOfEvent(G4HCofThisEvent *) override {};
0081
0082
0083 protected:
0084   G4bool ProcessHits(G4Step *, G4TouchableHistory *) override;
0085
0086 private:
0087   G4double fELoss = 0; // cumulated energy loss by the primary
0088   G4double fELossRange_Min = DBL_MAX; // fELoss from which the primary is killed
0089   G4double fELossRange_Max = DBL_MAX; // fELoss from which the event is aborted
0090   G4double fKineticE_Min = 0; // kinetic energy below which the primary is killed
0091   G4ThreeVector fPhantomSize = {1 * CLHEP::km, 1 * CLHEP::km, 1 * CLHEP::km};
0092
0093   std::unique_ptr<G4UIcmdWithADoubleAndUnit> fpELossUI;
0094   std::unique_ptr<G4UIcmdWithADoubleAndUnit> fpAbortEventIfELossUpperThan;
0095   std::unique_ptr<G4UIcmdWithADoubleAndUnit> fpMinKineticE;
0096   std::unique_ptr<G4UIcmdWith3VectorAndUnit> fpSizeUI;
0097 };
0098 #endif