include/Geant4/G4InuclCollider.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 // 20100413  M. Kelsey -- Pass G4CollisionOutput by ref to ::collide()
0028 // 20100517  M. Kelsey -- Inherit from common base class, make other colliders
0029 //      simple data members
0030 // 20100620  M. Kelsey -- Move output buffers here to reduce memory churn
0031 // 20100714  M. Kelsey -- Switch to new G4CascadeColliderBase class
0032 // 20100720  M. Kelsey -- Make all the collders pointer members (to reducde
0033 //      external compile dependences).
0034 // 20100915  M. Kelsey -- Move de-excitation colliders to G4CascadeDeexcitation
0035 // 20100922  M. Kelsey -- Add functions to select de-excitation method, change
0036 //      "theDeexcitation" to be a base-class pointer for switching
0037 // 20100926  M. Kelsey -- Use new intermediate base class for de-exciations.
0038 // 20110224  M. Kelsey -- Add ::rescatter() function which takes a list of
0039 //      pre-existing secondaries as input.  Add setVerboseLevel().
0040 // 20110304  M. Kelsey -- Modify rescatter to use original Propagate() input
0041 // 20110308  M. Kelsey -- Add ::deexcite() function to handle nuclear fragment
0042 // 20130620  Address Coverity complaint about missing copy actions
0043 // 20150128  Add function to check for sensible photonuclear final states
0044
0045 #ifndef G4INUCL_COLLIDER_HH
0046 #define G4INUCL_COLLIDER_HH
0047
0048 #include "G4CascadeColliderBase.hh"
0049 #include "G4CollisionOutput.hh"
0050
0051 class G4CascadParticle;
0052 class G4ElementaryParticleCollider;
0053 class G4IntraNucleiCascader;
0054 class G4InuclParticle;
0055 class G4KineticTrackVector;
0056 class G4V3DNucleus;
0057 class G4VCascadeDeexcitation;
0058
0059
0060 class G4InuclCollider : public G4CascadeColliderBase {
0061 public:
0062   G4InuclCollider();
0063   virtual ~G4InuclCollider();
0064
0065   void collide(G4InuclParticle* bullet, G4InuclParticle* target,
0066            G4CollisionOutput& globalOutput);
0067
0068   // For use with top-level Propagate to preload a set of secondaries
0069   void rescatter(G4InuclParticle* bullet, G4KineticTrackVector* theSecondaries,
0070          G4V3DNucleus* theNucleus, G4CollisionOutput& globalOutput);
0071
0072   void setVerboseLevel(G4int verbose=0);
0073
0074   // Select betweeen different post-cascade de-excitation models
0075   void useCascadeDeexcitation();
0076   void usePreCompoundDeexcitation();
0077   void useAblaDeexcitation();
0078
0079 protected:
0080   void deexcite(const G4Fragment& fragment, G4CollisionOutput& globalOutput);
0081
0082   // Looks for non-gamma final state in photonuclear or leptonuclear
0083   G4bool photonuclearOkay(G4CollisionOutput& checkOutput) const;
0084
0085 private:
0086   G4ElementaryParticleCollider* theElementaryParticleCollider;
0087   G4IntraNucleiCascader* theIntraNucleiCascader;
0088
0089   G4VCascadeDeexcitation* theDeexcitation;  // User switchable!
0090
0091   G4CollisionOutput output;     // Secondaries from main cascade
0092   G4CollisionOutput DEXoutput;      // Secondaries from de-excitation
0093
0094 private:
0095   // Copying of modules is forbidden
0096   G4InuclCollider(const G4InuclCollider&);
0097   G4InuclCollider& operator=(const G4InuclCollider&);
0098 };
0099
0100 #endif /* G4INUCL_COLLIDER_HH */
0101
0102