G4WeightCutOffProcess Class Reference

#include <G4WeightCutOffProcess.hh>

Inheritance diagram for G4WeightCutOffProcess:

Public Member Functions
	G4WeightCutOffProcess (G4double wsurvival, G4double wlimit, G4double isource, G4VIStore *istore, const G4String &aName="WeightCutOffProcess", G4bool para=false)
virtual	~G4WeightCutOffProcess ()
	G4WeightCutOffProcess (const G4WeightCutOffProcess &)=delete
G4WeightCutOffProcess &	operator= (const G4WeightCutOffProcess &)=delete
void	SetParallelWorld (const G4String &parallelWorldName)
void	SetParallelWorld (G4VPhysicalVolume *parallelWorld)
void	StartTracking (G4Track *)
virtual G4double	PostStepGetPhysicalInteractionLength (const G4Track &aTrack, G4double previousStepSize, G4ForceCondition *condition)
virtual G4VParticleChange *	PostStepDoIt (const G4Track &, const G4Step &)
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 &)

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

Detailed Description

Definition at line 54 of file G4WeightCutOffProcess.hh.

Constructor & Destructor Documentation

G4WeightCutOffProcess() [1/2]

G4WeightCutOffProcess::G4WeightCutOffProcess	(	G4double	wsurvival,
		G4double	wlimit,
		G4double	isource,
		G4VIStore *	istore,
		const G4String &	aName = "WeightCutOffProcess",
		G4bool	para = false )

Definition at line 47 of file G4WeightCutOffProcess.cc.

  : G4VProcess(aName), 
    fParticleChange(new G4ParticleChange),
    fWeightSurvival(wsurvival),
    fWeightLimit(wlimit),
    fSourceImportance(isource), 
    fIStore(istore),
    fParaflag(para)
{
  if (!fParticleChange)
  {
    G4Exception("G4WeightCutOffProcess::G4WeightCutOffProcess()",
                "FatalError", FatalException,
                "Failed to allocate 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;
  }
}

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

~G4WeightCutOffProcess()

G4WeightCutOffProcess::~G4WeightCutOffProcess ( )

virtual

Definition at line 83 of file G4WeightCutOffProcess.cc.

{
  delete fParticleChange;
  // delete fGhostStep;
}

G4WeightCutOffProcess() [2/2]

G4WeightCutOffProcess::G4WeightCutOffProcess ( const G4WeightCutOffProcess & )

delete

Member Function Documentation

AlongStepDoIt()

G4VParticleChange * G4WeightCutOffProcess::AlongStepDoIt ( const G4Track & track, const G4Step &  )

virtual

Implements G4VProcess.

Definition at line 373 of file G4WeightCutOffProcess.cc.

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

AlongStepGetPhysicalInteractionLength()

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

virtual

Implements G4VProcess.

Definition at line 285 of file G4WeightCutOffProcess.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;
      }
    //xbug? 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;
    //not sensible!    return -1.0;
  }
 
}

AtRestDoIt()

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

virtual

Implements G4VProcess.

Definition at line 367 of file G4WeightCutOffProcess.cc.

{
  return nullptr;
}

AtRestGetPhysicalInteractionLength()

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

virtual

Implements G4VProcess.

Definition at line 359 of file G4WeightCutOffProcess.cc.

{
  return -1.0;
}

GetName()

const G4String & G4WeightCutOffProcess::GetName

(

)

const

Definition at line 280 of file G4WeightCutOffProcess.cc.

{
  return theProcessName;
}

operator=()

G4WeightCutOffProcess & G4WeightCutOffProcess::operator= ( const G4WeightCutOffProcess & )

delete

PostStepDoIt()

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

virtual

Implements G4VProcess.

Definition at line 177 of file G4WeightCutOffProcess.cc.

{
  fParticleChange->Initialize(aTrack);
 
  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
      {
    // Do I need this ??????????????????????????????????????????????????????????
    // fGhostNavigator->LocateGlobalPointWithinVolume(track.GetPosition());
    // ?????????????????????????????????????????????????????????????????????????
    
    // fPathFinder->ReLocate(track.GetPosition());
    
    // reuse the touchable
    fNewGhostTouchable = fOldGhostTouchable;
      }
    
    fGhostPreStepPoint->SetTouchableHandle(fOldGhostTouchable);
    fGhostPostStepPoint->SetTouchableHandle(fNewGhostTouchable);
 
  }
 
  if(fParaflag) {
    G4GeometryCell postCell(*(fGhostPostStepPoint->GetPhysicalVolume()), 
                fGhostPostStepPoint->GetTouchable()->GetReplicaNumber());
 
 
    //  G4GeometryCell postCell = fGCellFinder.GetPostGeometryCell(aStep);
    //  G4GeometryCell postCell = fGCellFinder.GetPostGeometryCell(fGhostStep);
    G4double R = fSourceImportance;
    if (fIStore != nullptr)
      {
    G4double i = fIStore->GetImportance(postCell);
    if (i>0)
      {
        R/=i;
      }
      }
    G4double w = aTrack.GetWeight();
    if (w<R*fWeightLimit)
      {
    G4double ws = fWeightSurvival*R;
    G4double p = w/(ws);
    if (G4UniformRand()<p)
      {
        fParticleChange->ProposeTrackStatus(fStopAndKill);
      }
    else
      {
        fParticleChange->ProposeWeight(ws);
      }                  
      }
  } else {
 
    G4GeometryCell postCell(*(aStep.GetPostStepPoint()->GetPhysicalVolume()), 
                aStep.GetPostStepPoint()->GetTouchable()->GetReplicaNumber());
 
    //  G4GeometryCell postCell = fGCellFinder.GetPostGeometryCell(aStep);
    //  G4GeometryCell postCell = fGCellFinder.GetPostGeometryCell(fGhostStep);
    G4double R = fSourceImportance;
    if (fIStore != nullptr)
      {
    G4double i = fIStore->GetImportance(postCell);
    if (i>0)
      {
        R/=i;
      }
      }
    G4double w = aTrack.GetWeight();
    if (w<R*fWeightLimit)
      {
    G4double ws = fWeightSurvival*R;
    G4double p = w/(ws);
    if (G4UniformRand()<p)
      {
        fParticleChange->ProposeTrackStatus(fStopAndKill);
      }
    else
      {
        fParticleChange->ProposeWeight(ws);
      }                  
      }
  }
 
  return fParticleChange;
 
}

PostStepGetPhysicalInteractionLength()

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

virtual

Implements G4VProcess.

Definition at line 164 of file G4WeightCutOffProcess.cc.

{
//   *condition = Forced;
//   return kInfinity;
 
//  *condition = StronglyForced;
  *condition = Forced;
  return DBL_MAX;
}

SetParallelWorld() [1/2]

void G4WeightCutOffProcess::SetParallelWorld

(

const G4String &

parallelWorldName

)

Definition at line 95 of file G4WeightCutOffProcess.cc.

{
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
// Get pointers of the parallel world and its navigator
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  fGhostWorldName = parallelWorldName;
  fGhostWorld = fTransportationManager->GetParallelWorld(fGhostWorldName);
  fGhostNavigator = fTransportationManager->GetNavigator(fGhostWorld);
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
}

SetParallelWorld() [2/2]

void G4WeightCutOffProcess::SetParallelWorld

(

G4VPhysicalVolume *

parallelWorld

)

Definition at line 107 of file G4WeightCutOffProcess.cc.

{
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
// Get pointer of navigator
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  fGhostWorldName = parallelWorld->GetName();
  fGhostWorld = parallelWorld;
  fGhostNavigator = fTransportationManager->GetNavigator(fGhostWorld);
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
}

StartTracking()

void G4WeightCutOffProcess::StartTracking ( G4Track * trk )

virtual

Reimplemented from G4VProcess.

Definition at line 124 of file G4WeightCutOffProcess.cc.

{
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
// Activate navigator and get the navigator ID
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
// G4cout << " G4ParallelWorldScoringProcess::StartTracking" << G4endl;
 
  if(fParaflag) {
    if(fGhostNavigator != nullptr)
      { fNavigatorID = fTransportationManager->ActivateNavigator(fGhostNavigator); }
    else
      {
    G4Exception("G4WeightCutOffProcess::StartTracking",
            "ProcParaWorld000",FatalException,
            "G4WeightCutOffProcess is used for tracking without having a parallel world assigned");
      }
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
// G4cout << "G4ParallelWorldScoringProcess::StartTracking <<<<<<<<<<<<<<<<<< " << G4endl;
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
// 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:

• G4WeightCutOffProcess.hh
• G4WeightCutOffProcess.cc