Geant4_10
G4CascadeInterface.hh
Go to the documentation of this file.
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 // $Id: G4CascadeInterface.hh 71938 2013-06-28 19:01:00Z mkelsey $
27 // Defines an interface to Bertini (BERT) cascade
28 // based on INUCL intra-nuclear transport.models
29 // with bullet hadron energy ~< 10 GeV
30 //
31 // 20100405 M. Kelsey -- Fix constness of op== and op!=
32 // 20100519 M. Kelsey -- Remove Collider data members
33 // 20100617 M. Kelsey -- Make G4InuclCollider a local data member
34 // 20100723 M. Kelsey -- Move G4CollisionOutput here for reuse
35 // 20100916 M. Kelsey -- Add functions to encapsulate ApplyYourself() actions,
36 // make colliders pointers (don't expose dependencies)
37 // 20100922 M. Kelsey -- Add functions to select de-excitation method
38 // 20110224 M. Kelsey -- Add createTarget() for use with Propagate(); split
39 // conservation law messages to separate function. Move verbose
40 // setting to .cc file, and apply to all member objects.
41 // 20110301 M. Kelsey -- Add copyPreviousCascade() for use with Propagate()
42 // along with new buffers and related particle-conversion
43 // functions. Encapulate buffer deletion in clear()
44 // 20110303 M. Kelsey -- Change "bulletList" name to "inputFragments"
45 // 20110304 M. Kelsey -- Drop conversion of Propagate() arguments; pass
46 // directly to collider for processing. Rename makeReactionProduct
47 // to makeDynamicParticle.
48 // 20110502 M. Kelsey -- Add filename string to capture random seeds.
49 // 20110720 M. Kelsey -- Discard elastic-cut array (no longer needed),
50 // discard local "theFinalState" (avail in base class).
51 // 20110801 M. Kelsey -- Make bullet and target buffers local objects (with
52 // hadron and nucleus versions) to reduce memory churn
53 // 20120522 M. Kelsey -- Implement base class IsApplicable, and add overloaded
54 // version which takes G4ParticleDefintion, a la G4VProcess.
55 // 20120822 M. Kelsey -- Add function to dump user configuration settings.
56 // Remove local verboseLevel; shadows base class data member.
57 // 20130501 M. Kelsey -- Add static initializer to created shared objects.
58 // 20130628 M. Kelsey -- Address Coverity warnings about copy operations.
59 
60 #ifndef G4CASCADEINTERFACE_H
61 #define G4CASCADEINTERFACE_H 1
62 
64 #include "G4FragmentVector.hh"
66 #include "G4InuclNuclei.hh"
67 #include "G4LorentzRotation.hh"
68 #include "G4Nucleon.hh"
69 #include "G4Nucleus.hh"
70 #include "G4ParticleChange.hh"
71 #include "G4ReactionProduct.hh"
73 #include <vector>
74 
75 class G4CascadParticle;
77 class G4CollisionOutput;
78 class G4DynamicParticle;
79 class G4HadFinalState;
80 class G4InuclCollider;
81 class G4InuclParticle;
83 class G4V3DNucleus;
84 
85 
87 
88 public:
89  G4CascadeInterface(const G4String& name = "BertiniCascade");
90 
91  virtual ~G4CascadeInterface();
92 
94  G4V3DNucleus* theNucleus);
95 
97  G4Nucleus& theNucleus);
98 
99  void SetVerboseLevel(G4int verbose); // Overrides base class
100 
101  G4bool IsApplicable(const G4HadProjectile& aTrack,
102  G4Nucleus& theNucleus);
103 
104  G4bool IsApplicable(const G4ParticleDefinition* aPD) const;
105 
106  // Used with multithreaded applications to preload shared objects
107  static void Initialize();
108 
109  // Select betweeen different post-cascade de-excitation models
110  void useCascadeDeexcitation();
112 
113  virtual void ModelDescription(std::ostream& outFile) const;
114  virtual void DumpConfiguration(std::ostream& outFile) const;
115 
116 protected:
117  void clear(); // Delete previously created particles
118 
119  // Convert input projectile and target to Bertini internal types
120  G4bool createBullet(const G4HadProjectile& aTrack);
121  G4bool createTarget(G4Nucleus& theNucleus);
122  G4bool createTarget(G4V3DNucleus* theNucleus);
124 
125  // Evaluate whether any outgoing particles penetrated Coulomb barrier
127 
128  // Conditions for rejecting cascade attempt
131 
132  // Transfer Bertini internal final state to hadronics interface
135 
136  // Replicate input particles onto output
138  G4Nucleus& theNucleus);
139 
140  // Report violations of conservation laws in original frame
141  void checkFinalResult();
142 
143  // Terminate job because of energy/momentum/etc. violations
145 
146  // Convert between Bertini and external particle types
149 
150 
151 private:
152  G4int operator==(const G4CascadeInterface& right) const {
153  return (this == &right);
154  }
155 
156  G4int operator!=(const G4CascadeInterface& right) const {
157  return (this != &right);
158  }
159 
160  static const G4String randomFile; // Filename to capture random seeds
161  static const G4int maximumTries; // Number of iterations for inelastic
162 
163  G4int numberOfTries;
164 
165  G4InuclCollider* collider;
166  G4CascadeCheckBalance* balance;
167 
168  G4InuclParticle* bullet; // Pointers to last filled versions
170 
171  G4CollisionOutput* output;
172 
173  G4InuclElementaryParticle hadronBullet; // Buffers for bullet, target
174  G4InuclNuclei nucleusBullet;
175 
176  G4InuclElementaryParticle hadronTarget;
177  G4InuclNuclei nucleusTarget;
178 
179  G4LorentzRotation bulletInLabFrame;
180 
181 private:
182  // Copying of modules is forbidden
184  G4CascadeInterface& operator=(const G4CascadeInterface&);
185 };
186 
187 #endif // G4CASCADEINTERFACE_H
G4bool retryInelasticNucleus() const
G4CascadeInterface(const G4String &name="BertiniCascade")
G4bool coulombBarrierViolation() const
G4HadFinalState * ApplyYourself(const G4HadProjectile &aTrack, G4Nucleus &theNucleus)
std::ofstream outFile
Definition: GammaRayTel.cc:68
const XML_Char * name
Definition: expat.h:151
const XML_Char * target
Definition: expat.h:268
int G4int
Definition: G4Types.hh:78
std::vector< G4ReactionProduct * > G4ReactionProductVector
virtual void DumpConfiguration(std::ostream &outFile) const
Float_t Z
Definition: plot.C:39
G4ReactionProductVector * Propagate(G4KineticTrackVector *theSecondaries, G4V3DNucleus *theNucleus)
bool G4bool
Definition: G4Types.hh:79
G4bool createTarget(G4Nucleus &theNucleus)
G4ReactionProductVector * copyOutputToReactionProducts()
G4DynamicParticle * makeDynamicParticle(const G4InuclElementaryParticle &iep) const
virtual void ModelDescription(std::ostream &outFile) const
G4bool createBullet(const G4HadProjectile &aTrack)
void SetVerboseLevel(G4int verbose)
G4bool retryInelasticProton() const
G4bool IsApplicable(const G4HadProjectile &aTrack, G4Nucleus &theNucleus)
G4HadFinalState * NoInteraction(const G4HadProjectile &aTrack, G4Nucleus &theNucleus)