G4eplusAnnihilation Class Reference

#include <G4eplusAnnihilation.hh>

Inheritance diagram for G4eplusAnnihilation:

Public Member Functions
	G4eplusAnnihilation (const G4String &name="annihil")
	~G4eplusAnnihilation () override
G4bool	IsApplicable (const G4ParticleDefinition &p) final
G4VParticleChange *	AtRestDoIt (const G4Track &track, const G4Step &stepData) override
G4double	AtRestGetPhysicalInteractionLength (const G4Track &track, G4ForceCondition *condition) override
void	ProcessDescription (std::ostream &) const override
G4eplusAnnihilation &	operator= (const G4eplusAnnihilation &right)=delete
	G4eplusAnnihilation (const G4eplusAnnihilation &)=delete
Public Member Functions inherited from G4VEmProcess
	G4VEmProcess (const G4String &name, G4ProcessType type=fElectromagnetic)
	~G4VEmProcess () override
void	ProcessDescription (std::ostream &outFile) const override
void	PreparePhysicsTable (const G4ParticleDefinition &) override
void	BuildPhysicsTable (const G4ParticleDefinition &) override
void	StartTracking (G4Track *) override
G4double	PostStepGetPhysicalInteractionLength (const G4Track &track, G4double previousStepSize, G4ForceCondition *condition) override
G4VParticleChange *	PostStepDoIt (const G4Track &, const G4Step &) override
G4bool	StorePhysicsTable (const G4ParticleDefinition *, const G4String &directory, G4bool ascii=false) override
G4bool	RetrievePhysicsTable (const G4ParticleDefinition *, const G4String &directory, G4bool ascii) override
virtual G4VEmProcess *	GetEmProcess (const G4String &name)
G4double	GetLambda (G4double kinEnergy, const G4MaterialCutsCouple *couple, G4double logKinEnergy)
G4double	GetCrossSection (const G4double kinEnergy, const G4MaterialCutsCouple *couple) override
G4double	ComputeCrossSectionPerAtom (G4double kineticEnergy, G4double Z, G4double A=0., G4double cut=0.0)
G4double	MeanFreePath (const G4Track &track)
void	SetLambdaBinning (G4int nbins)
void	SetMinKinEnergy (G4double e)
void	SetMinKinEnergyPrim (G4double e)
void	SetMaxKinEnergy (G4double e)
G4PhysicsTable *	LambdaTable () const
G4PhysicsTable *	LambdaTablePrim () const
void	SetLambdaTable (G4PhysicsTable *)
void	SetLambdaTablePrim (G4PhysicsTable *)
std::vector< G4double > *	EnergyOfCrossSectionMax () const
void	SetEnergyOfCrossSectionMax (std::vector< G4double > *)
G4CrossSectionType	CrossSectionType () const
void	SetCrossSectionType (G4CrossSectionType val)
const G4ParticleDefinition *	Particle () const
const G4ParticleDefinition *	SecondaryParticle () const
G4VEmModel *	SelectModelForMaterial (G4double kinEnergy, std::size_t idxCouple) const
void	AddEmModel (G4int, G4VEmModel *, const G4Region *region=nullptr)
void	SetEmModel (G4VEmModel *, G4int index=0)
G4int	NumberOfModels () const
G4VEmModel *	EmModel (std::size_t index=0) const
const G4VEmModel *	GetCurrentModel () const
G4VEmModel *	GetModelByIndex (G4int idx=0, G4bool ver=false) const
const G4Element *	GetCurrentElement () const
void	SetCrossSectionBiasingFactor (G4double f, G4bool flag=true)
G4double	CrossSectionBiasingFactor () const
void	ActivateForcedInteraction (G4double length=0.0, const G4String &r="", G4bool flag=true)
void	ActivateSecondaryBiasing (const G4String &region, G4double factor, G4double energyLimit)
void	SetEmMasterProcess (const G4VEmProcess *)
void	SetBuildTableFlag (G4bool val)
void	CurrentSetup (const G4MaterialCutsCouple *, G4double energy)
G4bool	UseBaseMaterial () const
void	BuildLambdaTable ()
void	StreamInfo (std::ostream &outFile, const G4ParticleDefinition &, G4bool rst=false) const
	G4VEmProcess (G4VEmProcess &)=delete
G4VEmProcess &	operator= (const G4VEmProcess &right)=delete
Public Member Functions inherited from G4VDiscreteProcess
	G4VDiscreteProcess (const G4String &aName, G4ProcessType aType=fNotDefined)
	G4VDiscreteProcess (G4VDiscreteProcess &)
virtual	~G4VDiscreteProcess ()
G4VDiscreteProcess &	operator= (const G4VDiscreteProcess &)=delete
virtual G4double	AlongStepGetPhysicalInteractionLength (const G4Track &, G4double, G4double, G4double &, G4GPILSelection *)
virtual G4VParticleChange *	AlongStepDoIt (const G4Track &, const G4Step &)
virtual G4double	MinPrimaryEnergy (const G4ParticleDefinition *, const G4Material *)
Public Member Functions inherited from G4VProcess
	G4VProcess (const G4String &aName="NoName", G4ProcessType aType=fNotDefined)
	G4VProcess (const G4VProcess &right)
virtual	~G4VProcess ()
G4VProcess &	operator= (const G4VProcess &)=delete
G4bool	operator== (const G4VProcess &right) const
G4bool	operator!= (const G4VProcess &right) const
G4double	GetCurrentInteractionLength () const
void	SetPILfactor (G4double value)
G4double	GetPILfactor () const
G4double	AlongStepGPIL (const G4Track &track, G4double previousStepSize, G4double currentMinimumStep, G4double &proposedSafety, G4GPILSelection *selection)
G4double	AtRestGPIL (const G4Track &track, G4ForceCondition *condition)
G4double	PostStepGPIL (const G4Track &track, G4double previousStepSize, G4ForceCondition *condition)
const G4String &	GetPhysicsTableFileName (const G4ParticleDefinition *, const G4String &directory, const G4String &tableName, G4bool ascii=false)
const G4String &	GetProcessName () const
G4ProcessType	GetProcessType () const
void	SetProcessType (G4ProcessType)
G4int	GetProcessSubType () const
void	SetProcessSubType (G4int)
virtual const G4VProcess *	GetCreatorProcess () const
virtual void	EndTracking ()
virtual void	SetProcessManager (const G4ProcessManager *)
virtual const G4ProcessManager *	GetProcessManager ()
virtual void	ResetNumberOfInteractionLengthLeft ()
G4double	GetNumberOfInteractionLengthLeft () const
G4double	GetTotalNumberOfInteractionLengthTraversed () const
G4bool	isAtRestDoItIsEnabled () const
G4bool	isAlongStepDoItIsEnabled () const
G4bool	isPostStepDoItIsEnabled () const
virtual void	DumpInfo () const
void	SetVerboseLevel (G4int value)
G4int	GetVerboseLevel () const
virtual void	SetMasterProcess (G4VProcess *masterP)
const G4VProcess *	GetMasterProcess () const
virtual void	BuildWorkerPhysicsTable (const G4ParticleDefinition &part)
virtual void	PrepareWorkerPhysicsTable (const G4ParticleDefinition &)

Protected Member Functions
void	InitialiseProcess (const G4ParticleDefinition *) override
void	StreamProcessInfo (std::ostream &outFile) const override
Protected Member Functions inherited from G4VEmProcess
G4VEmModel *	SelectModel (G4double kinEnergy, std::size_t)
G4double	GetMeanFreePath (const G4Track &track, G4double previousStepSize, G4ForceCondition *condition) override
G4PhysicsVector *	LambdaPhysicsVector (const G4MaterialCutsCouple *)
void	DefineMaterial (const G4MaterialCutsCouple *couple)
G4int	LambdaBinning () const
G4double	MinKinEnergy () const
G4double	MaxKinEnergy () const
G4double	PolarAngleLimit () const
G4ParticleChangeForGamma *	GetParticleChange ()
void	SetParticle (const G4ParticleDefinition *p)
void	SetSecondaryParticle (const G4ParticleDefinition *p)
std::size_t	CurrentMaterialCutsCoupleIndex () const
const G4MaterialCutsCouple *	MaterialCutsCouple () const
G4bool	ApplyCuts () const
G4double	GetGammaEnergyCut ()
G4double	GetElectronEnergyCut ()
void	SetStartFromNullFlag (G4bool val)
void	SetSplineFlag (G4bool val)
const G4Element *	GetTargetElement () const
const G4Isotope *	GetTargetIsotope () const
G4int	DensityIndex (G4int idx) const
G4double	DensityFactor (G4int idx) const
Protected Member Functions inherited from G4VProcess
void	SubtractNumberOfInteractionLengthLeft (G4double prevStepSize)
void	ClearNumberOfInteractionLengthLeft ()

Additional Inherited Members
Static Public Member Functions inherited from G4VProcess
static const G4String &	GetProcessTypeName (G4ProcessType)
Protected Attributes inherited from G4VEmProcess
const G4MaterialCutsCouple *	currentCouple = nullptr
const G4Material *	currentMaterial = nullptr
G4EmBiasingManager *	biasManager = nullptr
std::vector< G4double > *	theEnergyOfCrossSectionMax = nullptr
G4double	mfpKinEnergy = DBL_MAX
G4double	preStepKinEnergy = 0.0
G4double	preStepLambda = 0.0
G4int	mainSecondaries = 1
G4int	secID = _EM
G4int	fluoID = _Fluorescence
G4int	augerID = _AugerElectron
G4int	biasID = _EM
G4int	tripletID = _TripletElectron
std::size_t	currentCoupleIndex = 0
std::size_t	basedCoupleIndex = 0
std::size_t	coupleIdxLambda = 0
std::size_t	idxLambda = 0
G4bool	isTheMaster = false
G4bool	baseMat = false
std::vector< G4DynamicParticle * >	secParticles
G4ParticleChangeForGamma	fParticleChange
Protected Attributes inherited from G4VProcess
const G4ProcessManager *	aProcessManager = nullptr
G4VParticleChange *	pParticleChange = nullptr
G4ParticleChange	aParticleChange
G4double	theNumberOfInteractionLengthLeft = -1.0
G4double	currentInteractionLength = -1.0
G4double	theInitialNumberOfInteractionLength = -1.0
G4String	theProcessName
G4String	thePhysicsTableFileName
G4ProcessType	theProcessType = fNotDefined
G4int	theProcessSubType = -1
G4double	thePILfactor = 1.0
G4int	verboseLevel = 0
G4bool	enableAtRestDoIt = true
G4bool	enableAlongStepDoIt = true
G4bool	enablePostStepDoIt = true

Detailed Description

Definition at line 68 of file G4eplusAnnihilation.hh.

Constructor & Destructor Documentation

G4eplusAnnihilation() [1/2]

G4eplusAnnihilation::G4eplusAnnihilation ( const G4String & name = "annihil" )

explicit

Definition at line 71 of file G4eplusAnnihilation.cc.

  : G4VEmProcess(name)
{
  SetCrossSectionType(fEmDecreasing);
  SetBuildTableFlag(false);
  SetStartFromNullFlag(false);
  SetSecondaryParticle(G4Gamma::Gamma());
  SetProcessSubType(fAnnihilation);
  enableAtRestDoIt = true;
  mainSecondaries = 2;
  fEntanglementModelID = G4PhysicsModelCatalog::GetModelID("model_GammaGammaEntanglement");
}

Referenced by G4eplusAnnihilation(), G4PolarizedAnnihilation::G4PolarizedAnnihilation(), and operator=().

~G4eplusAnnihilation()

G4eplusAnnihilation::~G4eplusAnnihilation ( )

override

Definition at line 86 of file G4eplusAnnihilation.cc.

{
  delete f2GammaAtRestModel;
  delete f3GammaAtRestModel;
}

G4eplusAnnihilation() [2/2]

G4eplusAnnihilation::G4eplusAnnihilation ( const G4eplusAnnihilation & )

delete

Member Function Documentation

AtRestDoIt()

G4VParticleChange * G4eplusAnnihilation::AtRestDoIt ( const G4Track & track, const G4Step & stepData )

overridevirtual

Reimplemented from G4VDiscreteProcess.

Definition at line 149 of file G4eplusAnnihilation.cc.

{
  // positron at rest should be killed
  fParticleChange.InitializeForPostStep(track);
  fParticleChange.SetProposedKineticEnergy(0.);
  fParticleChange.ProposeTrackStatus(fStopAndKill);
 
  auto couple = step.GetPreStepPoint()->GetMaterialCutsCouple();
  DefineMaterial(couple);
  
  G4double gammaCut = GetGammaEnergyCut();
 
  // apply cuts 
  if (fApplyCuts && gammaCut > CLHEP::electron_mass_c2) {
    fParticleChange.ProposeLocalEnergyDeposit(2*CLHEP::electron_mass_c2); 
    return &fParticleChange;
  }
 
  // sample secondaries
  secParticles.clear();
  G4double edep = 0.0;
  if (nullptr != f3GammaAtRestModel &&
      G4UniformRand() < currentMaterial->GetIonisation()->GetOrtoPositroniumFraction()) {
    f3GammaAtRestModel->SampleSecondaries(secParticles, edep, couple->GetMaterial());
  } else {
    f2GammaAtRestModel->SampleSecondaries(secParticles, edep, couple->GetMaterial());
  }
 
  // define new weight for primary and secondaries
  G4double weight = fParticleChange.GetParentWeight();                 
  std::size_t num0 = secParticles.size();
  
  // Russian roulette
  if (nullptr != biasManager) {
    G4int idx = couple->GetIndex();
    if (biasManager->SecondaryBiasingRegion(idx) &&
    !biasManager->GetDirectionalSplitting()) {
      G4VEmModel* mod = EmModel(0);
      G4double eloss = 0.0;
      weight *= biasManager->ApplySecondaryBiasing(secParticles, track, mod,
                           &fParticleChange, eloss, 
                                                   idx, gammaCut);
      edep += eloss;
    }
  }
 
  // save secondaries
  std::size_t num = secParticles.size();
 
  // Prepare a shared pointer only for two first gamma. If it is used, the
  // shared pointer is copied into the tracks through G4EntanglementAuxInfo.
  // This ensures the clip board lasts until both tracks are destroyed.
  // It is assumed that 2 first secondary particles are the most energetic gamma
  std::shared_ptr<G4eplusAnnihilationEntanglementClipBoard> clipBoard;
  if (fEntangled && num >= 2) {
    clipBoard = std::make_shared<G4eplusAnnihilationEntanglementClipBoard>();
    clipBoard->SetParentParticleDefinition(track.GetDefinition());
  }
 
  if (num > 0) {
    const G4double time = track.GetGlobalTime();
    const G4ThreeVector& pos = track.GetPosition();
    auto touch = track.GetTouchableHandle();
    for (std::size_t i=0; i<num; ++i) {
      G4DynamicParticle* dp = secParticles[i];
      G4Track* t = new G4Track(dp, time, pos);
      t->SetTouchableHandle(touch);
      if (fEntangled && i < 2) {
    // entangledgammagamma is only true when there are only two gammas
    // (See code above where entangledgammagamma is calculated.)
    if (nullptr != clipBoard) { 
      if (i == 0) { // First gamma
        clipBoard->SetTrackA(t);
      } else if (i == 1) {  // Second gamma
        clipBoard->SetTrackB(t);
      }
    }
    t->SetAuxiliaryTrackInformation
      (fEntanglementModelID, new G4EntanglementAuxInfo(clipBoard));
      }
      if (nullptr != biasManager) {
    t->SetWeight(weight * biasManager->GetWeight((G4int)i));
      } else {
    t->SetWeight(weight);
      }
      pParticleChange->AddSecondary(t);
 
      // define type of secondary
      if (i < num0) {
    t->SetCreatorModelID(secID);
      }
      else {
    t->SetCreatorModelID(biasID);
      }
    }
  }
  fParticleChange.ProposeLocalEnergyDeposit(edep);
  return &fParticleChange;
}

AtRestGetPhysicalInteractionLength()

G4double G4eplusAnnihilation::AtRestGetPhysicalInteractionLength ( const G4Track & track, G4ForceCondition * condition )

overridevirtual

Reimplemented from G4VDiscreteProcess.

Definition at line 101 of file G4eplusAnnihilation.cc.

{
  *condition = NotForced;
  return 0.0;
}

InitialiseProcess()

void G4eplusAnnihilation::InitialiseProcess ( const G4ParticleDefinition * )

overrideprotectedvirtual

Implements G4VEmProcess.

Definition at line 110 of file G4eplusAnnihilation.cc.

{
  if (!isInitialised) {
    isInitialised = true;
    if(nullptr == EmModel(0)) { SetEmModel(new G4eeToTwoGammaModel()); }
    EmModel(0)->SetLowEnergyLimit(MinKinEnergy());
    EmModel(0)->SetHighEnergyLimit(MaxKinEnergy());
    AddEmModel(1, EmModel(0));
  }
  auto param = G4EmParameters::Instance();
 
  // AtRest models should be chosen only once
  if (nullptr == f2GammaAtRestModel) {
    auto type = param->PositronAtRestModelType();
    if (type == fAllisonPositronium) {
      f2GammaAtRestModel = new G4AllisonPositronAtRestModel();
    } else if (type == fOrePowell) {
      f2GammaAtRestModel = new G4AllisonPositronAtRestModel();
      f3GammaAtRestModel = new G4OrePowellAtRestModel();
    } else if (type == fOrePowellPolar) {
      f2GammaAtRestModel = new G4AllisonPositronAtRestModel();
      f3GammaAtRestModel = new G4PolarizedOrePowellAtRestModel();
    } else {
      f2GammaAtRestModel = new G4SimplePositronAtRestModel();
    }
  }
  // Check that entanglement is switched on
  // It may be set by the UI command "/process/em/QuantumEntanglement true".
  fEntangled = param->QuantumEntanglement();
  fApplyCuts = param->ApplyCuts();
}

IsApplicable()

G4bool G4eplusAnnihilation::IsApplicable ( const G4ParticleDefinition & p )

finalvirtual

Reimplemented from G4VProcess.

Definition at line 94 of file G4eplusAnnihilation.cc.

{
  return (&p == G4Positron::Positron());
}

operator=()

G4eplusAnnihilation & G4eplusAnnihilation::operator= ( const G4eplusAnnihilation & right )

delete

ProcessDescription()

void G4eplusAnnihilation::ProcessDescription ( std::ostream & out ) const

overridevirtual

Reimplemented from G4VProcess.

Reimplemented in G4PolarizedAnnihilation.

Definition at line 252 of file G4eplusAnnihilation.cc.

{
  out << "  Positron annihilation";
  G4VEmProcess::ProcessDescription(out);
}

StreamProcessInfo()

void G4eplusAnnihilation::StreamProcessInfo ( std::ostream & outFile ) const

overrideprotectedvirtual

Reimplemented from G4VEmProcess.

Definition at line 144 of file G4eplusAnnihilation.cc.

{} 

---

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

• G4eplusAnnihilation.hh
• G4eplusAnnihilation.cc