#include <G4PolarizedIonisation.hh>

Inheritance diagram for G4PolarizedIonisation:

Public Member Functions
	G4PolarizedIonisation (const G4String &name="pol-eIoni")

virtual	~G4PolarizedIonisation () override

virtual G4bool	IsApplicable (const G4ParticleDefinition &p) override

virtual void	ProcessDescription (std::ostream &) const override

virtual void	DumpInfo () const override

G4PolarizedIonisation &	operator= (const G4PolarizedIonisation &right)=delete

	G4PolarizedIonisation (const G4PolarizedIonisation &)=delete

Public Member Functions inherited from G4VEnergyLossProcess
	G4VEnergyLossProcess (const G4String &name="EnergyLoss", G4ProcessType type=fElectromagnetic)

	~G4VEnergyLossProcess () override

void	ProcessDescription (std::ostream &outFile) const override

void	PreparePhysicsTable (const G4ParticleDefinition &) override

void	BuildPhysicsTable (const G4ParticleDefinition &) override

G4PhysicsTable *	BuildDEDXTable (G4EmTableType tType=fRestricted)

G4PhysicsTable *	BuildLambdaTable (G4EmTableType tType=fRestricted)

void	StartTracking (G4Track *) override

G4double	AlongStepGetPhysicalInteractionLength (const G4Track &, G4double previousStepSize, G4double currentMinimumStep, G4double &currentSafety, G4GPILSelection *selection) override

G4double	PostStepGetPhysicalInteractionLength (const G4Track &track, G4double previousStepSize, G4ForceCondition *condition) override

G4VParticleChange *	AlongStepDoIt (const G4Track &, const G4Step &) 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

G4double	GetDEDXDispersion (const G4MaterialCutsCouple couple, const G4DynamicParticle dp, G4double length)

G4double	CrossSectionPerVolume (G4double kineticEnergy, const G4MaterialCutsCouple *couple)

G4double	CrossSectionPerVolume (G4double kineticEnergy, const G4MaterialCutsCouple *couple, G4double logKineticEnergy)

G4double	MeanFreePath (const G4Track &track)

G4double	ContinuousStepLimit (const G4Track &track, G4double previousStepSize, G4double currentMinimumStep, G4double &currentSafety)

G4VEmModel *	SelectModelForMaterial (G4double kinEnergy, std::size_t &idxCouple) const

void	AddEmModel (G4int, G4VEmModel , G4VEmFluctuationModel fluc=nullptr, const G4Region *region=nullptr)

void	SetEmModel (G4VEmModel *, G4int index=0)

std::size_t	NumberOfModels () const

G4VEmModel *	EmModel (std::size_t index=0) const

G4VEmModel *	GetModelByIndex (std::size_t idx=0, G4bool ver=false) const

void	SetFluctModel (G4VEmFluctuationModel *)

G4VEmFluctuationModel *	FluctModel () const

void	SetBaseParticle (const G4ParticleDefinition *p)

const G4ParticleDefinition *	Particle () const

const G4ParticleDefinition *	BaseParticle () const

const G4ParticleDefinition *	SecondaryParticle () const

	G4VEnergyLossProcess (G4VEnergyLossProcess &)=delete

G4VEnergyLossProcess &	operator= (const G4VEnergyLossProcess &right)=delete

void	ActivateSubCutoff (const G4Region *region)

void	SetCrossSectionBiasingFactor (G4double f, G4bool flag=true)

void	ActivateForcedInteraction (G4double length, const G4String &region, G4bool flag=true)

void	ActivateSecondaryBiasing (const G4String &region, G4double factor, G4double energyLimit)

void	SetLossFluctuations (G4bool val)

void	SetSpline (G4bool val)

void	SetCrossSectionType (G4CrossSectionType val)

G4CrossSectionType	CrossSectionType () const

void	SetIonisation (G4bool val)

G4bool	IsIonisationProcess () const

void	SetLinearLossLimit (G4double val)

void	SetStepFunction (G4double v1, G4double v2)

void	SetLowestEnergyLimit (G4double)

G4int	NumberOfSubCutoffRegions () const

void	SetDEDXTable (G4PhysicsTable *p, G4EmTableType tType)

void	SetCSDARangeTable (G4PhysicsTable *pRange)

void	SetRangeTableForLoss (G4PhysicsTable *p)

void	SetInverseRangeTable (G4PhysicsTable *p)

void	SetLambdaTable (G4PhysicsTable *p)

void	SetTwoPeaksXS (std::vector< G4TwoPeaksXS * > *)

void	SetEnergyOfCrossSectionMax (std::vector< G4double > *)

void	SetDEDXBinning (G4int nbins)

void	SetMinKinEnergy (G4double e)

G4double	MinKinEnergy () const

void	SetMaxKinEnergy (G4double e)

G4double	MaxKinEnergy () const

G4double	CrossSectionBiasingFactor () const

G4double	GetDEDX (G4double kineticEnergy, const G4MaterialCutsCouple *)

G4double	GetCSDADEDX (G4double kineticEnergy, const G4MaterialCutsCouple *)

G4double	GetDEDX (G4double kineticEnergy, const G4MaterialCutsCouple *, G4double logKineticEnergy)

G4double	GetRange (G4double kineticEnergy, const G4MaterialCutsCouple *)

G4double	GetRange (G4double kineticEnergy, const G4MaterialCutsCouple *, G4double logKineticEnergy)

G4double	GetCSDARange (G4double kineticEnergy, const G4MaterialCutsCouple *)

G4double	GetKineticEnergy (G4double range, const G4MaterialCutsCouple *)

G4double	GetLambda (G4double kineticEnergy, const G4MaterialCutsCouple *)

G4double	GetLambda (G4double kineticEnergy, const G4MaterialCutsCouple *, G4double logKineticEnergy)

G4bool	TablesAreBuilt () const

G4PhysicsTable *	DEDXTable () const

G4PhysicsTable *	DEDXunRestrictedTable () const

G4PhysicsTable *	IonisationTable () const

G4PhysicsTable *	CSDARangeTable () const

G4PhysicsTable *	RangeTableForLoss () const

G4PhysicsTable *	InverseRangeTable () const

G4PhysicsTable *	LambdaTable () const

std::vector< G4TwoPeaksXS * > *	TwoPeaksXS () const

std::vector< G4double > *	EnergyOfCrossSectionMax () const

G4bool	UseBaseMaterial () const

const G4Element *	GetCurrentElement () const

void	SetDynamicMassCharge (G4double massratio, G4double charge2ratio)

Public Member Functions inherited from G4VContinuousDiscreteProcess
	G4VContinuousDiscreteProcess (const G4String &, G4ProcessType aType=fNotDefined)

	G4VContinuousDiscreteProcess (G4VContinuousDiscreteProcess &)

virtual	~G4VContinuousDiscreteProcess ()

G4VContinuousDiscreteProcess &	operator= (const G4VContinuousDiscreteProcess &)=delete

virtual G4double	AtRestGetPhysicalInteractionLength (const G4Track &, G4ForceCondition *)

virtual G4VParticleChange *	AtRestDoIt (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)

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

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
virtual void	InitialiseEnergyLossProcess (const G4ParticleDefinition , const G4ParticleDefinition ) override

virtual G4double	MinPrimaryEnergy (const G4ParticleDefinition , const G4Material , G4double cut) override

virtual G4double	PostStepGetPhysicalInteractionLength (const G4Track &track, G4double previousStepSize, G4ForceCondition *condition) override

virtual G4double	GetMeanFreePath (const G4Track &track, G4double previousStepSize, G4ForceCondition *condition) override

virtual void	BuildPhysicsTable (const G4ParticleDefinition &) override

Protected Member Functions inherited from G4VEnergyLossProcess
virtual void	StreamProcessInfo (std::ostream &) const

G4double	GetMeanFreePath (const G4Track &track, G4double previousStepSize, G4ForceCondition *condition) override

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

G4PhysicsVector *	LambdaPhysicsVector (const G4MaterialCutsCouple *, G4double cut)

std::size_t	CurrentMaterialCutsCoupleIndex () const

void	SelectModel (G4double kinEnergy)

void	SetParticle (const G4ParticleDefinition *p)

void	SetSecondaryParticle (const G4ParticleDefinition *p)

Protected Member Functions inherited from G4VContinuousDiscreteProcess
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 G4VEnergyLossProcess
G4ParticleChangeForLoss	fParticleChange

const G4Material *	currentMaterial = nullptr

const G4MaterialCutsCouple *	currentCouple = nullptr

G4double	preStepLambda = 0.0

G4double	preStepKinEnergy = 0.0

G4double	preStepScaledEnergy = 0.0

G4double	mfpKinEnergy = 0.0

std::size_t	currentCoupleIndex = 0

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 52 of file G4PolarizedIonisation.hh.

Constructor & Destructor Documentation

◆ G4PolarizedIonisation() [1/2]

G4PolarizedIonisation::G4PolarizedIonisation ( const G4String & name = "pol-eIoni" )

explicit

Definition at line 50 of file G4PolarizedIonisation.cc.

  : G4VEnergyLossProcess(name)
  , fAsymmetryTable(nullptr)
  , fTransverseAsymmetryTable(nullptr)
  , fIsElectron(true)
  , fIsInitialised(false)
{
  verboseLevel = 0;
  SetProcessSubType(fIonisation);
  SetSecondaryParticle(G4Electron::Electron());
  fFlucModel = nullptr;
  fEmModel   = nullptr;
}

◆ ~G4PolarizedIonisation()

G4PolarizedIonisation::~G4PolarizedIonisation ( )

overridevirtual

Definition at line 65 of file G4PolarizedIonisation.cc.

65{ CleanTables(); }

◆ G4PolarizedIonisation() [2/2]

G4PolarizedIonisation::G4PolarizedIonisation ( const G4PolarizedIonisation & )

delete

Member Function Documentation

◆ BuildPhysicsTable()

void G4PolarizedIonisation::BuildPhysicsTable ( const G4ParticleDefinition & part )

overrideprotectedvirtual

Reimplemented from G4VProcess.

Definition at line 278 of file G4PolarizedIonisation.cc.

{
  // *** build DEDX and (unpolarized) cross section tables
  G4VEnergyLossProcess::BuildPhysicsTable(part);
  G4bool master = true;
  const G4PolarizedIonisation* masterProcess =
    static_cast<const G4PolarizedIonisation*>(GetMasterProcess());
  if(masterProcess && masterProcess != this)
  {
    master = false;
  }
  if(master)
  {
    BuildAsymmetryTables(part);
  }
}

◆ DumpInfo()

virtual void G4PolarizedIonisation::DumpInfo ( ) const

inlineoverridevirtual

Reimplemented from G4VProcess.

Definition at line 62 of file G4PolarizedIonisation.hh.

62{ ProcessDescription(G4cout); };

G4cout

G4GLOB_DLL std::ostream G4cout

G4PolarizedIonisation::ProcessDescription

virtual void ProcessDescription(std::ostream &) const override

Definition G4PolarizedIonisation.cc:68

◆ GetMeanFreePath()

G4double G4PolarizedIonisation::GetMeanFreePath	(	const G4Track &	track,
		G4double	previousStepSize,
		G4ForceCondition *	condition )

overrideprotectedvirtual

Implements G4VContinuousDiscreteProcess.

Definition at line 139 of file G4PolarizedIonisation.cc.

{
  // *** get unploarised mean free path from lambda table ***
  G4double mfp = G4VEnergyLossProcess::GetMeanFreePath(track, step, cond);
  if(fAsymmetryTable && fTransverseAsymmetryTable && mfp < DBL_MAX)
  {
    mfp *= ComputeSaturationFactor(track);
  }
  if(verboseLevel >= 2)
  {
    G4cout << "G4PolarizedIonisation::MeanFreePath:  " << mfp / mm << " mm "
           << G4endl;
  }
  return mfp;
}

◆ InitialiseEnergyLossProcess()

void G4PolarizedIonisation::InitialiseEnergyLossProcess	(	const G4ParticleDefinition *	part,
		const G4ParticleDefinition *	)

overrideprotectedvirtual

Implements G4VEnergyLossProcess.

Definition at line 111 of file G4PolarizedIonisation.cc.

{
  if(!fIsInitialised)
  {
    if(part == G4Positron::Positron())
    {
      fIsElectron = false;
    }
 
    if(!FluctModel())
    {
      SetFluctModel(new G4UniversalFluctuation());
    }
    fFlucModel = FluctModel();
 
    fEmModel = new G4PolarizedIonisationModel();
    SetEmModel(fEmModel);
    G4EmParameters* param = G4EmParameters::Instance();
    fEmModel->SetLowEnergyLimit(param->MinKinEnergy());
    fEmModel->SetHighEnergyLimit(param->MaxKinEnergy());
    AddEmModel(1, fEmModel, fFlucModel);
 
    fIsInitialised = true;
  }
}

◆ IsApplicable()

G4bool G4PolarizedIonisation::IsApplicable ( const G4ParticleDefinition & p )

overridevirtual

Reimplemented from G4VProcess.

Definition at line 106 of file G4PolarizedIonisation.cc.

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

◆ MinPrimaryEnergy()

G4double G4PolarizedIonisation::MinPrimaryEnergy	(	const G4ParticleDefinition *	,
		const G4Material *	,
		G4double	cut )

overrideprotectedvirtual

Reimplemented from G4VEnergyLossProcess.

Definition at line 93 of file G4PolarizedIonisation.cc.

{
  G4double x = cut;
  if(fIsElectron)
  {
    x += cut;
  }
  return x;
}

◆ operator=()

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

delete

◆ PostStepGetPhysicalInteractionLength()

G4double G4PolarizedIonisation::PostStepGetPhysicalInteractionLength	(	const G4Track &	track,
		G4double	previousStepSize,
		G4ForceCondition *	condition )

overrideprotectedvirtual

Reimplemented from G4VContinuousDiscreteProcess.

Definition at line 158 of file G4PolarizedIonisation.cc.

{
  // save previous values
  G4double nLength = theNumberOfInteractionLengthLeft;
  G4double iLength = currentInteractionLength;
 
  // *** get unpolarised mean free path from lambda table ***
  // this changes theNumberOfInteractionLengthLeft and currentInteractionLength
  G4double x = G4VEnergyLossProcess::PostStepGetPhysicalInteractionLength(
    track, step, cond);
  G4double x0      = x;
  G4double satFact = 1.;
 
  // *** add corrections on polarisation ***
  if(fAsymmetryTable && fTransverseAsymmetryTable && x < DBL_MAX)
  {
    satFact            = ComputeSaturationFactor(track);
    G4double curLength = currentInteractionLength * satFact;
    G4double prvLength = iLength * satFact;
    if(nLength > 0.0)
    {
      theNumberOfInteractionLengthLeft =
        std::max(nLength - step / prvLength, 0.0);
    }
    x = theNumberOfInteractionLengthLeft * curLength;
  }
  if(verboseLevel >= 2)
  {
    G4cout << "G4PolarizedIonisation::PostStepGPIL: " << std::setprecision(8)
           << x / mm << " mm;" << G4endl
           << "                   unpolarized value: " << std::setprecision(8)
           << x0 / mm << " mm." << G4endl;
  }
  return x;
}

◆ ProcessDescription()

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

overridevirtual

Reimplemented from G4VProcess.

Definition at line 68 of file G4PolarizedIonisation.cc.

{
  out << "Polarized version of G4eIonisation.\n";
 
  G4VEnergyLossProcess::ProcessDescription(out);
}

Referenced by DumpInfo().

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ G4PolarizedIonisation() [1/2]

◆ ~G4PolarizedIonisation()

◆ G4PolarizedIonisation() [2/2]

Member Function Documentation

◆ BuildPhysicsTable()

◆ DumpInfo()

◆ GetMeanFreePath()

◆ InitialiseEnergyLossProcess()

◆ IsApplicable()

◆ MinPrimaryEnergy()

◆ operator=()

◆ PostStepGetPhysicalInteractionLength()

◆ ProcessDescription()