include/Geant4/G4VEvaporationChannel.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 // Hadronic Process: Nuclear De-excitations
0028 // by V. Lara (Oct 1998)
0029 //
0030 // Modified:
0031 // 03.09.2008 (J.M.Quesada) for external choice of inverse cross section option
0032 // 06.09.2008 (J.M.Quesada) external choices have been added for superimposed
0033 //                          Coulomb barrier (if useSICB is set true, by default
0034 //                          is false)
0035 // 24.04.2010 (V.Ivanchenko) moved constructor and destructor to source; added
0036 //                          two new virtual methods EmittedFragment(s) to allow
0037 //                          more optimal work with G4Fragment objects
0038 // 12.02.2013 (V.Ivanchenko) added virtual method GetLifeTime,
0039 //                          enumerator G4EvaporationChannelType,
0040 //                          which is defined in constructor of the class
0041 //
0042
0043 #ifndef G4VEvaporationChannel_h
0044 #define G4VEvaporationChannel_h 1
0045
0046 #include "globals.hh"
0047 #include "G4Fragment.hh"
0048
0049 class G4VEvaporationChannel
0050 {
0051 public:
0052
0053   G4VEvaporationChannel(const G4String & aName = "");
0054   virtual ~G4VEvaporationChannel() = default;
0055
0056   virtual G4double GetEmissionProbability(G4Fragment* theNucleus) = 0;
0057
0058   // option definition
0059   virtual void Initialise();
0060
0061   // return level life time, by default zero
0062   virtual G4double GetLifeTime(G4Fragment* theNucleus);
0063
0064   // return emitted fragment, initial fragment is modified
0065   // and not deleted
0066   virtual G4Fragment* EmittedFragment(G4Fragment* theNucleus);
0067
0068   // returns "true" if primary fragment is decayed and deleted
0069   // returns "false" if primary fragment is modified but stay alive
0070   // emitted fragments are added to the vector of results
0071   virtual G4bool
0072   BreakUpChain(G4FragmentVector* theResult, G4Fragment* theNucleus);
0073
0074   // return vector of emitted fragments, initial fragment is modified
0075   // but not included in this vector
0076   inline G4FragmentVector* BreakUpFragment(G4Fragment* theNucleus);
0077
0078   // methods for unit tests
0079   virtual G4double ComputeInverseXSection(G4Fragment* theNucleus,
0080                       G4double kinEnergy);
0081   virtual G4double ComputeProbability(G4Fragment* theNucleus,
0082                       G4double kinEnergy);
0083
0084   virtual void Dump() const;
0085
0086   // enable internal conversion
0087   virtual void SetICM(G4bool);
0088
0089   // flag of the radioactive decay module
0090   virtual void RDMForced(G4bool);
0091
0092   // for cross section selection
0093   inline void SetOPTxs(G4int);
0094   // for superimposed Coulomb Barrier for inverse cross sections
0095   inline void UseSICB(G4bool);
0096
0097   G4VEvaporationChannel(const G4VEvaporationChannel & right) = delete;
0098   const G4VEvaporationChannel & operator=
0099   (const G4VEvaporationChannel & right) = delete;
0100   G4bool operator==(const G4VEvaporationChannel & right) const = delete;
0101   G4bool operator!=(const G4VEvaporationChannel & right) const = delete;
0102
0103 protected:
0104
0105   G4int OPTxs{3};
0106   G4bool useSICB{true};
0107 };
0108
0109 inline G4FragmentVector*
0110 G4VEvaporationChannel::BreakUpFragment(G4Fragment* theNucleus)
0111 {
0112   G4FragmentVector* results = new G4FragmentVector();
0113   BreakUpChain(results, theNucleus);
0114   return results;
0115 }
0116
0117
0118 inline void G4VEvaporationChannel::SetOPTxs(G4int val)
0119 {
0120   if(val >= 0) { OPTxs = val; }
0121 }
0122
0123 inline void G4VEvaporationChannel::UseSICB(G4bool val)
0124 {
0125   useSICB = val;
0126 }
0127
0128 #endif