#include <G4PolarizedCompton.hh>

Inheritance diagram for G4PolarizedCompton:

Collaboration diagram for G4PolarizedCompton:

Public Member Functions
	G4PolarizedCompton (const G4String &processName="pol-compt", G4ProcessType type=fElectromagnetic)

virtual	~G4PolarizedCompton ()

virtual G4bool	IsApplicable (const G4ParticleDefinition &)

virtual void	PrintInfo ()

void	SetModel (const G4String &name)

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

virtual	~G4VEmProcess ()

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

virtual void	PreparePhysicsTable (const G4ParticleDefinition &)

virtual void	StartTracking (G4Track *)

virtual G4VParticleChange *	PostStepDoIt (const G4Track &, const G4Step &)

virtual G4bool	StorePhysicsTable (const G4ParticleDefinition *, const G4String &directory, G4bool ascii=false)

virtual G4bool	RetrievePhysicsTable (const G4ParticleDefinition *, const G4String &directory, G4bool ascii)

G4double	CrossSectionPerVolume (G4double kineticEnergy, const G4MaterialCutsCouple *couple)

G4double	ComputeCrossSectionPerAtom (G4double kineticEnergy, G4double Z, G4double A=0., G4double cut=0.0)

G4double	MeanFreePath (const G4Track &track)

G4double	GetLambda (G4double &kinEnergy, const G4MaterialCutsCouple *couple)

void	SetLambdaBinning (G4int nbins)

void	SetMinKinEnergy (G4double e)

void	SetMinKinEnergyPrim (G4double e)

void	SetMaxKinEnergy (G4double e)

G4PhysicsTable *	LambdaTable () const

G4PhysicsTable *	LambdaTablePrim () const

const G4ParticleDefinition *	Particle () const

const G4ParticleDefinition *	SecondaryParticle () const

G4VEmModel *	SelectModelForMaterial (G4double kinEnergy, size_t &idxRegion) const

void	AddEmModel (G4int, G4VEmModel , const G4Region region=0)

G4VEmModel *	EmModel (G4int index=1) const

void	SetEmModel (G4VEmModel *, G4int index=1)

void	UpdateEmModel (const G4String &, G4double, G4double)

G4VEmModel *	GetModelByIndex (G4int idx=0, G4bool ver=false) const

const G4Element *	GetCurrentElement () const

const G4VEmModel *	GetCurrentModel () 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	SetIntegral (G4bool val)

void	SetBuildTableFlag (G4bool val)

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

	G4VDiscreteProcess (G4VDiscreteProcess &)

virtual	~G4VDiscreteProcess ()

virtual G4double	AlongStepGetPhysicalInteractionLength (const G4Track &, G4double, G4double, G4double &, G4GPILSelection *)

virtual G4double	AtRestGetPhysicalInteractionLength (const G4Track &, G4ForceCondition *)

virtual G4VParticleChange *	AtRestDoIt (const G4Track &, const G4Step &)

virtual G4VParticleChange *	AlongStepDoIt (const G4Track &, const G4Step &)

Public Member Functions inherited from G4VProcess
	G4VProcess (const G4String &aName="NoName", G4ProcessType aType=fNotDefined)

	G4VProcess (const G4VProcess &right)

virtual	~G4VProcess ()

G4int	operator== (const G4VProcess &right) const

G4int	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 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
virtual void	InitialiseProcess (const G4ParticleDefinition *)

virtual void	BuildPhysicsTable (const G4ParticleDefinition &)

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

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

Protected Member Functions inherited from G4VEmProcess
virtual G4double	MinPrimaryEnergy (const G4ParticleDefinition , const G4Material )

G4VEmModel *	SelectModel (G4double &kinEnergy, size_t index)

G4PhysicsVector *	LambdaPhysicsVector (const G4MaterialCutsCouple *)

G4int	LambdaBinning () const

G4double	MinKinEnergy () const

G4double	MaxKinEnergy () const

G4double	PolarAngleLimit () const

G4bool	IsIntegral () const

G4double	RecalculateLambda (G4double kinEnergy, const G4MaterialCutsCouple *couple)

G4ParticleChangeForGamma *	GetParticleChange ()

void	SetParticle (const G4ParticleDefinition *p)

void	SetSecondaryParticle (const G4ParticleDefinition *p)

size_t	CurrentMaterialCutsCoupleIndex () const

G4double	GetGammaEnergyCut ()

G4double	GetElectronEnergyCut ()

void	SetStartFromNullFlag (G4bool val)

void	SetSplineFlag (G4bool val)

const G4Element *	GetTargetElement () const

const G4Isotope *	GetTargetIsotope () const

Protected Member Functions inherited from G4VProcess
void	SubtractNumberOfInteractionLengthLeft (G4double previousStepSize)

void	ClearNumberOfInteractionLengthLeft ()

Private Member Functions
void	CleanTable ()

void	BuildAsymmetryTable (const G4ParticleDefinition &part)

G4double	ComputeAsymmetry (G4double energy, const G4MaterialCutsCouple *couple, const G4ParticleDefinition &particle, G4double cut, G4double &tAsymmetry)

G4double	ComputeSaturationFactor (const G4Track &aTrack)

G4PolarizedCompton &	operator= (const G4PolarizedCompton &right)

	G4PolarizedCompton (const G4PolarizedCompton &)

Private Attributes
G4bool	buildAsymmetryTable

G4bool	useAsymmetryTable

G4bool	isInitialised

G4int	mType

G4PolarizedComptonModel *	emModel

G4ThreeVector	targetPolarization

Static Private Attributes
static G4PhysicsTable *	theAsymmetryTable = nullptr

Additional Inherited Members
Static Public Member Functions inherited from G4VProcess
static const G4String &	GetProcessTypeName (G4ProcessType)

Protected Attributes inherited from G4VEmProcess
G4ParticleChangeForGamma	fParticleChange

Protected Attributes inherited from G4VProcess
const G4ProcessManager *	aProcessManager

G4VParticleChange *	pParticleChange

G4ParticleChange	aParticleChange

G4double	theNumberOfInteractionLengthLeft

G4double	currentInteractionLength

G4double	theInitialNumberOfInteractionLength

G4String	theProcessName

G4String	thePhysicsTableFileName

G4ProcessType	theProcessType

G4int	theProcessSubType

G4double	thePILfactor

G4bool	enableAtRestDoIt

G4bool	enableAlongStepDoIt

G4bool	enablePostStepDoIt

G4int	verboseLevel

Detailed Description

Definition at line 72 of file G4PolarizedCompton.hh.

Constructor & Destructor Documentation

◆ G4PolarizedCompton() [1/2]

G4PolarizedCompton::G4PolarizedCompton	(	const G4String &	processName = `"pol-compt"`,
		G4ProcessType	type = `fElectromagnetic`
	)

Definition at line 73 of file G4PolarizedCompton.cc.

                      :
   G4VEmProcess (processName, type),
   buildAsymmetryTable(true),
   useAsymmetryTable(true),
   isInitialised(false),
   mType(10),
   targetPolarization(0.0,0.0,0.0)
 {
   SetStartFromNullFlag(true);
   SetBuildTableFlag(true);
   SetSecondaryParticle(G4Electron::Electron());
   SetProcessSubType(fComptonScattering);
   SetMinKinEnergyPrim(1*MeV);
   SetSplineFlag(true);
   emModel = nullptr;
 }

Here is the call graph for this function:

◆ ~G4PolarizedCompton()

G4PolarizedCompton::~G4PolarizedCompton ( )

virtual

Definition at line 93 of file G4PolarizedCompton.cc.

 {
   CleanTable();
 }

Here is the call graph for this function:

◆ G4PolarizedCompton() [2/2]

G4PolarizedCompton::G4PolarizedCompton ( const G4PolarizedCompton & )

private

Member Function Documentation

◆ BuildAsymmetryTable()

void G4PolarizedCompton::BuildAsymmetryTable ( const G4ParticleDefinition & part )

private

Definition at line 285 of file G4PolarizedCompton.cc.

 {
   // cleanup old, initialise new table
   CleanTable();
   theAsymmetryTable = 
     G4PhysicsTableHelper::PreparePhysicsTable(theAsymmetryTable);
 
   // Access to materials
   const G4ProductionCutsTable* theCoupleTable=
         G4ProductionCutsTable::GetProductionCutsTable();
   size_t numOfCouples = theCoupleTable->GetTableSize();
   if(!theAsymmetryTable) { return; }
   G4int nbins = LambdaBinning();
   G4double emin = MinKinEnergy();
   G4double emax = MaxKinEnergy();
   G4PhysicsLogVector* aVector = 0;
   G4PhysicsLogVector* bVector = 0;
 
   for(size_t i=0; i<numOfCouples; ++i) {
     if (theAsymmetryTable->GetFlag(i)) {
 
       // create physics vector and fill it
       const G4MaterialCutsCouple* couple = theCoupleTable->GetMaterialCutsCouple(i);
       // use same parameters as for lambda
       if(!aVector) { 
     aVector = new G4PhysicsLogVector(emin, emax, nbins); 
         aVector->SetSpline(true);
         bVector = aVector;
       } else {
     bVector = new G4PhysicsLogVector(*aVector);
       }
 
       for (G4int j = 0; j <= nbins; ++j ) {
     G4double energy = bVector->Energy(j);
     G4double tasm=0.;
     G4double asym = ComputeAsymmetry(energy, couple, part, 0., tasm);
     bVector->PutValue(j,asym);
       }
       G4PhysicsTableHelper::SetPhysicsVector(theAsymmetryTable, i, bVector);
     }
   }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BuildPhysicsTable()

void G4PolarizedCompton::BuildPhysicsTable ( const G4ParticleDefinition & part )

protectedvirtual

Reimplemented from G4VEmProcess.

Definition at line 270 of file G4PolarizedCompton.cc.

 {
   // *** build (unpolarized) cross section tables (Lambda)
   G4VEmProcess::BuildPhysicsTable(part);
   if(buildAsymmetryTable && emModel) { 
     G4bool isMaster = true;
     const G4PolarizedCompton* masterProcess = 
       static_cast<const G4PolarizedCompton*>(GetMasterProcess());
     if(masterProcess && masterProcess != this) { isMaster = false; }
     if(isMaster) { BuildAsymmetryTable(part); }
   }
 }

Here is the call graph for this function:

◆ CleanTable()

void G4PolarizedCompton::CleanTable ( )

private

Definition at line 100 of file G4PolarizedCompton.cc.

 {
   if( theAsymmetryTable) {
     theAsymmetryTable->clearAndDestroy();
     delete theAsymmetryTable;
     theAsymmetryTable = nullptr;
   }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ComputeAsymmetry()

G4double G4PolarizedCompton::ComputeAsymmetry	(	G4double	energy,
		const G4MaterialCutsCouple *	couple,
		const G4ParticleDefinition &	particle,
		G4double	cut,
		G4double &	tAsymmetry
	)

private

Definition at line 330 of file G4PolarizedCompton.cc.

 {
   G4double lAsymmetry = 0.0;
   tAsymmetry=0;
 
   //
   // calculate polarized cross section
   //
   G4ThreeVector thePolarization=G4ThreeVector(0.,0.,1.);
   emModel->SetTargetPolarization(thePolarization);
   emModel->SetBeamPolarization(thePolarization);
   G4double sigma2=emModel->CrossSection(couple,&aParticle,energy,cut,energy);
 
   //
   // calculate unpolarized cross section
   //
   thePolarization=G4ThreeVector();
   emModel->SetTargetPolarization(thePolarization);
   emModel->SetBeamPolarization(thePolarization);
   G4double sigma0=emModel->CrossSection(couple,&aParticle,energy,cut,energy);
 
   // determine assymmetries
   if (sigma0 > 0.) {
     lAsymmetry = sigma2/sigma0-1.;
   }
   return lAsymmetry;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ComputeSaturationFactor()

G4double G4PolarizedCompton::ComputeSaturationFactor ( const G4Track & aTrack )

private

Definition at line 204 of file G4PolarizedCompton.cc.

 {
   G4double factor = 1.0;
 
   // *** get asymmetry, if target is polarized ***
   const G4DynamicParticle* aDynamicGamma = aTrack.GetDynamicParticle();
   const G4double GammaEnergy = aDynamicGamma->GetKineticEnergy();
   const G4StokesVector GammaPolarization = aTrack.GetPolarization();
   const G4ParticleMomentum GammaDirection0 = aDynamicGamma->GetMomentumDirection();
 
   G4Material*         aMaterial = aTrack.GetMaterial();
   G4VPhysicalVolume*  aPVolume  = aTrack.GetVolume();
   G4LogicalVolume*    aLVolume  = aPVolume->GetLogicalVolume();
 
   //   G4Material* bMaterial = aLVolume->GetMaterial();
   G4PolarizationManager * polarizationManger = G4PolarizationManager::GetInstance();
 
   const G4bool VolumeIsPolarized = polarizationManger->IsPolarized(aLVolume);
   G4StokesVector ElectronPolarization = polarizationManger->GetVolumePolarization(aLVolume);
 
   if (VolumeIsPolarized) {
      
     if (verboseLevel>=2) {
       G4cout << "G4PolarizedCompton::ComputeSaturationFactor: " << G4endl;
       G4cout << " Mom " << GammaDirection0  << G4endl;
       G4cout << " Polarization " << GammaPolarization  << G4endl;
       G4cout << " MaterialPol. " << ElectronPolarization  << G4endl;
       G4cout << " Phys. Volume " << aPVolume->GetName() << G4endl;
       G4cout << " Log. Volume  " << aLVolume->GetName() << G4endl;
       G4cout << " Material     " << aMaterial          << G4endl;
     }
 
     size_t midx = CurrentMaterialCutsCoupleIndex();
     const G4PhysicsVector* aVector = nullptr;
     if(midx < theAsymmetryTable->size()) { 
       aVector = (*theAsymmetryTable)(midx);
     }
     if (aVector) {
       G4double asymmetry = aVector->Value(GammaEnergy);
 
       //  we have to determine angle between particle motion 
       //  and target polarisation here  
       //      circ pol * Vec(ElectronPol)*Vec(PhotonMomentum)
       //  both vectors in global reference frame
      
       G4double pol = ElectronPolarization*GammaDirection0;     
       G4double polProduct = GammaPolarization.p3() * pol;
       factor /= (1. + polProduct * asymmetry);
       if (verboseLevel>=2) {
     G4cout << " Asymmetry:     " << asymmetry      << G4endl;
     G4cout << " PolProduct:    " << polProduct     << G4endl;
     G4cout << " Factor:        " << factor         << G4endl;
       }   
     } else {
       G4ExceptionDescription ed;
       ed << "Problem with asymmetry table: material index " << midx 
      << " is out of range or the table is not filled";
       G4Exception("G4PolarizedComptonModel::ComputeSaturationFactor","em0048",
           JustWarning, ed, "");
     }
   }
   return factor;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMeanFreePath()

G4double G4PolarizedCompton::GetMeanFreePath	(	const G4Track &	aTrack,
		G4double	previousStepSize,
		G4ForceCondition *	condition
	)

protectedvirtual

Reimplemented from G4VEmProcess.

Definition at line 155 of file G4PolarizedCompton.cc.

 {
   // *** get unploarised mean free path from lambda table ***
   G4double mfp = G4VEmProcess::GetMeanFreePath(aTrack, previousStepSize, condition);
 
   if (theAsymmetryTable && useAsymmetryTable && mfp < DBL_MAX) {
     mfp *= ComputeSaturationFactor(aTrack);
   }
   if (verboseLevel>=2) {
     G4cout << "G4PolarizedCompton::MeanFreePath:  " << mfp / mm << " mm " << G4endl;
   }
   return mfp;
 }

Here is the call graph for this function:

◆ InitialiseProcess()

void G4PolarizedCompton::InitialiseProcess ( const G4ParticleDefinition * )

protectedvirtual

Implements G4VEmProcess.

Definition at line 118 of file G4PolarizedCompton.cc.

 {
   if(!isInitialised) {
     isInitialised = true;
     if(0 == mType) {
       if(!EmModel(1)) { SetEmModel(new G4KleinNishinaCompton(), 1); }
     } else {
       emModel = new G4PolarizedComptonModel();
       SetEmModel(emModel, 1); 
     }
     G4EmParameters* param = G4EmParameters::Instance();
     EmModel(1)->SetLowEnergyLimit(param->MinKinEnergy());
     EmModel(1)->SetHighEnergyLimit(param->MaxKinEnergy());
     AddEmModel(1, EmModel(1));
   } 
 }

Here is the call graph for this function:

◆ IsApplicable()

G4bool G4PolarizedCompton::IsApplicable ( const G4ParticleDefinition & p )

virtual

Implements G4VEmProcess.

Definition at line 111 of file G4PolarizedCompton.cc.

 {
   return (&p == G4Gamma::Gamma());
 }

Here is the call graph for this function:

◆ operator=()

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

private

◆ PostStepGetPhysicalInteractionLength()

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

protectedvirtual

Reimplemented from G4VEmProcess.

Definition at line 173 of file G4PolarizedCompton.cc.

 {
   // save previous value
   G4double nLength = theNumberOfInteractionLengthLeft;
 
   // *** compute uppolarized step limit ***
   G4double x = G4VEmProcess::PostStepGetPhysicalInteractionLength(aTrack, 
                                   previousStepSize, 
                                   condition);
 
   // *** add corrections on polarisation ***
   if (theAsymmetryTable && useAsymmetryTable && x < DBL_MAX) {
     G4double curLength = currentInteractionLength*ComputeSaturationFactor(aTrack);
     if(nLength > 0.0) {
       theNumberOfInteractionLengthLeft = 
     std::max(nLength - previousStepSize/curLength, 0.0);
     }
     x = theNumberOfInteractionLengthLeft * curLength;
   }
   if (verboseLevel>=2) {
     G4cout << "G4PolarizedCompton::PostStepGetPhysicalInteractionLength:  " 
        << x/mm << " mm " << G4endl;
   }
   return x;
 }

Here is the call graph for this function:

◆ PrintInfo()

void G4PolarizedCompton::PrintInfo ( )

virtual

Implements G4VEmProcess.

Definition at line 137 of file G4PolarizedCompton.cc.

 {
   G4cout << " Total cross sections has a good parametrisation"
          << " from 10 KeV to (100/Z) GeV" 
          << "\n      Sampling according " <<  EmModel(1)->GetName() << " model" 
      << G4endl;
 }         

Here is the call graph for this function:

◆ SetModel()

void G4PolarizedCompton::SetModel ( const G4String & name )

Definition at line 147 of file G4PolarizedCompton.cc.

 {
   if(ss == "Klein-Nishina")     { mType = 0; }
   if(ss == "Polarized-Compton") { mType = 10; }
 }

Member Data Documentation

◆ buildAsymmetryTable

G4bool G4PolarizedCompton::buildAsymmetryTable

private

Definition at line 123 of file G4PolarizedCompton.hh.

◆ emModel

G4PolarizedComptonModel* G4PolarizedCompton::emModel

private

Definition at line 130 of file G4PolarizedCompton.hh.

◆ isInitialised

G4bool G4PolarizedCompton::isInitialised

private

Definition at line 126 of file G4PolarizedCompton.hh.

◆ mType

G4int G4PolarizedCompton::mType

private

Definition at line 127 of file G4PolarizedCompton.hh.

◆ targetPolarization

G4ThreeVector G4PolarizedCompton::targetPolarization

private

Definition at line 132 of file G4PolarizedCompton.hh.

◆ theAsymmetryTable

G4PhysicsTable * G4PolarizedCompton::theAsymmetryTable = nullptr

staticprivate

Definition at line 131 of file G4PolarizedCompton.hh.

◆ useAsymmetryTable

G4bool G4PolarizedCompton::useAsymmetryTable

private

Definition at line 124 of file G4PolarizedCompton.hh.

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ G4PolarizedCompton() [1/2]

◆ ~G4PolarizedCompton()

◆ G4PolarizedCompton() [2/2]

Member Function Documentation

◆ BuildAsymmetryTable()

◆ BuildPhysicsTable()

◆ CleanTable()

◆ ComputeAsymmetry()

◆ ComputeSaturationFactor()

◆ GetMeanFreePath()

◆ InitialiseProcess()

◆ IsApplicable()

◆ operator=()

◆ PostStepGetPhysicalInteractionLength()

◆ PrintInfo()

◆ SetModel()

Member Data Documentation

◆ buildAsymmetryTable

◆ emModel

◆ isInitialised

◆ mType

◆ targetPolarization

◆ theAsymmetryTable

◆ useAsymmetryTable