G4TDNAOneStepThermalizationModel< MODEL > Class Template Reference

#include <G4DNAOneStepThermalizationModel.hh>

Inheritance diagram for G4TDNAOneStepThermalizationModel< MODEL >:

Public Types
using	Model = MODEL

Public Member Functions
	G4TDNAOneStepThermalizationModel (const G4ParticleDefinition *p=nullptr, const G4String &nam="DNAOneStepThermalizationModel")
	~G4TDNAOneStepThermalizationModel () override
void	Initialise (const G4ParticleDefinition *, const G4DataVector &) override
G4double	CrossSectionPerVolume (const G4Material *material, const G4ParticleDefinition *p, G4double ekin, G4double emin, G4double emax) override
void	SampleSecondaries (std::vector< G4DynamicParticle * > *, const G4MaterialCutsCouple *, const G4DynamicParticle *, G4double tmin, G4double maxEnergy) override
void	SetVerbose (int flag)
void	GetPenetration (G4double energy, G4ThreeVector &displacement)
double	GetRmean (double energy)
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	GetPartialCrossSection (const G4Material *, G4int level, const G4ParticleDefinition *, G4double kineticEnergy)
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)
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)
void	SetMasterThread (G4bool)
G4VEmModel &	operator= (const G4VEmModel &right)=delete
	G4VEmModel (const G4VEmModel &)=delete

Protected Attributes
const std::vector< G4double > *	fpWaterDensity
G4ParticleChangeForGamma *	fpParticleChangeForGamma
G4bool	fIsInitialised {false}
G4int	fVerboseLevel
std::unique_ptr< G4Navigator >	fpNavigator
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

template<typename MODEL = DNA::Penetration::Meesungnoen2002>
class G4TDNAOneStepThermalizationModel< MODEL >

When an electron reaches the highest energy domain of G4DNAOneStepThermalizationModel, it is then automatically converted into a solvated electron and displace from its original position using a published thermalization statistic.

Definition at line 137 of file G4DNAOneStepThermalizationModel.hh.

Member Typedef Documentation

Model

template<typename MODEL = DNA::Penetration::Meesungnoen2002>

using G4TDNAOneStepThermalizationModel< MODEL >::Model = MODEL

Definition at line 140 of file G4DNAOneStepThermalizationModel.hh.

Constructor & Destructor Documentation

G4TDNAOneStepThermalizationModel()

template<typename MODEL>

G4TDNAOneStepThermalizationModel< MODEL >::G4TDNAOneStepThermalizationModel	(	const G4ParticleDefinition *	p = nullptr,
		const G4String &	nam = "DNAOneStepThermalizationModel" )

Definition at line 56 of file G4DNAOneStepThermalizationModel.hpp.

                                                      :
G4VEmModel(nam) 
{
  fVerboseLevel = 0;
  SetLowEnergyLimit(0.);
  G4DNAWaterExcitationStructure exStructure;
  SetHighEnergyLimit(exStructure.ExcitationEnergy(0));
  fpParticleChangeForGamma = nullptr;
  fpWaterDensity = nullptr;
}

~G4TDNAOneStepThermalizationModel()

template<typename MODEL>

G4TDNAOneStepThermalizationModel< MODEL >::~G4TDNAOneStepThermalizationModel ( )

overridedefault

Member Function Documentation

CrossSectionPerVolume()

template<typename MODEL>

G4double G4TDNAOneStepThermalizationModel< MODEL >::CrossSectionPerVolume ( const G4Material * material, const G4ParticleDefinition * p, G4double ekin, G4double emin, G4double emax )

overridevirtual

Reimplemented from G4VEmModel.

Definition at line 124 of file G4DNAOneStepThermalizationModel.hpp.

{
#ifdef MODEL_VERBOSE
  if(fVerboseLevel > 1)
    G4cout << "Calling CrossSectionPerVolume() of G4DNAOneStepThermalizationModel"
    << G4endl;
#endif
  
  if(ekin > HighEnergyLimit()){
    return 0.0;
  }
  
  G4double waterDensity = (*fpWaterDensity)[material->GetIndex()];
  
  if(waterDensity!= 0.0){
    return DBL_MAX;
  }
  return 0.;
}

GetPenetration()

template<typename MODEL>

void G4TDNAOneStepThermalizationModel< MODEL >::GetPenetration	(	G4double	energy,
		G4ThreeVector &	displacement )

Definition at line 159 of file G4DNAOneStepThermalizationModel.hpp.

{
  return MODEL::GetPenetration(k, displacement);
}

GetRmean()

template<typename MODEL>

double G4TDNAOneStepThermalizationModel< MODEL >::GetRmean

(

double

energy

)

Definition at line 151 of file G4DNAOneStepThermalizationModel.hpp.

                                                                {
  return MODEL::GetRmean(k);
}

Initialise()

template<typename MODEL>

void G4TDNAOneStepThermalizationModel< MODEL >::Initialise ( const G4ParticleDefinition * particleDefinition, const G4DataVector &  )

overridevirtual

Implements G4VEmModel.

Definition at line 77 of file G4DNAOneStepThermalizationModel.hpp.

{
#ifdef MODEL_VERBOSE
  if(fVerboseLevel)
    G4cout << "Calling G4DNAOneStepThermalizationModel::Initialise()"
           << G4endl;
#endif
  if (particleDefinition->GetParticleName() != "e-")
  {
    G4ExceptionDescription errMsg;
    errMsg << "G4DNAOneStepThermalizationModel can only be applied "
    "to electrons";
    G4Exception("G4DNAOneStepThermalizationModel::CrossSectionPerVolume",
                "G4DNAOneStepThermalizationModel001",
                FatalErrorInArgument,errMsg);
    return;
  }
  
  if(!fIsInitialised)
  {
    fIsInitialised = true;
    fpParticleChangeForGamma = GetParticleChangeForGamma();
  }
  
  G4Navigator* navigator =
  G4TransportationManager::GetTransportationManager()->
  GetNavigatorForTracking();
  
  fpNavigator = std::make_unique<G4Navigator>();
  
  if(navigator != nullptr){ // add these checks for testing mode
    auto world=navigator->GetWorldVolume();
    if(world != nullptr){
      fpNavigator->SetWorldVolume(world);
      //fNavigator->NewNavigatorState();
    }
  }
  
  fpWaterDensity =
  G4DNAMolecularMaterial::Instance()->
  GetNumMolPerVolTableFor(G4Material::GetMaterial("G4_WATER"));
}

SampleSecondaries()

template<typename MODEL>

void G4TDNAOneStepThermalizationModel< MODEL >::SampleSecondaries ( std::vector< G4DynamicParticle * > * , const G4MaterialCutsCouple * , const G4DynamicParticle * particle, G4double tmin, G4double maxEnergy )

overridevirtual

Implements G4VEmModel.

Definition at line 167 of file G4DNAOneStepThermalizationModel.hpp.

{
#ifdef MODEL_VERBOSE
  if(fVerboseLevel)
    G4cout << "Calling SampleSecondaries() of G4DNAOneStepThermalizationModel"
    << G4endl;
#endif
  
  G4double k = particle->GetKineticEnergy();
  
  if (k <= HighEnergyLimit())
  {
    fpParticleChangeForGamma->ProposeTrackStatus(fStopAndKill);
    fpParticleChangeForGamma->ProposeLocalEnergyDeposit(k);
    
    if(G4DNAChemistryManager::IsActivated())
    {
      G4ThreeVector displacement(0,0,0);
      GetPenetration(k, displacement);
      
      //______________________________________________________________
      const G4Track * theIncomingTrack =
      fpParticleChangeForGamma->GetCurrentTrack();
      G4ThreeVector finalPosition(theIncomingTrack->GetPosition()+displacement);
      
      fpNavigator->SetWorldVolume(theIncomingTrack->GetTouchable()->
                                 GetVolume(theIncomingTrack->GetTouchable()->
                                           GetHistoryDepth()));
      
      double displacementMag = displacement.mag();
      double safety = DBL_MAX;
      G4ThreeVector direction = displacement/displacementMag;
      
      //--
      // 6/09/16 - recupere de molecular dissocation
      double mag_displacement = displacement.mag();
      G4ThreeVector displacement_direction = displacement/mag_displacement;
      
      //     double step = DBL_MAX;
      //     step = fNavigator->CheckNextStep(theIncomingTrack->GetPosition(),
      //                                     displacement_direction,
      //                                     mag_displacement,
      //                                     safety);
      //
      //
      //     if(safety < mag_displacement)
      //     {
      ////       mag_displacement = prNewSafety;
      //       finalPosition = theIncomingTrack->GetPosition()
      //       + (displacement/displacementMag)*safety*0.80;
      //     }
      //--
      
      fpNavigator->ResetHierarchyAndLocate(theIncomingTrack->GetPosition(),
                                          direction,
                                          *((G4TouchableHistory*)
                                            theIncomingTrack->GetTouchable()));
      
      fpNavigator->ComputeStep(theIncomingTrack->GetPosition(),
                              displacement/displacementMag,
                              displacementMag,
                              safety);
      
      if(safety <= displacementMag)
      {
        finalPosition = theIncomingTrack->GetPosition()
        + (displacement/displacementMag)*safety*0.80;
      }
      
      G4DNAChemistryManager::Instance()->CreateSolvatedElectron(theIncomingTrack,
                                                                &finalPosition);
      
      fpParticleChangeForGamma->SetProposedKineticEnergy(25.e-3*eV);
    }
  }
}

SetVerbose()

template<typename MODEL = DNA::Penetration::Meesungnoen2002>

void G4TDNAOneStepThermalizationModel< MODEL >::SetVerbose ( int flag )

inline

Definition at line 160 of file G4DNAOneStepThermalizationModel.hh.

                                  {
    fVerboseLevel = flag;
  }

Member Data Documentation

fIsInitialised

template<typename MODEL = DNA::Penetration::Meesungnoen2002>

G4bool G4TDNAOneStepThermalizationModel< MODEL >::fIsInitialised {false}

protected

Definition at line 173 of file G4DNAOneStepThermalizationModel.hh.

{false};

Referenced by Initialise().

fpNavigator

template<typename MODEL = DNA::Penetration::Meesungnoen2002>

std::unique_ptr<G4Navigator> G4TDNAOneStepThermalizationModel< MODEL >::fpNavigator

protected

Definition at line 175 of file G4DNAOneStepThermalizationModel.hh.

Referenced by Initialise().

fpParticleChangeForGamma

template<typename MODEL = DNA::Penetration::Meesungnoen2002>

G4ParticleChangeForGamma* G4TDNAOneStepThermalizationModel< MODEL >::fpParticleChangeForGamma

protected

Definition at line 172 of file G4DNAOneStepThermalizationModel.hh.

Referenced by G4TDNAOneStepThermalizationModel(), and Initialise().

fpWaterDensity

template<typename MODEL = DNA::Penetration::Meesungnoen2002>

const std::vector<G4double>* G4TDNAOneStepThermalizationModel< MODEL >::fpWaterDensity

protected

Definition at line 170 of file G4DNAOneStepThermalizationModel.hh.

Referenced by G4TDNAOneStepThermalizationModel(), and Initialise().

fVerboseLevel

template<typename MODEL = DNA::Penetration::Meesungnoen2002>

G4int G4TDNAOneStepThermalizationModel< MODEL >::fVerboseLevel

protected

Definition at line 174 of file G4DNAOneStepThermalizationModel.hh.

Referenced by CrossSectionPerVolume(), G4TDNAOneStepThermalizationModel(), and Initialise().

---

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

• G4DNAOneStepThermalizationModel.hh
• G4DNAOneStepThermalizationModel.hpp