Geant4 11.2.2
Toolkit for the simulation of the passage of particles through matter
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
G4DNABornExcitationModel2 Class Reference

#include <G4DNABornExcitationModel2.hh>

+ Inheritance diagram for G4DNABornExcitationModel2:

Public Member Functions

 G4DNABornExcitationModel2 (const G4ParticleDefinition *p=nullptr, const G4String &nam="DNABornExcitationModel")
 
 ~G4DNABornExcitationModel2 () override
 
G4DNABornExcitationModel2 & operator= (const G4DNABornExcitationModel2 &right)=delete
 
 G4DNABornExcitationModel2 (const G4DNABornExcitationModel2 &)=delete
 
void Initialise (const G4ParticleDefinition *, const G4DataVector &= *(new G4DataVector())) override
 
G4double CrossSectionPerVolume (const G4Material *material, const G4ParticleDefinition *p, G4double ekin, G4double emin, G4double emax) override
 
G4double GetPartialCrossSection (const G4Material *, G4int level, const G4ParticleDefinition *, G4double kineticEnergy) override
 
void SampleSecondaries (std::vector< G4DynamicParticle * > *, const G4MaterialCutsCouple *, const G4DynamicParticle *, G4double tmin, G4double maxEnergy) override
 
void SelectStationary (G4bool input)
 
- Public Member Functions inherited from G4VEmModel
 G4VEmModel (const G4String &nam)
 
virtual ~G4VEmModel ()
 
virtual void InitialiseLocal (const G4ParticleDefinition *, G4VEmModel *masterModel)
 
virtual void InitialiseForMaterial (const G4ParticleDefinition *, const G4Material *)
 
virtual void InitialiseForElement (const G4ParticleDefinition *, G4int Z)
 
virtual G4double ComputeDEDXPerVolume (const G4Material *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=DBL_MAX)
 
virtual G4double ComputeCrossSectionPerAtom (const G4ParticleDefinition *, G4double kinEnergy, G4double Z, G4double A=0., G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
 
virtual G4double ComputeCrossSectionPerShell (const G4ParticleDefinition *, G4int Z, G4int shellIdx, G4double kinEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
 
virtual G4double ChargeSquareRatio (const G4Track &)
 
virtual G4double GetChargeSquareRatio (const G4ParticleDefinition *, const G4Material *, G4double kineticEnergy)
 
virtual G4double GetParticleCharge (const G4ParticleDefinition *, const G4Material *, G4double kineticEnergy)
 
virtual void StartTracking (G4Track *)
 
virtual void CorrectionsAlongStep (const G4MaterialCutsCouple *, const G4DynamicParticle *, const G4double &length, G4double &eloss)
 
virtual G4double Value (const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy)
 
virtual G4double MinPrimaryEnergy (const G4Material *, const G4ParticleDefinition *, G4double cut=0.0)
 
virtual G4double MinEnergyCut (const G4ParticleDefinition *, const G4MaterialCutsCouple *)
 
virtual void SetupForMaterial (const G4ParticleDefinition *, const G4Material *, G4double kineticEnergy)
 
virtual void DefineForRegion (const G4Region *)
 
virtual void FillNumberOfSecondaries (G4int &numberOfTriplets, G4int &numberOfRecoil)
 
virtual void ModelDescription (std::ostream &outFile) const
 
void InitialiseElementSelectors (const G4ParticleDefinition *, const G4DataVector &)
 
std::vector< G4EmElementSelector * > * GetElementSelectors ()
 
void SetElementSelectors (std::vector< G4EmElementSelector * > *)
 
G4double ComputeDEDX (const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=DBL_MAX)
 
G4double CrossSection (const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
 
G4double ComputeMeanFreePath (const G4ParticleDefinition *, G4double kineticEnergy, const G4Material *, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
 
G4double ComputeCrossSectionPerAtom (const G4ParticleDefinition *, const G4Element *, G4double kinEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
 
const G4Element * SelectRandomAtom (const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
 
const G4Element * SelectTargetAtom (const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy, G4double logKineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
 
const G4Element * SelectRandomAtom (const G4Material *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
 
const G4Element * GetCurrentElement (const G4Material *mat=nullptr) const
 
G4int SelectRandomAtomNumber (const G4Material *) const
 
const G4Isotope * GetCurrentIsotope (const G4Element *elm=nullptr) const
 
G4int SelectIsotopeNumber (const G4Element *) const
 
void SetParticleChange (G4VParticleChange *, G4VEmFluctuationModel *f=nullptr)
 
void SetCrossSectionTable (G4PhysicsTable *, G4bool isLocal)
 
G4ElementData * GetElementData ()
 
G4PhysicsTable * GetCrossSectionTable ()
 
G4VEmFluctuationModel * GetModelOfFluctuations ()
 
G4VEmAngularDistribution * GetAngularDistribution ()
 
G4VEmModel * GetTripletModel ()
 
void SetTripletModel (G4VEmModel *)
 
void SetAngularDistribution (G4VEmAngularDistribution *)
 
G4double HighEnergyLimit () const
 
G4double LowEnergyLimit () const
 
G4double HighEnergyActivationLimit () const
 
G4double LowEnergyActivationLimit () const
 
G4double PolarAngleLimit () const
 
G4double SecondaryThreshold () const
 
G4bool DeexcitationFlag () const
 
G4bool ForceBuildTableFlag () const
 
G4bool UseAngularGeneratorFlag () const
 
void SetAngularGeneratorFlag (G4bool)
 
void SetHighEnergyLimit (G4double)
 
void SetLowEnergyLimit (G4double)
 
void SetActivationHighEnergyLimit (G4double)
 
void SetActivationLowEnergyLimit (G4double)
 
G4bool IsActive (G4double kinEnergy) const
 
void SetPolarAngleLimit (G4double)
 
void SetSecondaryThreshold (G4double)
 
void SetDeexcitationFlag (G4bool val)
 
void SetForceBuildTable (G4bool val)
 
void SetFluctuationFlag (G4bool val)
 
void SetMasterThread (G4bool val)
 
G4bool IsMaster () const
 
void SetUseBaseMaterials (G4bool val)
 
G4bool UseBaseMaterials () const
 
G4double MaxSecondaryKinEnergy (const G4DynamicParticle *dynParticle)
 
const G4String & GetName () const
 
void SetCurrentCouple (const G4MaterialCutsCouple *)
 
G4bool IsLocked () const
 
void SetLocked (G4bool)
 
void SetLPMFlag (G4bool)
 
G4VEmModel & operator= (const G4VEmModel &right)=delete
 
 G4VEmModel (const G4VEmModel &)=delete
 

Protected Attributes

G4ParticleChangeForGamma * fParticleChangeForGamma
 
- Protected Attributes inherited from G4VEmModel
G4ElementData * fElementData = nullptr
 
G4VParticleChange * pParticleChange = nullptr
 
G4PhysicsTable * xSectionTable = nullptr
 
const G4Material * pBaseMaterial = nullptr
 
const std::vector< G4double > * theDensityFactor = nullptr
 
const std::vector< G4int > * theDensityIdx = nullptr
 
G4double inveplus
 
G4double pFactor = 1.0
 
std::size_t currentCoupleIndex = 0
 
std::size_t basedCoupleIndex = 0
 
G4bool lossFlucFlag = true
 

Additional Inherited Members

- Protected Member Functions inherited from G4VEmModel
G4ParticleChangeForLoss * GetParticleChangeForLoss ()
 
G4ParticleChangeForGamma * GetParticleChangeForGamma ()
 
virtual G4double MaxSecondaryEnergy (const G4ParticleDefinition *, G4double kineticEnergy)
 
const G4MaterialCutsCouple * CurrentCouple () const
 
void SetCurrentElement (const G4Element *)
 

Detailed Description

Definition at line 44 of file G4DNABornExcitationModel2.hh.

Constructor & Destructor Documentation

◆ G4DNABornExcitationModel2() [1/2]

G4DNABornExcitationModel2::G4DNABornExcitationModel2 ( const G4ParticleDefinition * p = nullptr,
const G4String & nam = "DNABornExcitationModel" )

Definition at line 43 of file G4DNABornExcitationModel2.cc.

44 :
45G4VEmModel(nam)
46{
47 fpMolWaterDensity = nullptr;
48 fHighEnergy = 0;
49 fLowEnergy = 0;
50 fParticleDefinition = nullptr;
51
52 verboseLevel = 0;
53 // Verbosity scale:
54 // 0 = nothing
55 // 1 = warning for energy non-conservation
56 // 2 = details of energy budget
57 // 3 = calculation of cross sections, file openings, sampling of atoms
58 // 4 = entering in methods
59
60 if (verboseLevel > 0)
61 {
62 G4cout << "Born excitation model is constructed " << G4endl;
63 }
64 fParticleChangeForGamma = nullptr;
65 fLastBinCallForFinalXS = 0;
66 fTotalXS = nullptr;
67 fTableData = nullptr;
68
69 // Selection of stationary mode
70
71 statCode = false;
72}
G4endl
#define G4endl
Definition G4ios.hh:67
G4cout
G4GLOB_DLL std::ostream G4cout
G4DNABornExcitationModel2::fParticleChangeForGamma
G4ParticleChangeForGamma * fParticleChangeForGamma
Definition G4DNABornExcitationModel2.hh:79
G4VEmModel::G4VEmModel
G4VEmModel(const G4String &nam)
Definition G4VEmModel.cc:67

◆ ~G4DNABornExcitationModel2()

G4DNABornExcitationModel2::~G4DNABornExcitationModel2 ( )
override

Definition at line 76 of file G4DNABornExcitationModel2.cc.

77{
78 // Cross section
79
80 delete fTableData;
81}

◆ G4DNABornExcitationModel2() [2/2]

G4DNABornExcitationModel2::G4DNABornExcitationModel2 ( const G4DNABornExcitationModel2 & )
delete

Member Function Documentation

◆ CrossSectionPerVolume()

G4double G4DNABornExcitationModel2::CrossSectionPerVolume ( const G4Material * material,
const G4ParticleDefinition * p,
G4double ekin,
G4double emin,
G4double emax )
overridevirtual

Reimplemented from G4VEmModel.

Definition at line 186 of file G4DNABornExcitationModel2.cc.

191{
192 if (verboseLevel > 3)
193 {
194 G4cout << "Calling CrossSectionPerVolume() of G4DNABornExcitationModel2"
195 << G4endl;
196 }
197
198 if(particleDefinition != fParticleDefinition) return 0;
199
200 // Calculate total cross section for model
201
202 G4double sigma=0;
203
204 G4double waterDensity = (*fpMolWaterDensity)[material->GetIndex()];
205
206 if (ekin >= fLowEnergy && ekin <= fHighEnergy)
207 {
208 sigma = fTotalXS->Value(ekin, fLastBinCallForFinalXS);
209
210 // for(std::size_t i = 0; i < 5; ++i)
211 // sigma += (*fTableData)[i]->Value(ekin);
212
213 if(sigma == 0)
214 {
215 G4cerr << "PROBLEM SIGMA = 0 at " << G4BestUnit(ekin, "Energy")<< G4endl;
216 }
217 }
218
219 if (verboseLevel > 2)
220 {
221 G4cout << "__________________________________" << G4endl;
222 G4cout << "G4DNABornExcitationModel2 - XS INFO START" << G4endl;
223 G4cout << "Kinetic energy(eV)=" << ekin/eV << " particle : " << particleDefinition->GetParticleName() << G4endl;
224 G4cout << "Cross section per water molecule (cm^2)=" << sigma/cm/cm << G4endl;
225 G4cout << "Cross section per water molecule (cm^-1)=" << sigma*waterDensity/(1./cm) << G4endl;
226 G4cout << "G4DNABornExcitationModel2 - XS INFO END" << G4endl;
227 }
228
229 return sigma*waterDensity;
230}
G4BestUnit
#define G4BestUnit(a, b)
Definition G4SteppingVerbose.cc:46
G4double
double G4double
Definition G4Types.hh:83
G4cerr
G4GLOB_DLL std::ostream G4cerr
G4Material::GetIndex
std::size_t GetIndex() const
Definition G4Material.hh:239
G4PhysicsVector::Value
G4double Value(const G4double energy, std::size_t &lastidx) const

◆ GetPartialCrossSection()

G4double G4DNABornExcitationModel2::GetPartialCrossSection ( const G4Material * ,
G4int level,
const G4ParticleDefinition * particle,
G4double kineticEnergy )
overridevirtual

Reimplemented from G4VEmModel.

Definition at line 271 of file G4DNABornExcitationModel2.cc.

275{
276 if (fParticleDefinition != particle)
277 {
278 G4Exception("G4DNABornExcitationModel2::GetPartialCrossSection",
279 "bornParticleType",
280 FatalException,
281 "Model initialized for another particle type.");
282 }
283
284 return (*fTableData)(level)->Value(kineticEnergy);
285}
FatalException
@ FatalException
Definition G4ExceptionSeverity.hh:67
G4Exception
void G4Exception(const char *originOfException, const char *exceptionCode, G4ExceptionSeverity severity, const char *description)
Definition G4Exception.cc:59
G4VEmModel::Value
virtual G4double Value(const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy)
Definition G4VEmModel.cc:346

◆ Initialise()

void G4DNABornExcitationModel2::Initialise ( const G4ParticleDefinition * particle,
const G4DataVector & = *(new G4DataVector()) )
overridevirtual

Implements G4VEmModel.

Definition at line 85 of file G4DNABornExcitationModel2.cc.

87{
88
89 if (verboseLevel > 3)
90 {
91 G4cout << "Calling G4DNABornExcitationModel2::Initialise()" << G4endl;
92 }
93
94 if(fParticleDefinition != nullptr && fParticleDefinition != particle)
95 {
96 G4Exception("G4DNABornExcitationModel2::Initialise","em0001",
97 FatalException,"Model already initialized for another particle type.");
98 }
99
100 fParticleDefinition = particle;
101
102 std::ostringstream fullFileName;
103 const char* path = G4FindDataDir("G4LEDATA");
104
105 if(G4String(path).empty())
106 {
107 G4Exception("G4DNABornExcitationModel2::Initialise","G4LEDATA-CHECK",
108 FatalException, "G4LEDATA not defined in environment variables");
109 }
110
111 fullFileName << path;
112
113 if(particle->GetParticleName() == "e-")
114 {
115 fullFileName << "/dna/bornExcitation-e.dat";
116 fLowEnergy = 9*eV;
117 fHighEnergy = 1*MeV;
118 }
119 else if(particle->GetParticleName() == "proton")
120 {
121 fullFileName << "/dna/bornExcitation-p.dat";
122 fLowEnergy = 500. * keV;
123 fHighEnergy = 100. * MeV;
124 }
125
126 SetLowEnergyLimit(fLowEnergy);
127 SetHighEnergyLimit(fHighEnergy);
128
129 //G4double scaleFactor = (1.e-22 / 3.343) * m*m;
130
131 fTableData = new G4PhysicsTable();
132 fTableData->RetrievePhysicsTable(fullFileName.str().c_str(), true);
133 /*
134 for(std::size_t level = 0; level<fTableData->size(); ++level)
135 {
136 //(*fTableData)(level)->ScaleVector(1,scaleFactor);
137 }
138 */
139 std::size_t finalBin_i = 2000;
140 G4double E_min = fLowEnergy;
141 G4double E_max = fHighEnergy;
142 fTotalXS = new G4PhysicsLogVector(E_min, E_max, finalBin_i, true);
143 G4double energy;
144 G4double finalXS;
145
146 for(std::size_t energy_i = 0; energy_i < finalBin_i; ++energy_i)
147 {
148 energy = fTotalXS->Energy(energy_i);
149 finalXS = 0;
150
151 for(std::size_t level = 0; level<fTableData->size(); ++level)
152 {
153 finalXS += (*fTableData)(level)->Value(energy);
154 }
155 fTotalXS->PutValue(energy_i, finalXS);
156 //G4cout << "energy = " << energy << " " << fTotalXS->Value(energy)
157 // << " " << energy_i << " " << finalXS << G4endl;
158 }
159
160 // for(energy = LowEnergyLimit() ; energy < HighEnergyLimit() ; energy += 1*pow(10,log10(energy)))
161 // {
162 // G4cout << "energy = " << energy << " " << fTotalXS->Value(energy) << G4endl;
163 // }
164
165 if( verboseLevel>0 )
166 {
167 G4cout << "Born excitation model is initialized " << G4endl
168 << "Energy range: "
169 << LowEnergyLimit() / eV << " eV - "
170 << HighEnergyLimit() / keV << " keV for "
171 << particle->GetParticleName()
172 << G4endl;
173 }
174
175 // Initialize water density pointer
176 fpMolWaterDensity = G4DNAMolecularMaterial::Instance()->GetNumMolPerVolTableFor(G4Material::GetMaterial("G4_WATER"));
177
178 if (isInitialised)
179 { return;}
180 fParticleChangeForGamma = GetParticleChangeForGamma();
181 isInitialised = true;
182}
G4FindDataDir
const char * G4FindDataDir(const char *)
Definition G4FindDataDir.cc:94
G4DNAMolecularMaterial::GetNumMolPerVolTableFor
const std::vector< G4double > * GetNumMolPerVolTableFor(const G4Material *) const
Retrieve a table of molecular densities (number of molecules per unit volume) in the G4 unit system f...
Definition G4DNAMolecularMaterial.cc:396
G4DNAMolecularMaterial::Instance
static G4DNAMolecularMaterial * Instance()
Definition G4DNAMolecularMaterial.cc:80
G4Material::GetMaterial
static G4Material * GetMaterial(const G4String &name, G4bool warning=true)
Definition G4Material.cc:653
G4ParticleDefinition::GetParticleName
const G4String & GetParticleName() const
Definition G4ParticleDefinition.hh:96
G4PhysicsTable::RetrievePhysicsTable
G4bool RetrievePhysicsTable(const G4String &filename, G4bool ascii=false, G4bool spline=false)
Definition G4PhysicsTable.cc:140
G4PhysicsVector::PutValue
void PutValue(const std::size_t index, const G4double value)
G4PhysicsVector::Energy
G4double Energy(const std::size_t index) const
G4VEmModel::SetHighEnergyLimit
void SetHighEnergyLimit(G4double)
Definition G4VEmModel.hh:738
G4VEmModel::GetParticleChangeForGamma
G4ParticleChangeForGamma * GetParticleChangeForGamma()
Definition G4VEmModel.cc:120
G4VEmModel::LowEnergyLimit
G4double LowEnergyLimit() const
Definition G4VEmModel.hh:640
G4VEmModel::HighEnergyLimit
G4double HighEnergyLimit() const
Definition G4VEmModel.hh:633
G4VEmModel::SetLowEnergyLimit
void SetLowEnergyLimit(G4double)
Definition G4VEmModel.hh:745
G4INCL::KinematicsUtils::energy
G4double energy(const ThreeVector &p, const G4double m)
Definition G4INCLKinematicsUtils.cc:185

◆ operator=()

G4DNABornExcitationModel2 & G4DNABornExcitationModel2::operator= ( const G4DNABornExcitationModel2 & right)
delete

◆ SampleSecondaries()

void G4DNABornExcitationModel2::SampleSecondaries ( std::vector< G4DynamicParticle * > * ,
const G4MaterialCutsCouple * ,
const G4DynamicParticle * aDynamicParticle,
G4double tmin,
G4double maxEnergy )
overridevirtual

Implements G4VEmModel.

Definition at line 234 of file G4DNABornExcitationModel2.cc.

239{
240
241 if (verboseLevel > 3)
242 {
243 G4cout << "Calling SampleSecondaries() of G4DNABornExcitationModel2"
244 << G4endl;
245 }
246
247 G4double k = aDynamicParticle->GetKineticEnergy();
248
249 G4int level = RandomSelect(k);
250 G4double excitationEnergy = waterStructure.ExcitationEnergy(level);
251 G4double newEnergy = k - excitationEnergy;
252
253 if (newEnergy > 0)
254 {
255 fParticleChangeForGamma->ProposeMomentumDirection(aDynamicParticle->GetMomentumDirection());
256
257 if (!statCode) fParticleChangeForGamma->SetProposedKineticEnergy(newEnergy);
258 else fParticleChangeForGamma->SetProposedKineticEnergy(k);
259
260 fParticleChangeForGamma->ProposeLocalEnergyDeposit(excitationEnergy);
261 }
262
263 const G4Track * theIncomingTrack = fParticleChangeForGamma->GetCurrentTrack();
264 G4DNAChemistryManager::Instance()->CreateWaterMolecule(eExcitedMolecule,
265 level,
266 theIncomingTrack);
267}
eExcitedMolecule
@ eExcitedMolecule
Definition G4DNAChemistryManager.hh:71
G4int
int G4int
Definition G4Types.hh:85
G4DNAChemistryManager::Instance
static G4DNAChemistryManager * Instance()
Definition G4DNAChemistryManager.cc:124
G4DNAChemistryManager::CreateWaterMolecule
void CreateWaterMolecule(ElectronicModification, G4int, const G4Track *)
Definition G4DNAChemistryManager.cc:595
G4DynamicParticle::GetMomentumDirection
const G4ThreeVector & GetMomentumDirection() const
G4DynamicParticle::GetKineticEnergy
G4double GetKineticEnergy() const
G4ParticleChangeForGamma::SetProposedKineticEnergy
void SetProposedKineticEnergy(G4double proposedKinEnergy)
Definition G4ParticleChangeForGamma.hh:106
G4ParticleChangeForGamma::ProposeMomentumDirection
void ProposeMomentumDirection(const G4ThreeVector &Pfinal)
Definition G4ParticleChangeForGamma.hh:120
G4VParticleChange::GetCurrentTrack
const G4Track * GetCurrentTrack() const
G4VParticleChange::ProposeLocalEnergyDeposit
void ProposeLocalEnergyDeposit(G4double anEnergyPart)

◆ SelectStationary()

void G4DNABornExcitationModel2::SelectStationary ( G4bool input)
inline

Definition at line 109 of file G4DNABornExcitationModel2.hh.

110{
111 statCode = input;
112}

Member Data Documentation

◆ fParticleChangeForGamma

G4ParticleChangeForGamma* G4DNABornExcitationModel2::fParticleChangeForGamma
protected

Definition at line 79 of file G4DNABornExcitationModel2.hh.

Referenced by G4DNABornExcitationModel2(), Initialise(), and SampleSecondaries().

The documentation for this class was generated from the following files: