G4ParticleChangeForLoss Class Reference

#include <G4ParticleChangeForLoss.hh>

Inheritance diagram for G4ParticleChangeForLoss:

Public Member Functions
	G4ParticleChangeForLoss ()
	~G4ParticleChangeForLoss () override=default
	G4ParticleChangeForLoss (const G4ParticleChangeForLoss &right)=delete
G4ParticleChangeForLoss &	operator= (const G4ParticleChangeForLoss &right)=delete
G4Step *	UpdateStepForAlongStep (G4Step *step) final
G4Step *	UpdateStepForPostStep (G4Step *step) final
void	InitializeForAlongStep (const G4Track &)
void	InitializeForPostStep (const G4Track &)
G4double	GetProposedCharge () const
void	SetProposedCharge (G4double theCharge)
G4double	GetProposedKineticEnergy () const
void	SetProposedKineticEnergy (G4double proposedKinEnergy)
const G4ThreeVector &	GetProposedMomentumDirection () const
void	SetProposedMomentumDirection (const G4ThreeVector &dir)
void	ProposeMomentumDirection (const G4ThreeVector &Pfinal)
const G4ThreeVector &	GetProposedPolarization () const
void	ProposePolarization (const G4ThreeVector &dir)
void	ProposePolarization (G4double Px, G4double Py, G4double Pz)
void	DumpInfo () const final
Public Member Functions inherited from G4VParticleChange
	G4VParticleChange ()
virtual	~G4VParticleChange ()=default
	G4VParticleChange (const G4VParticleChange &right)=delete
G4VParticleChange &	operator= (const G4VParticleChange &right)=delete
virtual G4Step *	UpdateStepForAtRest (G4Step *Step)
virtual void	Initialize (const G4Track &)
G4double	GetTrueStepLength () const
void	ProposeTrueStepLength (G4double truePathLength)
G4double	GetLocalEnergyDeposit () const
void	ProposeLocalEnergyDeposit (G4double anEnergyPart)
G4double	GetNonIonizingEnergyDeposit () const
void	ProposeNonIonizingEnergyDeposit (G4double anEnergyPart)
G4TrackStatus	GetTrackStatus () const
void	ProposeTrackStatus (G4TrackStatus status)
const G4Track *	GetCurrentTrack () const
G4SteppingControl	GetSteppingControl () const
void	ProposeSteppingControl (G4SteppingControl StepControlFlag)
G4bool	GetFirstStepInVolume () const
G4bool	GetLastStepInVolume () const
void	ProposeFirstStepInVolume (G4bool flag)
void	ProposeLastStepInVolume (G4bool flag)
void	Clear ()
void	SetNumberOfSecondaries (G4int totSecondaries)
G4int	GetNumberOfSecondaries () const
G4Track *	GetSecondary (G4int anIndex) const
void	AddSecondary (G4Track *aSecondary)
G4double	GetWeight () const
G4double	GetParentWeight () const
void	ProposeWeight (G4double finalWeight)
void	ProposeParentWeight (G4double finalWeight)
void	SetSecondaryWeightByProcess (G4bool)
G4bool	IsSecondaryWeightSetByProcess () const
void	SetParentWeightByProcess (G4bool)
G4bool	IsParentWeightSetByProcess () const
void	SetVerboseLevel (G4int vLevel)
G4int	GetVerboseLevel () const
virtual G4bool	CheckIt (const G4Track &)
void	ClearDebugFlag ()
void	SetDebugFlag ()
G4bool	GetDebugFlag () const

Additional Inherited Members
Protected Member Functions inherited from G4VParticleChange
G4Step *	UpdateStepInfo (G4Step *Step)
void	InitializeLocalEnergyDeposit ()
void	InitializeSteppingControl ()
void	InitializeParentWeight (const G4Track &)
void	InitializeStatusChange (const G4Track &)
void	InitializeSecondaries ()
void	InitializeFromStep (const G4Step *)
G4double	ComputeBeta (G4double kinEnergy)
G4bool	CheckSecondary (G4Track &)
G4double	GetAccuracyForWarning () const
G4double	GetAccuracyForException () const
Protected Attributes inherited from G4VParticleChange
const G4Track *	theCurrentTrack = nullptr
std::vector< G4Track * >	theListOfSecondaries
G4TrackStatus	theStatusChange = fAlive
G4SteppingControl	theSteppingControlFlag = NormalCondition
G4double	theLocalEnergyDeposit = 0.0
G4double	theNonIonizingEnergyDeposit = 0.0
G4double	theTrueStepLength = 0.0
G4double	theParentWeight = 1.0
G4double	theParentGlobalTime = 0.0
G4int	theNumberOfSecondaries = 0
G4int	theSizeOftheListOfSecondaries = 0
G4int	verboseLevel = 1
G4int	nError = 0
G4bool	theFirstStepInVolume = false
G4bool	theLastStepInVolume = false
G4bool	isParentWeightProposed = false
G4bool	fSetSecondaryWeightByProcess = false
G4bool	debugFlag = false
Static Protected Attributes inherited from G4VParticleChange
static const G4double	accuracyForWarning = 1.0e-9
static const G4double	accuracyForException = 0.001
static const G4int	maxError = 10

Detailed Description

Definition at line 42 of file G4ParticleChangeForLoss.hh.

Constructor & Destructor Documentation

G4ParticleChangeForLoss() [1/2]

G4ParticleChangeForLoss::G4ParticleChangeForLoss

(

)

Definition at line 37 of file G4ParticleChangeForLoss.cc.

{
  // Disable flag that is enabled in G4VParticleChange if G4VERBOSE.
  debugFlag = false;
}

~G4ParticleChangeForLoss()

G4ParticleChangeForLoss::~G4ParticleChangeForLoss ( )

overridedefault

G4ParticleChangeForLoss() [2/2]

G4ParticleChangeForLoss::G4ParticleChangeForLoss ( const G4ParticleChangeForLoss & right )

delete

Member Function Documentation

DumpInfo()

void G4ParticleChangeForLoss::DumpInfo ( ) const

finalvirtual

Reimplemented from G4VParticleChange.

Definition at line 44 of file G4ParticleChangeForLoss.cc.

{
  // use base-class DumpInfo
  G4VParticleChange::DumpInfo();
 
  G4long oldprc = G4cout.precision(8);
  G4cout << "      -----------------------------------------------" << G4endl;
  G4cout << "        G4ParticleChangeForLoss proposes: " << G4endl;
  G4cout << "        Charge (eplus)   : " << std::setw(20)
         << currentCharge / eplus << G4endl;
  G4cout << "        Kinetic Energy (MeV): " << std::setw(20)
         << proposedKinEnergy / MeV << G4endl;
  G4cout << "        Momentum Direct - x : " << std::setw(20)
         << proposedMomentumDirection.x() << G4endl;
  G4cout << "        Momentum Direct - y : " << std::setw(20)
         << proposedMomentumDirection.y() << G4endl;
  G4cout << "        Momentum Direct - z : " << std::setw(20)
         << proposedMomentumDirection.z() << G4endl;
  G4cout.precision(oldprc);
}

GetProposedCharge()

G4double G4ParticleChangeForLoss::GetProposedCharge ( ) const

inline

Definition at line 113 of file G4ParticleChangeForLoss.hh.

{
  return currentCharge;
}

GetProposedKineticEnergy()

G4double G4ParticleChangeForLoss::GetProposedKineticEnergy ( ) const

inline

Definition at line 102 of file G4ParticleChangeForLoss.hh.

{
  return proposedKinEnergy;
}

Referenced by G4EmBiasingManager::ApplySecondaryBiasing(), and G4VEnergyLossProcess::PostStepDoIt().

GetProposedMomentumDirection()

const G4ThreeVector & G4ParticleChangeForLoss::GetProposedMomentumDirection ( ) const

inline

Definition at line 126 of file G4ParticleChangeForLoss.hh.

{
  return proposedMomentumDirection;
}

Referenced by G4EmBiasingManager::ApplySecondaryBiasing(), and G4PolarizedBremsstrahlungModel::SampleSecondaries().

GetProposedPolarization()

const G4ThreeVector & G4ParticleChangeForLoss::GetProposedPolarization ( ) const

inline

Definition at line 145 of file G4ParticleChangeForLoss.hh.

{
  return proposedPolarization;
}

InitializeForAlongStep()

void G4ParticleChangeForLoss::InitializeForAlongStep ( const G4Track & track )

inline

Definition at line 164 of file G4ParticleChangeForLoss.hh.

{
  InitializeSecondaries();
  InitializeLocalEnergyDeposit();
  InitializeParentWeight(track);
  InitializeStatusChange(track);
  proposedKinEnergy = track.GetKineticEnergy();
  currentCharge = track.GetDynamicParticle()->GetCharge();
}

Referenced by G4NuclearStopping::AlongStepDoIt(), G4VEnergyLossProcess::AlongStepDoIt(), and InitializeForPostStep().

InitializeForPostStep()

void G4ParticleChangeForLoss::InitializeForPostStep ( const G4Track & track )

inline

Definition at line 175 of file G4ParticleChangeForLoss.hh.

{
  InitializeForAlongStep(track);
  proposedMomentumDirection = track.GetMomentumDirection();
  proposedPolarization = track.GetPolarization();
}

Referenced by G4VEnergyLossProcess::PostStepDoIt().

operator=()

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

delete

ProposeMomentumDirection()

void G4ParticleChangeForLoss::ProposeMomentumDirection ( const G4ThreeVector & Pfinal )

inline

Definition at line 132 of file G4ParticleChangeForLoss.hh.

{
  proposedMomentumDirection = dir;
}

Referenced by G4EmBiasingManager::ApplySecondaryBiasing(), G4LivermoreIonisationModel::SampleSecondaries(), G4PenelopeBremsstrahlungModel::SampleSecondaries(), and G4PenelopeIonisationModel::SampleSecondaries().

ProposePolarization() [1/2]

void G4ParticleChangeForLoss::ProposePolarization ( const G4ThreeVector & dir )

inline

Definition at line 151 of file G4ParticleChangeForLoss.hh.

{
  proposedPolarization = dir;
}

Referenced by G4PolarizedBremsstrahlungModel::SampleSecondaries(), and G4PolarizedIonisationModel::SampleSecondaries().

ProposePolarization() [2/2]

void G4ParticleChangeForLoss::ProposePolarization ( G4double Px, G4double Py, G4double Pz )

inline

Definition at line 156 of file G4ParticleChangeForLoss.hh.

{
  proposedPolarization.set(Px, Py, Pz);
}

SetProposedCharge()

void G4ParticleChangeForLoss::SetProposedCharge ( G4double theCharge )

inline

Definition at line 119 of file G4ParticleChangeForLoss.hh.

{
  currentCharge = theCharge;
}

Referenced by G4NuclearStopping::AlongStepDoIt(), and G4VEnergyLossProcess::AlongStepDoIt().

SetProposedKineticEnergy()

void G4ParticleChangeForLoss::SetProposedKineticEnergy ( G4double proposedKinEnergy )

inline

Definition at line 108 of file G4ParticleChangeForLoss.hh.

{
  proposedKinEnergy = energy;
}

Referenced by G4NuclearStopping::AlongStepDoIt(), G4VEnergyLossProcess::AlongStepDoIt(), G4EmBiasingManager::ApplySecondaryBiasing(), G4AtimaEnergyLossModel::SampleSecondaries(), G4BetheBlochModel::SampleSecondaries(), G4BraggModel::SampleSecondaries(), G4eBremParametrizedModel::SampleSecondaries(), G4eBremsstrahlungRelModel::SampleSecondaries(), G4ICRU73QOModel::SampleSecondaries(), G4IonParametrisedLossModel::SampleSecondaries(), G4LindhardSorensenIonModel::SampleSecondaries(), G4LivermoreBremsstrahlungModel::SampleSecondaries(), G4LivermoreIonisationModel::SampleSecondaries(), G4MollerBhabhaModel::SampleSecondaries(), G4mplIonisationWithDeltaModel::SampleSecondaries(), G4MuBetheBlochModel::SampleSecondaries(), G4MuBremsstrahlungModel::SampleSecondaries(), G4MuonToMuonPairProductionModel::SampleSecondaries(), G4MuPairProductionModel::SampleSecondaries(), G4PAIModel::SampleSecondaries(), G4PAIPhotModel::SampleSecondaries(), G4PenelopeBremsstrahlungModel::SampleSecondaries(), G4PenelopeIonisationModel::SampleSecondaries(), G4PolarizedIonisationModel::SampleSecondaries(), and G4SeltzerBergerModel::SampleSecondaries().

SetProposedMomentumDirection()

void G4ParticleChangeForLoss::SetProposedMomentumDirection ( const G4ThreeVector & dir )

inline

Definition at line 139 of file G4ParticleChangeForLoss.hh.

{
  proposedMomentumDirection = dir;
}

Referenced by G4AtimaEnergyLossModel::SampleSecondaries(), G4BetheBlochModel::SampleSecondaries(), G4BraggModel::SampleSecondaries(), G4eBremParametrizedModel::SampleSecondaries(), G4eBremsstrahlungRelModel::SampleSecondaries(), G4ICRU73QOModel::SampleSecondaries(), G4IonParametrisedLossModel::SampleSecondaries(), G4LindhardSorensenIonModel::SampleSecondaries(), G4LivermoreBremsstrahlungModel::SampleSecondaries(), G4MollerBhabhaModel::SampleSecondaries(), G4mplIonisationWithDeltaModel::SampleSecondaries(), G4MuBetheBlochModel::SampleSecondaries(), G4MuBremsstrahlungModel::SampleSecondaries(), G4MuonToMuonPairProductionModel::SampleSecondaries(), G4MuPairProductionModel::SampleSecondaries(), G4PAIModel::SampleSecondaries(), G4PAIPhotModel::SampleSecondaries(), G4PolarizedIonisationModel::SampleSecondaries(), and G4SeltzerBergerModel::SampleSecondaries().

UpdateStepForAlongStep()

G4Step * G4ParticleChangeForLoss::UpdateStepForAlongStep ( G4Step * step )

finalvirtual

Reimplemented from G4VParticleChange.

Definition at line 66 of file G4ParticleChangeForLoss.cc.

{
  const G4StepPoint* pPreStepPoint = pStep->GetPreStepPoint();
  G4StepPoint* pPostStepPoint = pStep->GetPostStepPoint();
 
  // accumulate change of the kinetic energy
  G4double preKinEnergy = pPreStepPoint->GetKineticEnergy();
  G4double kinEnergy =
    pPostStepPoint->GetKineticEnergy() + (proposedKinEnergy - preKinEnergy);
 
  pPostStepPoint->SetCharge(currentCharge);
 
  // calculate velocity
  if(kinEnergy > 0.0)
  {
    pPostStepPoint->SetKineticEnergy(kinEnergy);
 
    // assuming that mass>0, zero mass particles do not have energy loss
    pPostStepPoint->SetVelocity(CLHEP::c_light*ComputeBeta(kinEnergy));
  } 
  else 
  {
    pPostStepPoint->SetKineticEnergy(0.0);
    pPostStepPoint->SetVelocity(0.0);
  }
 
  if(isParentWeightProposed)
  {
    pPostStepPoint->SetWeight(theParentWeight);
  }
 
  pStep->AddTotalEnergyDeposit(theLocalEnergyDeposit);
  pStep->AddNonIonizingEnergyDeposit(theNonIonizingEnergyDeposit);
  return pStep;
}

UpdateStepForPostStep()

G4Step * G4ParticleChangeForLoss::UpdateStepForPostStep ( G4Step * step )

finalvirtual

Reimplemented from G4VParticleChange.

Definition at line 103 of file G4ParticleChangeForLoss.cc.

{
  G4StepPoint* pPostStepPoint = pStep->GetPostStepPoint();
 
  pPostStepPoint->SetCharge(currentCharge);
  pPostStepPoint->SetMomentumDirection(proposedMomentumDirection);
  if(proposedKinEnergy > 0.0)
  {
    pPostStepPoint->SetKineticEnergy(proposedKinEnergy);
 
    // assuming that mass>0, zero mass particles do not have energy loss
    pPostStepPoint->SetVelocity(CLHEP::c_light*ComputeBeta(proposedKinEnergy));
  }
  else
  {
    pPostStepPoint->SetKineticEnergy(0.0);
    pPostStepPoint->SetVelocity(0.0);
  }
  pPostStepPoint->SetPolarization(proposedPolarization);
 
  if(isParentWeightProposed)
  {
    pPostStepPoint->SetWeight(theParentWeight);
  }
 
  pStep->AddTotalEnergyDeposit(theLocalEnergyDeposit);
  pStep->AddNonIonizingEnergyDeposit(theNonIonizingEnergyDeposit);
  return pStep;
}

---

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

• G4ParticleChangeForLoss.hh
• G4ParticleChangeForLoss.cc