#include <G4VMscModel.hh>

Inheritance diagram for G4VMscModel:

Collaboration diagram for G4VMscModel:

Public Member Functions
	G4VMscModel (const G4String &nam)

virtual	~G4VMscModel ()

virtual G4double	ComputeTruePathLengthLimit (const G4Track &track, G4double &stepLimit)

virtual G4double	ComputeGeomPathLength (G4double truePathLength)

virtual G4double	ComputeTrueStepLength (G4double geomPathLength)

virtual G4ThreeVector &	SampleScattering (const G4ThreeVector &, G4double safety)

virtual void	SampleSecondaries (std::vector< G4DynamicParticle * > , const G4MaterialCutsCouple , const G4DynamicParticle *, G4double tmin, G4double tmax) override

void	SetStepLimitType (G4MscStepLimitType)

void	SetLateralDisplasmentFlag (G4bool val)

void	SetRangeFactor (G4double)

void	SetGeomFactor (G4double)

void	SetSkin (G4double)

void	SetSampleZ (G4bool)

G4VEnergyLossProcess *	GetIonisation () const

void	SetIonisation (G4VEnergyLossProcess , const G4ParticleDefinition part)

G4double	ComputeSafety (const G4ThreeVector &position, G4double limit=DBL_MAX)

G4double	ComputeGeomLimit (const G4Track &, G4double &presafety, G4double limit)

G4double	GetDEDX (const G4ParticleDefinition part, G4double kineticEnergy, const G4MaterialCutsCouple couple)

G4double	GetRange (const G4ParticleDefinition part, G4double kineticEnergy, const G4MaterialCutsCouple couple)

G4double	GetEnergy (const G4ParticleDefinition part, G4double range, const G4MaterialCutsCouple couple)

G4double	GetTransportMeanFreePath (const G4ParticleDefinition *part, G4double kinEnergy)

Public Member Functions inherited from G4VEmModel
	G4VEmModel (const G4String &nam)

virtual	~G4VEmModel ()

virtual void	Initialise (const G4ParticleDefinition *, const G4DataVector &)=0

virtual void	InitialiseLocal (const G4ParticleDefinition , G4VEmModel masterModel)

virtual void	InitialiseForMaterial (const G4ParticleDefinition , const G4Material )

virtual void	InitialiseForElement (const G4ParticleDefinition *, G4int Z)

virtual G4double	ComputeDEDXPerVolume (const G4Material , const G4ParticleDefinition , G4double kineticEnergy, G4double cutEnergy=DBL_MAX)

virtual G4double	CrossSectionPerVolume (const G4Material , const G4ParticleDefinition , G4double kineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)

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	DefineForRegion (const G4Region *)

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)

Protected Member Functions
G4ParticleChangeForMSC *	GetParticleChangeForMSC (const G4ParticleDefinition *p=nullptr)

G4double	ConvertTrueToGeom (G4double &tLength, G4double &gLength)

Protected Member Functions inherited from G4VEmModel
G4ParticleChangeForLoss *	GetParticleChangeForLoss ()

G4ParticleChangeForGamma *	GetParticleChangeForGamma ()

virtual G4double	MaxSecondaryEnergy (const G4ParticleDefinition *, G4double kineticEnergy)

const G4MaterialCutsCouple *	CurrentCouple () const

void	SetCurrentElement (const G4Element *)

Protected Attributes
G4double	facrange

G4double	facgeom

G4double	facsafety

G4double	skin

G4double	dtrl

G4double	lambdalimit

G4double	geomMin

G4double	geomMax

G4ThreeVector	fDisplacement

G4MscStepLimitType	steppingAlgorithm

G4bool	samplez

G4bool	latDisplasment

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

Additional Inherited Members
Static Protected Attributes inherited from G4VEmModel
static const G4double	inveplus = 1.0/CLHEP::eplus

Detailed Description

Definition at line 67 of file G4VMscModel.hh.

Constructor & Destructor Documentation

G4VMscModel::G4VMscModel ( const G4String & nam )

explicit

Definition at line 60 of file G4VMscModel.cc.

                                            :
   G4VEmModel(nam), 
   safetyHelper(nullptr),
   ionisation(nullptr),
   facrange(0.04),
   facgeom(2.5),
   facsafety(0.3),
   skin(1.0),
   dtrl(0.05),
   lambdalimit(mm),
   geomMin(1.e-6*CLHEP::mm),
   geomMax(1.e50*CLHEP::mm),
   fDisplacement(0.,0.,0.),
   steppingAlgorithm(fUseSafety),
   samplez(false),
   latDisplasment(true)
 {
   dedx       = 2.0*CLHEP::MeV*CLHEP::cm2/CLHEP::g;
   localrange = DBL_MAX;
   localtkin  = 0.0;
   currentPart = 0;
 }

G4VMscModel::~G4VMscModel ( )

virtual

Definition at line 85 of file G4VMscModel.cc.

86 {}

Member Function Documentation

G4double G4VMscModel::ComputeGeomLimit	(	const G4Track &	track,
		G4double &	presafety,
		G4double	limit
	)

inline

Definition at line 255 of file G4VMscModel.hh.

 {
   return safetyHelper->CheckNextStep(
           track.GetStep()->GetPreStepPoint()->GetPosition(),
       track.GetMomentumDirection(),
       limit, presafety);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4VMscModel::ComputeGeomPathLength ( G4double truePathLength )

virtual

Reimplemented in G4GoudsmitSaundersonMscModel, G4UrbanAdjointMscModel, G4UrbanMscModel, G4WentzelVIModel, and G4WentzelVIRelModel.

Definition at line 156 of file G4VMscModel.cc.

 {
   return truePathLength;
 }

Here is the caller graph for this function:

G4double G4VMscModel::ComputeSafety	(	const G4ThreeVector &	position,
		G4double	limit = `DBL_MAX`
	)

inline

Definition at line 237 of file G4VMscModel.hh.

 {
    return safetyHelper->ComputeSafety(position, limit);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4VMscModel::ComputeTruePathLengthLimit	(	const G4Track &	track,
		G4double &	stepLimit
	)

virtual

Reimplemented in G4GoudsmitSaundersonMscModel, G4UrbanAdjointMscModel, G4UrbanMscModel, G4WentzelVIModel, G4WentzelVIRelModel, and G4LowEWentzelVIModel.

Definition at line 149 of file G4VMscModel.cc.

 {
   return DBL_MAX;
 }

Here is the caller graph for this function:

G4double G4VMscModel::ComputeTrueStepLength ( G4double geomPathLength )

virtual

Reimplemented in G4GoudsmitSaundersonMscModel, G4UrbanAdjointMscModel, G4UrbanMscModel, G4WentzelVIModel, and G4WentzelVIRelModel.

Definition at line 163 of file G4VMscModel.cc.

 {
   return geomPathLength;
 }

Here is the caller graph for this function:

G4double G4VMscModel::ConvertTrueToGeom	(	G4double &	tLength,
		G4double &	gLength
	)

inlineprotected

Definition at line 245 of file G4VMscModel.hh.

 {
   glength = ComputeGeomPathLength(tlength);
   // should return true length 
   return tlength;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4VMscModel::GetDEDX	(	const G4ParticleDefinition *	part,
		G4double	kineticEnergy,
		const G4MaterialCutsCouple *	couple
	)

inline

Definition at line 268 of file G4VMscModel.hh.

 {
   G4double x;
   if(ionisation) { x = ionisation->GetDEDX(kinEnergy, couple); }
   else { 
     G4double q = part->GetPDGCharge()*inveplus;
     x = dedx*q*q;
   }
   return x;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4VMscModel::GetEnergy	(	const G4ParticleDefinition *	part,
		G4double	range,
		const G4MaterialCutsCouple *	couple
	)

inline

Definition at line 303 of file G4VMscModel.hh.

 {
   G4double e;
   //G4cout << "G4VMscModel::GetEnergy R(mm)= " << range << "  " << ionisation
   //     << "  Rlocal(mm)= " << localrange << "  Elocal(MeV)= " << localtkin
   //     << G4endl;
   if(ionisation) { e = ionisation->GetKineticEnergy(range, couple); }
   else { 
     e = localtkin;
     if(localrange > range) {
       G4double q = part->GetPDGCharge()*inveplus;
       e -= (localrange - range)*dedx*q*q*couple->GetMaterial()->GetDensity(); 
     } 
   }
   return e;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

G4VEnergyLossProcess * G4VMscModel::GetIonisation ( ) const

inline

Definition at line 323 of file G4VMscModel.hh.

 {
   return ionisation;
 }

G4ParticleChangeForMSC * G4VMscModel::GetParticleChangeForMSC ( const G4ParticleDefinition * p = nullptr )

protected

Definition at line 91 of file G4VMscModel.cc.

 {
   // recomputed for each new run
   if(!safetyHelper) {
     safetyHelper = G4TransportationManager::GetTransportationManager()
       ->GetSafetyHelper();
     safetyHelper->InitialiseHelper();
   }
   G4ParticleChangeForMSC* change = nullptr;
   if (pParticleChange) {
     change = static_cast<G4ParticleChangeForMSC*>(pParticleChange);
   } else {
     change = new G4ParticleChangeForMSC();
   }
   if(p) {
 
     // table is never built for GenericIon 
     if(p->GetParticleName() == "GenericIon") {
       if(xSectionTable) {
         xSectionTable->clearAndDestroy();
         delete xSectionTable;
         xSectionTable = nullptr;
       }
 
       // table is always built for low mass particles 
     } else if(p->GetPDGMass() < 4.5*GeV || ForceBuildTableFlag()) {
 
       G4EmParameters* param = G4EmParameters::Instance();
       idxTable = 0;
       G4LossTableBuilder* builder = 
     G4LossTableManager::Instance()->GetTableBuilder();
       if(IsMaster()) {
         G4double emin = std::max(LowEnergyLimit(), LowEnergyActivationLimit());
         G4double emax = std::min(HighEnergyLimit(), HighEnergyActivationLimit());
         emin = std::max(emin, param->MinKinEnergy());
         emax = std::min(emax, param->MaxKinEnergy());
         if(emin < emax) {
           xSectionTable = builder->BuildTableForModel(xSectionTable, this, p, 
                                                       emin, emax, true);
         }
       }
       theDensityFactor = builder->GetDensityFactors();
       theDensityIdx = builder->GetCoupleIndexes();
     }
   }
   return change;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4VMscModel::GetRange	(	const G4ParticleDefinition *	part,
		G4double	kineticEnergy,
		const G4MaterialCutsCouple *	couple
	)

inline

Definition at line 283 of file G4VMscModel.hh.

 {
   //G4cout << "G4VMscModel::GetRange E(MeV)= " << kinEnergy << "  " 
   //  << ionisation << "  " << part->GetParticleName()
   //     << G4endl;
   localtkin  = kinEnergy;
   if(ionisation) { 
     localrange = ionisation->GetRangeForLoss(kinEnergy, couple); 
   } else { 
     G4double q = part->GetPDGCharge()*inveplus;
     localrange = kinEnergy/(dedx*q*q*couple->GetMaterial()->GetDensity()); 
   }
   //G4cout << "R(mm)= " << localrange << "  "  << ionisation << G4endl;
   return localrange;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4VMscModel::GetTransportMeanFreePath	(	const G4ParticleDefinition *	part,
		G4double	kinEnergy
	)

inline

Definition at line 340 of file G4VMscModel.hh.

 {
   G4double x;
   if(xSectionTable) {
     G4int idx = CurrentCouple()->GetIndex();
     x = (*xSectionTable)[(*theDensityIdx)[idx]]->Value(ekin, idxTable)
       *(*theDensityFactor)[idx]/(ekin*ekin);
   } else { 
     x = CrossSectionPerVolume(CurrentCouple()->GetMaterial(), part, ekin, 
                   0.0, DBL_MAX); 
   }
   x = (x > 0.0) ? 1.0/x : DBL_MAX;
   return x;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

G4ThreeVector & G4VMscModel::SampleScattering	(	const G4ThreeVector &	,
		G4double	safety
	)

virtual

Reimplemented in G4GoudsmitSaundersonMscModel, G4UrbanAdjointMscModel, G4UrbanMscModel, G4WentzelVIModel, and G4WentzelVIRelModel.

Definition at line 142 of file G4VMscModel.cc.

 {
   return fDisplacement;
 }

Here is the caller graph for this function:

void G4VMscModel::SampleSecondaries	(	std::vector< G4DynamicParticle * > *	,
		const G4MaterialCutsCouple *	,
		const G4DynamicParticle *	,
		G4double	tmin,
		G4double	tmax
	)

overridevirtual

Implements G4VEmModel.

Reimplemented in G4DummyModel.

Definition at line 170 of file G4VMscModel.cc.

174 {}

void G4VMscModel::SetGeomFactor ( G4double val )

inline

Definition at line 216 of file G4VMscModel.hh.

 {
   if(!IsLocked()) { facgeom = val; }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void G4VMscModel::SetIonisation	(	G4VEnergyLossProcess *	p,
		const G4ParticleDefinition *	part
	)

inline

Definition at line 330 of file G4VMscModel.hh.

 {
   ionisation = p;
   currentPart = part;
 }

Here is the caller graph for this function:

void G4VMscModel::SetLateralDisplasmentFlag ( G4bool val )

inline

Definition at line 195 of file G4VMscModel.hh.

 {
   if(!IsLocked()) { latDisplasment = val; }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void G4VMscModel::SetRangeFactor ( G4double val )

inline

Definition at line 209 of file G4VMscModel.hh.

 {
   if(!IsLocked()) { facrange = val; }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void G4VMscModel::SetSampleZ ( G4bool val )

inline

Definition at line 230 of file G4VMscModel.hh.

 {
   if(!IsLocked()) { samplez = val; }
 }

Here is the call graph for this function:

void G4VMscModel::SetSkin ( G4double val )

inline

Definition at line 202 of file G4VMscModel.hh.

 {
   if(!IsLocked()) { skin = val; }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void G4VMscModel::SetStepLimitType ( G4MscStepLimitType val )

inline

Definition at line 223 of file G4VMscModel.hh.

 {
   if(!IsLocked()) { steppingAlgorithm = val; }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

G4double G4VMscModel::dtrl

protected

Definition at line 179 of file G4VMscModel.hh.

G4double G4VMscModel::facgeom

protected

Definition at line 176 of file G4VMscModel.hh.

G4double G4VMscModel::facrange

protected

Definition at line 175 of file G4VMscModel.hh.

G4double G4VMscModel::facsafety

protected

Definition at line 177 of file G4VMscModel.hh.

G4ThreeVector G4VMscModel::fDisplacement

protected

Definition at line 184 of file G4VMscModel.hh.

G4double G4VMscModel::geomMax

protected

Definition at line 182 of file G4VMscModel.hh.

G4double G4VMscModel::geomMin

protected

Definition at line 181 of file G4VMscModel.hh.

G4double G4VMscModel::lambdalimit

protected

Definition at line 180 of file G4VMscModel.hh.

G4bool G4VMscModel::latDisplasment

protected

Definition at line 188 of file G4VMscModel.hh.

G4bool G4VMscModel::samplez

protected

Definition at line 187 of file G4VMscModel.hh.

G4double G4VMscModel::skin

protected

Definition at line 178 of file G4VMscModel.hh.

G4MscStepLimitType G4VMscModel::steppingAlgorithm

protected

Definition at line 185 of file G4VMscModel.hh.

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

source/geant4.10.03.p03/source/processes/electromagnetic/utils/include/G4VMscModel.hh
source/geant4.10.03.p03/source/processes/electromagnetic/utils/src/G4VMscModel.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation