G4ImportanceProcess Class Reference

#include <G4ImportanceProcess.hh>

Inheritance diagram for G4ImportanceProcess:

Public Member Functions
	G4ImportanceProcess (const G4VImportanceAlgorithm &aImportanceAlgorithm, const G4VIStore &aIstore, const G4VTrackTerminator *TrackTerminator, const G4String &aName="ImportanceProcess", G4bool para=false)
virtual	~G4ImportanceProcess ()
	G4ImportanceProcess (const G4ImportanceProcess &)=delete
G4ImportanceProcess &	operator= (const G4ImportanceProcess &)=delete
void	SetParallelWorld (const G4String &parallelWorldName)
void	StartTracking (G4Track *)
virtual G4double	PostStepGetPhysicalInteractionLength (const G4Track &aTrack, G4double previousStepSize, G4ForceCondition *condition)
virtual G4VParticleChange *	PostStepDoIt (const G4Track &, const G4Step &)
virtual void	KillTrack () const
virtual const G4String &	GetName () const
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 ()
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)
virtual G4bool	IsApplicable (const G4ParticleDefinition &)
virtual void	BuildPhysicsTable (const G4ParticleDefinition &)
virtual void	PreparePhysicsTable (const G4ParticleDefinition &)
virtual G4bool	StorePhysicsTable (const G4ParticleDefinition *, const G4String &, G4bool)
virtual G4bool	RetrievePhysicsTable (const G4ParticleDefinition *, const G4String &, G4bool)
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
virtual void	DumpInfo () const
virtual void	ProcessDescription (std::ostream &outfile) 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 &)
Public Member Functions inherited from G4VTrackTerminator
	G4VTrackTerminator ()
virtual	~G4VTrackTerminator ()

Additional Inherited Members
Static Public Member Functions inherited from G4VProcess
static const G4String &	GetProcessTypeName (G4ProcessType)
Protected Member Functions inherited from G4VProcess
void	SubtractNumberOfInteractionLengthLeft (G4double prevStepSize)
void	ClearNumberOfInteractionLengthLeft ()
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
Protected Attributes inherited from G4VTrackTerminator
G4double	kCarTolerance

Detailed Description

Definition at line 57 of file G4ImportanceProcess.hh.

Constructor & Destructor Documentation

G4ImportanceProcess() [1/2]

G4ImportanceProcess::G4ImportanceProcess	(	const G4VImportanceAlgorithm &	aImportanceAlgorithm,
		const G4VIStore &	aIstore,
		const G4VTrackTerminator *	TrackTerminator,
		const G4String &	aName = "ImportanceProcess",
		G4bool	para = false )

Definition at line 49 of file G4ImportanceProcess.cc.

 : G4VProcess(aName, fParallel),
   fParticleChange(new G4ParticleChange),
   fImportanceAlgorithm(aImportanceAlgorithm),
   fIStore(aIstore),
   fParaflag(para)
{
  G4cout << "### G4ImportanceProcess:: Creating " << G4endl;
  if (TrackTerminator != nullptr)
  {
    fPostStepAction = new G4SamplingPostStepAction(*TrackTerminator);
  }
  else
  {
    fPostStepAction = new G4SamplingPostStepAction(*this);
  }
  if (fParticleChange == nullptr)
  {
    G4Exception("G4ImportanceProcess::G4ImportanceProcess()",
                "FatalError", FatalException,
                "Failed allocation of G4ParticleChange !");
  }
  G4VProcess::pParticleChange = fParticleChange;
 
 
  fGhostStep = new G4Step();
  fGhostPreStepPoint = fGhostStep->GetPreStepPoint();
  fGhostPostStepPoint = fGhostStep->GetPostStepPoint();
 
  fTransportationManager = G4TransportationManager::GetTransportationManager();
  fPathFinder = G4PathFinder::GetInstance();
 
  if (verboseLevel>0)
  {
    G4cout << GetProcessName() << " is created " << G4endl;
  }
 
  G4cout << "G4ImportanceProcess:: importance process paraflag is: " << fParaflag << G4endl;
 
}

Referenced by G4ImportanceProcess(), and operator=().

~G4ImportanceProcess()

G4ImportanceProcess::~G4ImportanceProcess ( )

virtual

Definition at line 94 of file G4ImportanceProcess.cc.

{
  delete fPostStepAction;
  delete fParticleChange;
}

G4ImportanceProcess() [2/2]

G4ImportanceProcess::G4ImportanceProcess ( const G4ImportanceProcess & )

delete

Member Function Documentation

AlongStepDoIt()

G4VParticleChange * G4ImportanceProcess::AlongStepDoIt ( const G4Track & aTrack, const G4Step &  )

virtual

Implements G4VProcess.

Definition at line 352 of file G4ImportanceProcess.cc.

{
  // Dummy ParticleChange ie: does nothing
  // Expecting G4Transportation to move the track
  pParticleChange->Initialize(aTrack);
  return pParticleChange; 
}

AlongStepGetPhysicalInteractionLength()

G4double G4ImportanceProcess::AlongStepGetPhysicalInteractionLength ( const G4Track & track, G4double previousStepSize, G4double currentMinimumStep, G4double & proposedSafety, G4GPILSelection * selection )

virtual

Implements G4VProcess.

Definition at line 265 of file G4ImportanceProcess.cc.

{
  if(fParaflag)
  {    
    *selection = NotCandidateForSelection;
    G4double returnedStep = DBL_MAX;
    
    if (previousStepSize > 0.)
      { fGhostSafety -= previousStepSize; }
    //  else
    //  { fGhostSafety = -1.; }
    if (fGhostSafety < 0.) { fGhostSafety = 0.0; }
    
    // ------------------------------------------
    // Determination of the proposed STEP LENGTH:
    // ------------------------------------------
    if (currentMinimumStep <= fGhostSafety && currentMinimumStep > 0.)
    {
      // I have no chance to limit
      returnedStep = currentMinimumStep;
      fOnBoundary = false;
      proposedSafety = fGhostSafety - currentMinimumStep;
    }
    else // (currentMinimumStep > fGhostSafety: I may limit the Step)
    {
      G4FieldTrackUpdator::Update(&fFieldTrack,&track);
      //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
      // ComputeStep
      //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
      returnedStep
      = fPathFinder->ComputeStep(fFieldTrack,currentMinimumStep,fNavigatorID,
                                     track.GetCurrentStepNumber(),fGhostSafety,feLimited,
                                     fEndTrack,track.GetVolume());
      //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
      if(feLimited == kDoNot)
      {
        // Track is not on the boundary
        fOnBoundary = false;
        fGhostSafety = fGhostNavigator->ComputeSafety(fEndTrack.GetPosition());
      }
      else
      {
        // Track is on the boundary
        fOnBoundary = true;
      }
      proposedSafety = fGhostSafety;
      if(feLimited == kUnique || feLimited == kSharedOther)
      {
        *selection = CandidateForSelection;
      }
      else if (feLimited == kSharedTransport)
      { 
        returnedStep *= (1.0 + 1.0e-9);  
        // Expand to disable its selection in Step Manager comparison
      }
    }
 
    // ----------------------------------------------
    // Returns the fGhostSafety as the proposedSafety
    // The SteppingManager will take care of keeping
    // the smallest one.
    // ----------------------------------------------
    return returnedStep;
  }
  else
  {
    return DBL_MAX;
  }
}

AtRestDoIt()

G4VParticleChange * G4ImportanceProcess::AtRestDoIt ( const G4Track & , const G4Step &  )

virtual

Implements G4VProcess.

Definition at line 346 of file G4ImportanceProcess.cc.

{
  return nullptr;
}

AtRestGetPhysicalInteractionLength()

G4double G4ImportanceProcess::AtRestGetPhysicalInteractionLength ( const G4Track & , G4ForceCondition *  )

virtual

Implements G4VProcess.

Definition at line 339 of file G4ImportanceProcess.cc.

{
  return -1.0;
}

GetName()

const G4String & G4ImportanceProcess::GetName ( ) const

virtual

Implements G4VTrackTerminator.

Definition at line 260 of file G4ImportanceProcess.cc.

{
  return theProcessName;
}

KillTrack()

void G4ImportanceProcess::KillTrack ( ) const

virtual

Implements G4VTrackTerminator.

Definition at line 255 of file G4ImportanceProcess.cc.

{
  fParticleChange->ProposeTrackStatus(fStopAndKill);
}

operator=()

G4ImportanceProcess & G4ImportanceProcess::operator= ( const G4ImportanceProcess & )

delete

PostStepDoIt()

G4VParticleChange * G4ImportanceProcess::PostStepDoIt ( const G4Track & aTrack, const G4Step & aStep )

virtual

Implements G4VProcess.

Definition at line 170 of file G4ImportanceProcess.cc.

{
  fParticleChange->Initialize(aTrack);
 
  if(aTrack.GetNextVolume() == nullptr)
  {
    return fParticleChange;
  }
  
  if(fParaflag)
  {
    fOldGhostTouchable = fGhostPostStepPoint->GetTouchableHandle();
    //xbug?    fOnBoundary = false;
    CopyStep(aStep);
    
    if(fOnBoundary)
    {
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
// Locate the point and get new touchable
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  //??  fPathFinder->Locate(step.GetPostStepPoint()->GetPosition(),
  //??                      step.GetPostStepPoint()->GetMomentumDirection());
    fNewGhostTouchable = fPathFinder->CreateTouchableHandle(fNavigatorID);
    }
    else
    {
      // reuse the touchable
      fNewGhostTouchable = fOldGhostTouchable;
    }
    
    fGhostPreStepPoint->SetTouchableHandle(fOldGhostTouchable);
    fGhostPostStepPoint->SetTouchableHandle(fNewGhostTouchable);
    
    if ( (fGhostPostStepPoint->GetStepStatus() == fGeomBoundary)
     && (aStep.GetStepLength() > kCarTolerance) )
    {
      if (aTrack.GetTrackStatus()==fStopAndKill)
      {
        G4cout << "WARNING - G4ImportanceProcess::PostStepDoIt()"
               << "          StopAndKill track. on boundary" << G4endl;
      }
 
      G4GeometryCell prekey(*(fGhostPreStepPoint->GetPhysicalVolume()), 
                            fGhostPreStepPoint->GetTouchable()->GetReplicaNumber());
      G4GeometryCell postkey(*(fGhostPostStepPoint->GetPhysicalVolume()), 
                             fGhostPostStepPoint->GetTouchable()->GetReplicaNumber());
 
      G4Nsplit_Weight nw = 
          fImportanceAlgorithm.Calculate(fIStore.GetImportance(prekey),
                                 fIStore.GetImportance(postkey), 
                                 aTrack.GetWeight());
      fPostStepAction->DoIt(aTrack, fParticleChange, nw);
    }
  }
  else
  {
    if ( (aStep.GetPostStepPoint()->GetStepStatus() == fGeomBoundary)
         && (aStep.GetStepLength() > kCarTolerance) )
    {
      if (aTrack.GetTrackStatus()==fStopAndKill)
      {
        G4cout << "WARNING - G4ImportanceProcess::PostStepDoIt()"
               << "          StopAndKill track. on boundary non-parallel"
               << G4endl;
      }
    
      G4StepPoint *prepoint  = aStep.GetPreStepPoint();
      G4StepPoint *postpoint = aStep.GetPostStepPoint();
 
      G4GeometryCell prekey(*(prepoint->GetPhysicalVolume()), 
                            prepoint->GetTouchable()->GetReplicaNumber());
      G4GeometryCell postkey(*(postpoint->GetPhysicalVolume()), 
                             postpoint->GetTouchable()->GetReplicaNumber());
 
      G4Nsplit_Weight nw =
          fImportanceAlgorithm.Calculate(fIStore.GetImportance(prekey),
                                         fIStore.GetImportance(postkey), 
                                         aTrack.GetWeight());
    fPostStepAction->DoIt(aTrack, fParticleChange, nw);
    }
  }
  return fParticleChange;
}

PostStepGetPhysicalInteractionLength()

G4double G4ImportanceProcess::PostStepGetPhysicalInteractionLength ( const G4Track & aTrack, G4double previousStepSize, G4ForceCondition * condition )

virtual

Implements G4VProcess.

Definition at line 161 of file G4ImportanceProcess.cc.

{
  *condition = Forced;
  return DBL_MAX;
}

SetParallelWorld()

void G4ImportanceProcess::SetParallelWorld

(

const G4String &

parallelWorldName

)

Definition at line 105 of file G4ImportanceProcess.cc.

{
  G4cout << G4endl << G4endl << G4endl;
  G4cout << "G4ImportanceProcess:: SetParallelWorld name = " << parallelWorldName << G4endl;
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
// Get pointers of the parallel world and its navigator
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  fGhostWorldName = parallelWorldName;
  fGhostWorld = fTransportationManager->GetParallelWorld(fGhostWorldName);
  fGhostNavigator = fTransportationManager->GetNavigator(fGhostWorld);
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
}

StartTracking()

void G4ImportanceProcess::StartTracking ( G4Track * trk )

virtual

Reimplemented from G4VProcess.

Definition at line 123 of file G4ImportanceProcess.cc.

{
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
// Activate navigator and get the navigator ID
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
  if(fParaflag)
  {
    if(fGhostNavigator != nullptr)
    {
      fNavigatorID = fTransportationManager->ActivateNavigator(fGhostNavigator);
    }
    else
    {
      G4Exception("G4ImportanceProcess::StartTracking",
                  "ProcParaWorld000",FatalException,
                  "G4ImportanceProcess is used for tracking without having a parallel world assigned");
    }
 
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
// Let PathFinder initialize
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    fPathFinder->PrepareNewTrack(trk->GetPosition(),trk->GetMomentumDirection());
 
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
// Setup initial touchables for the first step
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    fOldGhostTouchable = fPathFinder->CreateTouchableHandle(fNavigatorID);
    fGhostPreStepPoint->SetTouchableHandle(fOldGhostTouchable);
    fNewGhostTouchable = fOldGhostTouchable;
    fGhostPostStepPoint->SetTouchableHandle(fNewGhostTouchable);
 
  // Initialize 
    fGhostSafety = -1.;
    fOnBoundary = false;
  }
}

---

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

• G4ImportanceProcess.hh
• G4ImportanceProcess.cc