G4ContinuousGainOfEnergy Class Reference

#include <G4ContinuousGainOfEnergy.hh>

Inheritance diagram for G4ContinuousGainOfEnergy:

Public Member Functions
	G4ContinuousGainOfEnergy (const G4String &name="EnergyGain", G4ProcessType type=fElectromagnetic)
	~G4ContinuousGainOfEnergy () override
G4VParticleChange *	AlongStepDoIt (const G4Track &, const G4Step &) override
void	SetLossFluctuations (G4bool val)
void	SetDirectEnergyLossProcess (G4VEnergyLossProcess *aProcess)
void	SetDirectParticle (G4ParticleDefinition *p)
void	ProcessDescription (std::ostream &) const override
void	DumpInfo () const override
	G4ContinuousGainOfEnergy (G4ContinuousGainOfEnergy &)=delete
G4ContinuousGainOfEnergy &	operator= (const G4ContinuousGainOfEnergy &right)=delete
Public Member Functions inherited from G4VContinuousProcess
	G4VContinuousProcess (const G4String &aName, G4ProcessType aType=fNotDefined)
	G4VContinuousProcess (G4VContinuousProcess &)
virtual	~G4VContinuousProcess ()
G4VContinuousProcess &	operator= (const G4VContinuousProcess &)=delete
virtual G4double	AlongStepGetPhysicalInteractionLength (const G4Track &track, G4double previousStepSize, G4double currentMinimumStep, G4double &proposedSafety, G4GPILSelection *selection)
virtual G4double	PostStepGetPhysicalInteractionLength (const G4Track &, G4double, G4ForceCondition *)
virtual G4double	AtRestGetPhysicalInteractionLength (const G4Track &, G4ForceCondition *)
virtual G4VParticleChange *	AtRestDoIt (const G4Track &, const G4Step &)
virtual G4VParticleChange *	PostStepDoIt (const G4Track &, const G4Step &)
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)
virtual G4bool	IsApplicable (const G4ParticleDefinition &)
virtual void	BuildPhysicsTable (const G4ParticleDefinition &)
virtual void	PreparePhysicsTable (const G4ParticleDefinition &)
virtual G4bool	StorePhysicsTable (const G4ParticleDefinition *, const G4String &, G4bool)
virtual G4bool	RetrievePhysicsTable (const G4ParticleDefinition *, const G4String &, G4bool)
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	StartTracking (G4Track *)
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
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
G4double	GetContinuousStepLimit (const G4Track &track, G4double previousStepSize, G4double currentMinimumStep, G4double &currentSafety) override
Protected Member Functions inherited from G4VContinuousProcess
void	SetGPILSelection (G4GPILSelection selection)
G4GPILSelection	GetGPILSelection () 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 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 51 of file G4ContinuousGainOfEnergy.hh.

Constructor & Destructor Documentation

G4ContinuousGainOfEnergy() [1/2]

G4ContinuousGainOfEnergy::G4ContinuousGainOfEnergy ( const G4String & name = "EnergyGain", G4ProcessType type = fElectromagnetic )

explicit

Definition at line 45 of file G4ContinuousGainOfEnergy.cc.

  : G4VContinuousProcess(name, type)
{}

Referenced by G4ContinuousGainOfEnergy(), and operator=().

~G4ContinuousGainOfEnergy()

G4ContinuousGainOfEnergy::~G4ContinuousGainOfEnergy ( )

override

Definition at line 51 of file G4ContinuousGainOfEnergy.cc.

{}

G4ContinuousGainOfEnergy() [2/2]

G4ContinuousGainOfEnergy::G4ContinuousGainOfEnergy ( G4ContinuousGainOfEnergy & )

delete

Member Function Documentation

AlongStepDoIt()

G4VParticleChange * G4ContinuousGainOfEnergy::AlongStepDoIt ( const G4Track & track, const G4Step & step )

overridevirtual

Reimplemented from G4VContinuousProcess.

Definition at line 73 of file G4ContinuousGainOfEnergy.cc.

{
  // Caution in this method the step length should be the true step length
  // A problem is that this is computed by the multiple scattering that does
  // not know the energy at the end of the adjoint step. This energy is used
  // during the forward sim. Nothing we can really do against that at this
  // time. This is inherent to the MS method
 
  aParticleChange.Initialize(track);
 
  // Get the actual (true) Step length
  G4double length = step.GetStepLength();
  G4double degain = 0.0;
 
  // Compute this for weight change after continuous energy loss
  G4double DEDX_before =
    fDirectEnergyLossProcess->GetDEDX(fPreStepKinEnergy, fCurrentCouple);
 
  // For the fluctuation we generate a new dynamic particle with energy
  // = preEnergy+egain and then compute the fluctuation given in the direct
  // case.
  G4DynamicParticle* dynParticle = new G4DynamicParticle();
  *dynParticle                   = *(track.GetDynamicParticle());
  dynParticle->SetDefinition(fDirectPartDef);
  G4double Tkin = dynParticle->GetKineticEnergy();
 
  G4double dlength = length;
  if(Tkin != fPreStepKinEnergy && fIsIon)
  {
    G4double chargeSqRatio = fCurrentModel->GetChargeSquareRatio(
      fDirectPartDef, fCurrentMaterial, Tkin);
    fDirectEnergyLossProcess->SetDynamicMassCharge(fMassRatio, chargeSqRatio);
  }
 
  G4double r = fDirectEnergyLossProcess->GetRange(Tkin, fCurrentCouple);
  if(dlength <= fLinLossLimit * r)
  {
    degain = DEDX_before * dlength;
  }
  else
  {
    G4double x = r + dlength;
    G4double E = fDirectEnergyLossProcess->GetKineticEnergy(x, fCurrentCouple);
    if(fIsIon)
    {
      G4double chargeSqRatio = fCurrentModel->GetChargeSquareRatio(
        fDirectPartDef, fCurrentMaterial, E);
      fDirectEnergyLossProcess->SetDynamicMassCharge(fMassRatio, chargeSqRatio);
      G4double x1 = fDirectEnergyLossProcess->GetRange(E, fCurrentCouple);
 
      G4int ii              = 0;
      constexpr G4int iimax = 100;
      while(std::abs(x - x1) > 0.01 * x)
      {
        E = fDirectEnergyLossProcess->GetKineticEnergy(x, fCurrentCouple);
        chargeSqRatio = fCurrentModel->GetChargeSquareRatio(
          fDirectPartDef, fCurrentMaterial, E);
        fDirectEnergyLossProcess->SetDynamicMassCharge(fMassRatio,
                                                       chargeSqRatio);
        x1 = fDirectEnergyLossProcess->GetRange(E, fCurrentCouple);
        ++ii;
        if(ii >= iimax)
        {
          break;
        }
      }
    }
 
    degain = E - Tkin;
  }
  G4double tmax = fCurrentModel->MaxSecondaryKinEnergy(dynParticle);
  fCurrentTcut = std::min(fCurrentTcut, tmax);
 
  dynParticle->SetKineticEnergy(Tkin + degain);
 
  // Corrections, which cannot be tabulated for ions
  fCurrentModel->CorrectionsAlongStep(fCurrentMaterial, fDirectPartDef, Tkin,
                      fCurrentTcut, dlength, degain);
 
  // Sample fluctuations
  G4double deltaE = 0.;
  if(fLossFluctuationFlag)
  {
    deltaE = fCurrentModel->GetModelOfFluctuations()->SampleFluctuations(
      fCurrentCouple, dynParticle, fCurrentTcut, tmax, dlength, degain) 
      - degain;
  }
 
  G4double egain = degain + deltaE;
  if(egain <= 0.)
    egain = degain;
  Tkin += egain;
  dynParticle->SetKineticEnergy(Tkin);
 
  delete dynParticle;
 
  if(fIsIon)
  {
    G4double chargeSqRatio = fCurrentModel->GetChargeSquareRatio(
      fDirectPartDef, fCurrentMaterial, Tkin);
    fDirectEnergyLossProcess->SetDynamicMassCharge(fMassRatio, chargeSqRatio);
  }
 
  G4double DEDX_after = fDirectEnergyLossProcess->GetDEDX(Tkin, fCurrentCouple);
  G4double weight_correction = DEDX_after / DEDX_before;
 
  aParticleChange.ProposeEnergy(Tkin);
 
  // Caution!!! It is important to select the weight of the post_step_point
  // as the current weight and not the weight of the track, as the  weight of
  // the track is changed after having applied all the along_step_do_it.
 
  G4double new_weight =
    weight_correction * step.GetPostStepPoint()->GetWeight();
  aParticleChange.SetParentWeightByProcess(false);
  aParticleChange.ProposeParentWeight(new_weight);
 
  return &aParticleChange;
}

DumpInfo()

void G4ContinuousGainOfEnergy::DumpInfo ( ) const

inlineoverridevirtual

Reimplemented from G4VProcess.

Definition at line 71 of file G4ContinuousGainOfEnergy.hh.

{ ProcessDescription(G4cout); };

GetContinuousStepLimit()

G4double G4ContinuousGainOfEnergy::GetContinuousStepLimit ( const G4Track & track, G4double previousStepSize, G4double currentMinimumStep, G4double & currentSafety )

overrideprotectedvirtual

Implements G4VContinuousProcess.

Definition at line 203 of file G4ContinuousGainOfEnergy.cc.

{
  DefineMaterial(track.GetMaterialCutsCouple());
 
  fPreStepKinEnergy = track.GetKineticEnergy();
  fCurrentModel     = fDirectEnergyLossProcess->SelectModelForMaterial(
    track.GetKineticEnergy() * fMassRatio, fCurrentCoupleIndex);
  G4double emax_model           = fCurrentModel->HighEnergyLimit();
  G4double preStepChargeSqRatio = 0.;
  if(fIsIon)
  {
    G4double chargeSqRatio = fCurrentModel->GetChargeSquareRatio(
      fDirectPartDef, fCurrentMaterial, fPreStepKinEnergy);
    preStepChargeSqRatio = chargeSqRatio;
    fDirectEnergyLossProcess->SetDynamicMassCharge(fMassRatio,
                                                   preStepChargeSqRatio);
  }
 
  G4double maxE = 1.1 * fPreStepKinEnergy;
 
  if(fPreStepKinEnergy < fCurrentTcut)
    maxE = std::min(fCurrentTcut, maxE);
 
  maxE = std::min(emax_model * 1.001, maxE);
 
  G4double preStepRange =
    fDirectEnergyLossProcess->GetRange(fPreStepKinEnergy, fCurrentCouple);
 
  if(fIsIon)
  {
    G4double chargeSqRatioAtEmax = fCurrentModel->GetChargeSquareRatio(
      fDirectPartDef, fCurrentMaterial, maxE);
    fDirectEnergyLossProcess->SetDynamicMassCharge(fMassRatio,
                                                   chargeSqRatioAtEmax);
  }
 
  G4double r1 = fDirectEnergyLossProcess->GetRange(maxE, fCurrentCouple);
 
  if(fIsIon)
    fDirectEnergyLossProcess->SetDynamicMassCharge(fMassRatio,
                                                   preStepChargeSqRatio);
 
  return std::max(r1 - preStepRange, 0.001 * mm);
}

operator=()

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

delete

ProcessDescription()

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

overridevirtual

Reimplemented from G4VProcess.

Definition at line 54 of file G4ContinuousGainOfEnergy.cc.

{
  out << "Continuous process acting on adjoint particles to compute the "
         "continuous gain of energy of charged particles when they are "
         "tracked back.\n";
}

Referenced by DumpInfo().

SetDirectEnergyLossProcess()

void G4ContinuousGainOfEnergy::SetDirectEnergyLossProcess ( G4VEnergyLossProcess * aProcess )

inline

Definition at line 63 of file G4ContinuousGainOfEnergy.hh.

  {
    fDirectEnergyLossProcess = aProcess;
  };

SetDirectParticle()

void G4ContinuousGainOfEnergy::SetDirectParticle

(

G4ParticleDefinition *

p

)

Definition at line 62 of file G4ContinuousGainOfEnergy.cc.

{
  fDirectPartDef = p;
  if(fDirectPartDef->GetParticleType() == "nucleus")
  {
    fIsIon     = true;
    fMassRatio = proton_mass_c2 / fDirectPartDef->GetPDGMass();
  }
}

SetLossFluctuations()

void G4ContinuousGainOfEnergy::SetLossFluctuations

(

G4bool

val

)

Definition at line 195 of file G4ContinuousGainOfEnergy.cc.

{
  if(val && !fLossFluctuationArePossible)
    return;
  fLossFluctuationFlag = val;
}

---

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

• G4ContinuousGainOfEnergy.hh
• G4ContinuousGainOfEnergy.cc