include/Geant4/G4Radioactivation.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 G4Radioactivation_h
0027 #define G4Radioactivation_h 1
0028
0029 #include "G4RadioactiveDecay.hh"
0030
0031 #include <vector>
0032 #include <map>
0033 #include <CLHEP/Units/SystemOfUnits.h>
0034
0035 #include "G4ios.hh"
0036 #include "globals.hh"
0037 #include "G4VRestDiscreteProcess.hh"
0038 #include "G4ParticleChangeForRadDecay.hh"
0039
0040 #include "G4NucleusLimits.hh"
0041 #include "G4RadioactiveDecayRatesToDaughter.hh"
0042 #include "G4RadioactiveDecayChainsFromParent.hh"
0043 #include "G4RadioactivityTable.hh"
0044 #include "G4ThreeVector.hh"
0045 #include "G4Threading.hh"
0046
0047 class G4Fragment;
0048 class G4RadioactivationMessenger;
0049
0050 typedef std::vector<G4RadioactiveDecayChainsFromParent> G4RadioactiveDecayParentChainTable;
0051 typedef std::vector<G4RadioactiveDecayRatesToDaughter> G4RadioactiveDecayRates;
0052 typedef std::map<G4String, G4DecayTable*> DecayTableMap;
0053
0054 class G4Radioactivation : public G4RadioactiveDecay
0055 {
0056   public: // with description
0057
0058     G4Radioactivation(const G4String& processName="Radioactivation",
0059                       const G4double timeThresholdForRadioactiveDecays=-1.0);
0060     ~G4Radioactivation() override;
0061
0062     G4VParticleChange* DecayIt(const G4Track& theTrack,
0063                                const G4Step&  theStep) override;
0064
0065     void ProcessDescription(std::ostream& outFile) const override;
0066
0067     // Set the decay biasing scheme using the data in "filename"
0068     void SetDecayBias(const G4String& filename);
0069
0070     // Set the half-life threshold for isomer production
0071     void SetHLThreshold(G4double hl) {halflifethreshold = hl;}
0072
0073     void SetSourceTimeProfile(const G4String& filename);
0074     // Set source exposure function using histograms in "filename"
0075
0076     G4bool IsRateTableReady(const G4ParticleDefinition &);
0077     // Returns true if the coefficient and decay time table for all the
0078     // descendants of the specified isotope are ready.
0079     // used in VR decay mode only
0080
0081     void CalculateChainsFromParent(const G4ParticleDefinition&);
0082     // Calculates the coefficient and decay time table for all the descendents
0083     // of the specified isotope.  Adds the calculated table to the private data
0084     // member "theParentChainTable".
0085     // used in VR decay mode only
0086
0087     void GetChainsFromParent(const G4ParticleDefinition&);
0088     // Used to retrieve the coefficient and decay time table for all the
0089     // descendants of the specified isotope from "theParentChainTable"
0090     // and place it in "chainsFromParent".
0091     // used in VR decay mode only
0092
0093     void SetDecayRate(G4int,G4int,G4double, G4int, std::vector<G4double>&,
0094                       std::vector<G4double>&);
0095     // Sets "theDecayRate" with data supplied in the arguements.
0096     // used in VR decay mode only
0097
0098     std::vector<G4RadioactivityTable*>& GetTheRadioactivityTables()
0099        {return theRadioactivityTables;}
0100     // Return vector of G4Radioactivity map - should be used in VR mode only
0101
0102
0103     // Controls whether G4Radioactivation runs in analogue mode or
0104     // variance reduction mode.  SetBRBias, SetSplitNuclei and
0105     // SetSourceTimeProfile all turn off analogue mode and use VR mode
0106     inline void SetAnalogueMonteCarlo (G4bool r) {
0107       AnalogueMC = r;
0108     }
0109
0110     // Returns true if the simulation is an analogue Monte Carlo, and false if
0111     // any of the biassing schemes have been selected.
0112     inline G4bool IsAnalogueMonteCarlo () {return AnalogueMC;}
0113
0114      // Sets whether branching ration bias scheme applies.
0115     inline void SetBRBias(G4bool r) {
0116       BRBias = r;
0117       AnalogueMC = false;
0118     }
0119
0120     // Sets the number of times a nucleus will decay when biased
0121     inline void SetSplitNuclei(G4int r) {
0122       NSplit = r;
0123       AnalogueMC = false;
0124     }
0125
0126     //  Returns the nuclear splitting number
0127     inline G4int GetSplitNuclei () {return NSplit;}
0128
0129     G4Radioactivation(const G4Radioactivation& right) = delete;
0130     G4Radioactivation& operator=(const G4Radioactivation& right) = delete;
0131
0132   protected:
0133
0134     G4double ConvolveSourceTimeProfile(const G4double, const G4double);
0135     G4double GetDecayTime();
0136     G4int GetDecayTimeBin(const G4double aDecayTime);
0137
0138     G4double GetMeanLifeTime(const G4Track& theTrack,
0139                              G4ForceCondition* condition) override;
0140
0141     //Add gamma,Xray,conversion,and auger electrons for bias mode
0142     void AddDeexcitationSpectrumForBiasMode(G4ParticleDefinition* apartDef,
0143                                             G4double weight,
0144                                             G4double currenTime,
0145                                             std::vector<double>& weights_v,
0146                                             std::vector<double>& times_v,
0147                                             std::vector<G4DynamicParticle*>& secondaries_v);
0148
0149   private:
0150
0151     G4RadioactivationMessenger* theRadioactivationMessenger;
0152     G4bool AnalogueMC;
0153     G4bool BRBias;
0154     G4int NSplit;
0155
0156     G4double halflifethreshold;
0157
0158     G4int NSourceBin;
0159     G4double SBin[100];
0160     G4double SProfile[100];
0161     G4int NDecayBin;
0162     G4double DBin[100];
0163     G4double DProfile[100];
0164
0165     G4RadioactiveDecayRatesToDaughter ratesToDaughter;
0166     G4RadioactiveDecayRates theDecayRateVector;
0167     G4RadioactiveDecayChainsFromParent chainsFromParent;
0168     G4RadioactiveDecayParentChainTable theParentChainTable;
0169
0170     // for the radioactivity tables
0171     std::vector<G4RadioactivityTable*> theRadioactivityTables;
0172     G4int decayWindows[100];
0173 };
0174
0175 #endif
0176