include/Geant4/G4CascadeDeexciteBase.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 #ifndef G4CASCADE_DEEXCITE_BASE_HH
0027 #define G4CASCADE_DEEXCITE_BASE_HH 1
0028 //
0029 // Semi-concrete base class for de-excitation modules, analogous to
0030 // G4CascadeColliderBase.
0031 //
0032 // 20130628  M.Kelsey -- Add makeFragment() with zero momentum
0033
0034 #include "G4VCascadeDeexcitation.hh"
0035 #include "G4InuclElementaryParticle.hh"
0036 #include "G4InuclNuclei.hh"
0037 #include "G4LorentzVector.hh"
0038 #include <vector>
0039
0040 class G4CascadeCheckBalance;
0041 class G4Fragment;
0042
0043
0044 class G4CascadeDeexciteBase : public G4VCascadeDeexcitation {
0045 public:
0046   G4CascadeDeexciteBase(const char* name);
0047   virtual ~G4CascadeDeexciteBase();
0048
0049   virtual void setVerboseLevel(G4int verbose=0);
0050
0051 protected:
0052   // Decide whether to use G4BigBanger or not
0053   virtual G4bool explosion(const G4Fragment& target) const;
0054   virtual G4bool explosion(G4int A, G4int Z, G4double excitation) const;
0055
0056 protected:
0057   G4CascadeCheckBalance* balance;   // For conservation checking
0058
0059   // ==> Provide interfaces to G4CascadeCheckBalance
0060   virtual G4bool validateOutput(const G4Fragment& target,
0061                 G4CollisionOutput& output);
0062
0063   // This is for use with G4BigBanger
0064   virtual G4bool validateOutput(const G4Fragment& target,
0065         const std::vector<G4InuclElementaryParticle>& particles);
0066
0067   // This is for use with G4Fissioner
0068   virtual G4bool validateOutput(const G4Fragment& target,
0069                 const std::vector<G4InuclNuclei>& fragments);
0070
0071   // Interfaces between local content and G4Fragment
0072   void getTargetData(const G4Fragment& target);
0073   G4int A;      // Buffers to collect target data for all modules
0074   G4int Z;
0075   G4LorentzVector PEX;  // Four momentum of recoil in Bertini units (GeV)
0076   G4double EEXS;    // Excitation energy in MeV
0077
0078   // NOTE:  Momentum passed by value so that energy/mass can be adjusted
0079   const G4Fragment& makeFragment(G4LorentzVector mom, G4int A, G4int Z,
0080                  G4double EX=0.);
0081   const G4Fragment& makeFragment(G4int A, G4int Z, G4double EX=0.);
0082   G4Fragment aFragment; // Reusable buffer to reduce new/delete cycling
0083
0084 private:
0085   // Copying of modules is forbidden
0086   G4CascadeDeexciteBase(const G4CascadeDeexciteBase&);
0087   G4CascadeDeexciteBase& operator=(const G4CascadeDeexciteBase&);
0088 };
0089
0090 #endif  /* G4CASCADE_DEEXCITE_BASE_HH */