G4PAIModel Class Reference

#include <G4PAIModel.hh>

Inheritance diagram for G4PAIModel:

Collaboration diagram for G4PAIModel:

Public Member Functions
	G4PAIModel (const G4ParticleDefinition *p=nullptr, const G4String &nam="PAI")
virtual	~G4PAIModel ()
virtual void	Initialise (const G4ParticleDefinition *, const G4DataVector &) final
virtual void	InitialiseLocal (const G4ParticleDefinition *, G4VEmModel *masterModel) final
virtual G4double	ComputeDEDXPerVolume (const G4Material *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy) final
virtual G4double	CrossSectionPerVolume (const G4Material *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy, G4double maxEnergy) final
virtual void	SampleSecondaries (std::vector< G4DynamicParticle * > *, const G4MaterialCutsCouple *, const G4DynamicParticle *, G4double tmin, G4double maxEnergy) final
virtual G4double	SampleFluctuations (const G4MaterialCutsCouple *, const G4DynamicParticle *, G4double, G4double, G4double) final
virtual G4double	Dispersion (const G4Material *, const G4DynamicParticle *, G4double, G4double) final
virtual void	DefineForRegion (const G4Region *r) final
G4PAIModelData *	GetPAIModelData ()
const std::vector< const G4MaterialCutsCouple * > &	GetVectorOfCouples ()
G4double	ComputeMaxEnergy (G4double scaledEnergy)
void	SetVerboseLevel (G4int verbose)
Public Member Functions inherited from G4VEmModel
	G4VEmModel (const G4String &nam)
virtual	~G4VEmModel ()
virtual void	InitialiseForMaterial (const G4ParticleDefinition *, const G4Material *)
virtual void	InitialiseForElement (const G4ParticleDefinition *, G4int Z)
virtual G4double	GetPartialCrossSection (const G4Material *, G4int level, const G4ParticleDefinition *, G4double kineticEnergy)
virtual G4double	ComputeCrossSectionPerAtom (const G4ParticleDefinition *, G4double kinEnergy, G4double Z, G4double A=0., G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
virtual G4double	ComputeCrossSectionPerShell (const G4ParticleDefinition *, G4int Z, G4int shellIdx, G4double kinEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
virtual G4double	ChargeSquareRatio (const G4Track &)
virtual G4double	GetChargeSquareRatio (const G4ParticleDefinition *, const G4Material *, G4double kineticEnergy)
virtual G4double	GetParticleCharge (const G4ParticleDefinition *, const G4Material *, G4double kineticEnergy)
virtual void	StartTracking (G4Track *)
virtual void	CorrectionsAlongStep (const G4MaterialCutsCouple *, const G4DynamicParticle *, G4double &eloss, G4double &niel, G4double length)
virtual G4double	Value (const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy)
virtual G4double	MinPrimaryEnergy (const G4Material *, const G4ParticleDefinition *, G4double cut=0.0)
virtual G4double	MinEnergyCut (const G4ParticleDefinition *, const G4MaterialCutsCouple *)
virtual void	SetupForMaterial (const G4ParticleDefinition *, const G4Material *, G4double kineticEnergy)
virtual void	ModelDescription (std::ostream &outFile) const
void	InitialiseElementSelectors (const G4ParticleDefinition *, const G4DataVector &)
std::vector < G4EmElementSelector * > *	GetElementSelectors ()
void	SetElementSelectors (std::vector< G4EmElementSelector * > *)
virtual G4double	ComputeDEDX (const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=DBL_MAX)
G4double	CrossSection (const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
G4double	ComputeMeanFreePath (const G4ParticleDefinition *, G4double kineticEnergy, const G4Material *, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
G4double	ComputeCrossSectionPerAtom (const G4ParticleDefinition *, const G4Element *, G4double kinEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
G4int	SelectIsotopeNumber (const G4Element *)
const G4Element *	SelectRandomAtom (const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
const G4Element *	SelectRandomAtom (const G4Material *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
G4int	SelectRandomAtomNumber (const G4Material *)
void	SetParticleChange (G4VParticleChange *, G4VEmFluctuationModel *f=nullptr)
void	SetCrossSectionTable (G4PhysicsTable *, G4bool isLocal)
G4ElementData *	GetElementData ()
G4PhysicsTable *	GetCrossSectionTable ()
G4VEmFluctuationModel *	GetModelOfFluctuations ()
G4VEmAngularDistribution *	GetAngularDistribution ()
void	SetAngularDistribution (G4VEmAngularDistribution *)
G4double	HighEnergyLimit () const
G4double	LowEnergyLimit () const
G4double	HighEnergyActivationLimit () const
G4double	LowEnergyActivationLimit () const
G4double	PolarAngleLimit () const
G4double	SecondaryThreshold () const
G4bool	LPMFlag () const
G4bool	DeexcitationFlag () const
G4bool	ForceBuildTableFlag () const
G4bool	UseAngularGeneratorFlag () const
void	SetAngularGeneratorFlag (G4bool)
void	SetHighEnergyLimit (G4double)
void	SetLowEnergyLimit (G4double)
void	SetActivationHighEnergyLimit (G4double)
void	SetActivationLowEnergyLimit (G4double)
G4bool	IsActive (G4double kinEnergy)
void	SetPolarAngleLimit (G4double)
void	SetSecondaryThreshold (G4double)
void	SetLPMFlag (G4bool val)
void	SetDeexcitationFlag (G4bool val)
void	SetForceBuildTable (G4bool val)
void	SetFluctuationFlag (G4bool val)
void	SetMasterThread (G4bool val)
G4bool	IsMaster () const
G4double	MaxSecondaryKinEnergy (const G4DynamicParticle *dynParticle)
const G4String &	GetName () const
void	SetCurrentCouple (const G4MaterialCutsCouple *)
const G4Element *	GetCurrentElement () const
const G4Isotope *	GetCurrentIsotope () const
G4bool	IsLocked () const
void	SetLocked (G4bool)
Public Member Functions inherited from G4VEmFluctuationModel
	G4VEmFluctuationModel (const G4String &nam)
virtual	~G4VEmFluctuationModel ()
virtual void	InitialiseMe (const G4ParticleDefinition *)
virtual void	SetParticleAndCharge (const G4ParticleDefinition *, G4double q2)
const G4String &	GetName () const

Protected Member Functions
virtual G4double	MaxSecondaryEnergy (const G4ParticleDefinition *, G4double kinEnergy) final
Protected Member Functions inherited from G4VEmModel
G4ParticleChangeForLoss *	GetParticleChangeForLoss ()
G4ParticleChangeForGamma *	GetParticleChangeForGamma ()
const G4MaterialCutsCouple *	CurrentCouple () const
void	SetCurrentElement (const G4Element *)

Additional Inherited Members
Protected Attributes inherited from G4VEmModel
G4ElementData *	fElementData
G4VParticleChange *	pParticleChange
G4PhysicsTable *	xSectionTable
const std::vector< G4double > *	theDensityFactor
const std::vector< G4int > *	theDensityIdx
size_t	idxTable
G4bool	lossFlucFlag
Static Protected Attributes inherited from G4VEmModel
static const G4double	inveplus = 1.0/CLHEP::eplus

Detailed Description

Definition at line 69 of file G4PAIModel.hh.

Constructor & Destructor Documentation

G4PAIModel::G4PAIModel ( const G4ParticleDefinition *  p = nullptr, const G4String &  nam = "PAI"  )

explicit

Definition at line 77 of file G4PAIModel.cc.

  : G4VEmModel(nam),G4VEmFluctuationModel(nam),
    fVerbose(0),
    fModelData(nullptr),
    fParticle(nullptr)
{  
  fElectron = G4Electron::Electron();
  fPositron = G4Positron::Positron();

  fParticleChange = nullptr;

  if(p) { SetParticle(p); }
  else  { SetParticle(fElectron); }

  // default generator
  SetAngularDistribution(new G4DeltaAngle());
}

Here is the call graph for this function:

G4PAIModel::~G4PAIModel ( )

virtual

Definition at line 97 of file G4PAIModel.cc.

{
  if(IsMaster()) { delete fModelData; }
}

Here is the call graph for this function:

Member Function Documentation

G4double G4PAIModel::ComputeDEDXPerVolume ( const G4Material *  , const G4ParticleDefinition *  p, G4double  kineticEnergy, G4double  cutEnergy  )

finalvirtual

Reimplemented from G4VEmModel.

Definition at line 204 of file G4PAIModel.cc.

{  
  //G4cout << "===1=== " << CurrentCouple() 
  //     << "  idx= " << CurrentCouple()->GetIndex()
  //     << "   " <<  fMaterialCutsCoupleVector[0]
  //     << G4endl; 
  G4int coupleIndex = FindCoupleIndex(CurrentCouple());
  //G4cout << "===2=== " << coupleIndex << G4endl;
  if(0 > coupleIndex) { return 0.0; }

  G4double cut = std::min(MaxSecondaryEnergy(p, kineticEnergy), cutEnergy);

  G4double scaledTkin = kineticEnergy*fRatio;
 
  return fChargeSquare*fModelData->DEDXPerVolume(coupleIndex, scaledTkin, 
                         cut);
}

Here is the call graph for this function:

G4double G4PAIModel::ComputeMaxEnergy ( G4double  scaledEnergy )

inline

Definition at line 166 of file G4PAIModel.hh.

{
  return MaxSecondaryEnergy(fParticle, scaledEnergy/fRatio);
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4PAIModel::CrossSectionPerVolume ( const G4Material *  , const G4ParticleDefinition *  p, G4double  kineticEnergy, G4double  cutEnergy, G4double  maxEnergy  )

finalvirtual

Reimplemented from G4VEmModel.

Definition at line 227 of file G4PAIModel.cc.

{
  //G4cout << "===3=== " << CurrentCouple() 
  //     << "  idx= " << CurrentCouple()->GetIndex()
  //     << "   " <<  fMaterialCutsCoupleVector[0]
  //     << G4endl; 
  G4int coupleIndex = FindCoupleIndex(CurrentCouple());
  //G4cout << "===4=== " << coupleIndex << G4endl;
  if(0 > coupleIndex) { return 0.0; }

  G4double tmax = std::min(MaxSecondaryEnergy(p, kineticEnergy), maxEnergy);
  if(tmax <= cutEnergy) { return 0.0; }

  G4double scaledTkin = kineticEnergy*fRatio;

  return fChargeSquare*fModelData->CrossSectionPerVolume(coupleIndex, 
                             scaledTkin, 
                             cutEnergy, 
                             tmax);
}

Here is the call graph for this function:

void G4PAIModel::DefineForRegion ( const G4Region *  r )

finalvirtual

Reimplemented from G4VEmModel.

Definition at line 386 of file G4PAIModel.cc.

{
  fPAIRegionVector.push_back(r);
}

G4double G4PAIModel::Dispersion ( const G4Material *  material, const G4DynamicParticle *  aParticle, G4double  tmax, G4double  step  )

finalvirtual

Implements G4VEmFluctuationModel.

Definition at line 350 of file G4PAIModel.cc.

{
  G4double particleMass  = aParticle->GetMass();
  G4double electronDensity = material->GetElectronDensity();
  G4double kineticEnergy = aParticle->GetKineticEnergy();
  G4double q = aParticle->GetCharge()/eplus;
  G4double etot = kineticEnergy + particleMass;
  G4double beta2 = kineticEnergy*(kineticEnergy + 2.0*particleMass)/(etot*etot);
  G4double siga  = (1.0/beta2 - 0.5) * twopi_mc2_rcl2 * tmax * step
                 * electronDensity * q * q;

  return siga;
}

Here is the call graph for this function:

G4PAIModelData * G4PAIModel::GetPAIModelData ( )

inline

Definition at line 155 of file G4PAIModel.hh.

{
  return fModelData;
}

Here is the caller graph for this function:

const std::vector< const G4MaterialCutsCouple * > & G4PAIModel::GetVectorOfCouples ( )

inline

Definition at line 161 of file G4PAIModel.hh.

{
  return fMaterialCutsCoupleVector;
}

Here is the caller graph for this function:

void G4PAIModel::Initialise ( const G4ParticleDefinition *  p, const G4DataVector &  cuts  )

finalvirtual

Implements G4VEmModel.

Definition at line 104 of file G4PAIModel.cc.

{
  if(fVerbose > 0) {
    G4cout<<"G4PAIModel::Initialise for "<<p->GetParticleName()<<G4endl;
  }
  SetParticle(p);
  fParticleChange = GetParticleChangeForLoss();

  if(IsMaster()) { 

    delete fModelData;      
    fMaterialCutsCoupleVector.clear(); 
    if(fVerbose > 0) {
      G4cout << "G4PAIModel instantiates data for  " << p->GetParticleName()
         << G4endl;
    }  
    G4double tmin = LowEnergyLimit()*fRatio;
    G4double tmax = HighEnergyLimit()*fRatio;
    fModelData = new G4PAIModelData(tmin, tmax, fVerbose);
  
    // Prepare initialization
    const G4MaterialTable* theMaterialTable = G4Material::GetMaterialTable();
    size_t numOfMat   = G4Material::GetNumberOfMaterials();
    size_t numRegions = fPAIRegionVector.size();

    // protect for unit tests
    if(0 == numRegions) {
      G4Exception("G4PAIModel::Initialise()","em0106",JustWarning,
                  "no G4Regions are registered for the PAI model - World is used");
      fPAIRegionVector.push_back(G4RegionStore::GetInstance()
                 ->GetRegion("DefaultRegionForTheWorld", false));
      numRegions = 1;
    }

    if(fVerbose > 0) {
      G4cout << "G4PAIModel is defined for " << numRegions << " regions "   
         << G4endl;
      G4cout << "           total number of materials " << numOfMat << G4endl;
    } 
    for(size_t iReg = 0; iReg<numRegions; ++iReg) {
      const G4Region* curReg = fPAIRegionVector[iReg];
      G4Region* reg = const_cast<G4Region*>(curReg);

      for(size_t jMat = 0; jMat<numOfMat; ++jMat) {
    G4Material* mat = (*theMaterialTable)[jMat];
    const G4MaterialCutsCouple* cutCouple = reg->FindCouple(mat);
    size_t n = fMaterialCutsCoupleVector.size();
    /*
    G4cout << "Region: " << reg->GetName() << "  " << reg
           << " Couple " << cutCouple 
           << " PAI defined for " << n << " couples"
           << " jMat= " << jMat << "  " << mat->GetName()
           << G4endl;
    */
    if(cutCouple) {
      if(fVerbose > 0) {
        G4cout << "Region <" << curReg->GetName() << ">  mat <" 
           << mat->GetName() << ">  CoupleIndex= " 
           << cutCouple->GetIndex()
           << "  " << p->GetParticleName()
           << " cutsize= " << cuts.size() << G4endl;
      }
      // check if this couple is not already initialized
      G4bool isnew = true;
      if(0 < n) {
        for(size_t i=0; i<n; ++i) {
          if(cutCouple == fMaterialCutsCoupleVector[i]) {
        isnew = false;
        break;
          }
        }
      }
      // initialise data banks
      //G4cout << "   isNew: " << isnew << "  " << cutCouple << G4endl;
      if(isnew) { 
        fMaterialCutsCoupleVector.push_back(cutCouple); 
        fModelData->Initialise(cutCouple, this);
      }
    }
      }
    }
    InitialiseElementSelectors(p, cuts);
  }
}

Here is the call graph for this function:

void G4PAIModel::InitialiseLocal ( const G4ParticleDefinition *  p, G4VEmModel *  masterModel  )

finalvirtual

Reimplemented from G4VEmModel.

Definition at line 192 of file G4PAIModel.cc.

{
  SetParticle(p);
  fModelData = static_cast<G4PAIModel*>(masterModel)->GetPAIModelData();
  fMaterialCutsCoupleVector = 
    static_cast<G4PAIModel*>(masterModel)->GetVectorOfCouples();
  SetElementSelectors(masterModel->GetElementSelectors());
}

Here is the call graph for this function:

G4double G4PAIModel::MaxSecondaryEnergy ( const G4ParticleDefinition *  p, G4double  kinEnergy  )

finalprotectedvirtual

Reimplemented from G4VEmModel.

Definition at line 369 of file G4PAIModel.cc.

{
  SetParticle(p);
  G4double tmax = kinEnergy;
  if(p == fElectron) { tmax *= 0.5; }
  else if(p != fPositron) { 
    G4double ratio= electron_mass_c2/fMass;
    G4double gamma= kinEnergy/fMass + 1.0;
    tmax = 2.0*electron_mass_c2*(gamma*gamma - 1.) /
                  (1. + 2.0*gamma*ratio + ratio*ratio);
  }
  return tmax;
}

Here is the caller graph for this function:

G4double G4PAIModel::SampleFluctuations ( const G4MaterialCutsCouple *  matCC, const G4DynamicParticle *  aParticle, G4double  tmax, G4double  step, G4double  eloss  )

finalvirtual

Implements G4VEmFluctuationModel.

Definition at line 315 of file G4PAIModel.cc.

{
  G4int coupleIndex = FindCoupleIndex(matCC);
  if(0 > coupleIndex) { return eloss; }

  SetParticle(aParticle->GetDefinition());

  /*
  G4cout << "G4PAIModel::SampleFluctuations step(mm)= "<< step/mm
     << "  Eloss(keV)= " << eloss/keV  << " in " 
     << matCC->Getmaterial()->GetName() << G4endl;
  */

  G4double Tkin       = aParticle->GetKineticEnergy();
  G4double scaledTkin = Tkin*fRatio;

  G4double loss = fModelData->SampleAlongStepTransfer(coupleIndex, Tkin,
                              scaledTkin, tmax,
                              step*fChargeSquare);
  
  // G4cout<<"PAIModel AlongStepLoss = "<<loss/keV<<" keV, on step = "
  //<<step/mm<<" mm"<<G4endl; 
  return loss;

}

Here is the call graph for this function:

void G4PAIModel::SampleSecondaries ( std::vector< G4DynamicParticle * > *  vdp, const G4MaterialCutsCouple *  matCC, const G4DynamicParticle *  dp, G4double  tmin, G4double  maxEnergy  )

finalvirtual

Implements G4VEmModel.

Definition at line 257 of file G4PAIModel.cc.

{
  G4int coupleIndex = FindCoupleIndex(matCC);

  //G4cout << "G4PAIModel::SampleSecondaries: coupleIndex= "<<coupleIndex<<G4endl;
  if(0 > coupleIndex) { return; }

  SetParticle(dp->GetDefinition());
  G4double kineticEnergy = dp->GetKineticEnergy();

  G4double tmax = MaxSecondaryEnergy(fParticle, kineticEnergy);
  if(maxEnergy < tmax) { tmax = maxEnergy; }
  if(tmin >= tmax) { return; }

  G4ThreeVector direction= dp->GetMomentumDirection();
  G4double scaledTkin    = kineticEnergy*fRatio;
  G4double totalEnergy   = kineticEnergy + fMass;
  G4double totalMomentum = sqrt(kineticEnergy*(totalEnergy+fMass));

  G4double deltaTkin = 
    fModelData->SamplePostStepTransfer(coupleIndex, scaledTkin, tmin, tmax);

  //G4cout<<"G4PAIModel::SampleSecondaries; deltaKIn = "<<deltaTkin/keV
  //    <<" keV "<< " Escaled(MeV)= " << scaledTkin << G4endl;

  if( !(deltaTkin <= 0.) && !(deltaTkin > 0)) {
    G4cout<<"G4PAIModel::SampleSecondaries; deltaKIn = "<<deltaTkin/keV
      <<" keV "<< " Escaled(MeV)= " << scaledTkin << G4endl;
    return;
  }
  if( deltaTkin <= 0.) { return; }

  if( deltaTkin > tmax) { deltaTkin = tmax; }

  const G4Element* anElement = SelectRandomAtom(matCC,fParticle,kineticEnergy);
  G4int Z = G4lrint(anElement->GetZ());
 
  G4DynamicParticle* deltaRay = new G4DynamicParticle(fElectron, 
        GetAngularDistribution()->SampleDirection(dp, deltaTkin,
                              Z, matCC->GetMaterial()),
                              deltaTkin);

  // primary change
  kineticEnergy -= deltaTkin;
  G4ThreeVector dir = totalMomentum*direction - deltaRay->GetMomentum();
  direction = dir.unit();
  fParticleChange->SetProposedKineticEnergy(kineticEnergy);
  fParticleChange->SetProposedMomentumDirection(direction);

  vdp->push_back(deltaRay);
}

Here is the call graph for this function:

void G4PAIModel::SetVerboseLevel ( G4int  verbose )

inline

Definition at line 171 of file G4PAIModel.hh.

{ 
  fVerbose=verbose; 
}

---

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

• source/geant4.10.03.p03/source/processes/electromagnetic/standard/include/G4PAIModel.hh
• source/geant4.10.03.p03/source/processes/electromagnetic/standard/src/G4PAIModel.cc