ParticleFilterPlacement Class Reference

Inheritance diagram for ParticleFilterPlacement:

List of all members.

---

Detailed Description

class ParticleFilterPlacement is one placement of a ParticleFilter element.

It inherits from G4Decay which does the heavy lifting, all we do here is decide whether or not to decay. We also kill tracks in BLManager::SteppingAction, because you cannot do that inside PostStepGetPhysicalInteractionLength().

Because geometry construction time is too early to manipulate physics processes, it registers a callback with BLManager to do it before the reference particle.

Public Member Functions
	ParticleFilterPlacement (BLCMDparticlefilter *_pf, G4VPhysicalVolume *_pv, G4String _name)
void	callback (int type)
G4bool	IsApplicable (const G4ParticleDefinition &)
G4double	AtRestGetPhysicalInteractionLength (const G4Track &track, G4ForceCondition *condition)
G4double	PostStepGetPhysicalInteractionLength (const G4Track &track, G4double previousStepSize, G4ForceCondition *condition)
void	UserSteppingAction (const G4Step *step)
void	PreUserTrackingAction (const G4Track *track)
void	PostUserTrackingAction (const G4Track *track)
Private Attributes
BLCMDparticlefilter *	filter
G4VPhysicalVolume *	vol
unsigned long	nDecayed
unsigned long	nKilled
int	nWait
int	referenceWait

---

Constructor & Destructor Documentation

ParticleFilterPlacement::ParticleFilterPlacement	(	BLCMDparticlefilter *	_pf,
		G4VPhysicalVolume *	_pv,
		G4String	_name
	)

References filter, BLManager::getObject(), nDecayed, nKilled, BLManager::registerCallback(), and vol.

                                                        : 
                                        G4Decay(_name), BLCallback()
{
        filter=_pf;
        vol=_pv; 
        nDecayed = 0;
        nKilled = 0;

        // now is too early to manage the physics processes
        BLManager::getObject()->registerCallback(this,0);

        // also register a callback after tracking, to display statistics
        BLManager::getObject()->registerCallback(this,2);
}

---

Member Function Documentation

void ParticleFilterPlacement::callback

(

int

type

)

[virtual]

Reimplemented from BLCallback.

References filter, BLElement::getName(), IsApplicable(), nDecayed, and nKilled.

{
        if(type == 0) {
            // add ourselves to the process list for each applicable particle
            // and remove the Decay process if necessary.
            G4ParticleTable::G4PTblDicIterator *theParticleIterator =
                        G4ParticleTable::GetParticleTable()->GetIterator();
            theParticleIterator->reset();
            while((*theParticleIterator)()) {
                G4ParticleDefinition *pd = theParticleIterator->value();
                if(IsApplicable(*pd)) {
                        G4ProcessManager *pmgr = pd->GetProcessManager();
again:                  G4ProcessVector *pv = pmgr->GetProcessList();
                        int n = pv->size();
                        for(int i=0; i<n; ++i) {
                                G4VProcess *process = (*pv)[i];
                                if(process->GetProcessName()=="Decay") {
                                        pmgr->RemoveProcess(process);
                                        goto again;
                                }
                        }
                        pmgr->AddProcess(this);
                        pmgr->SetProcessOrdering(this,idxPostStep);
                        pmgr->SetProcessOrdering(this,idxAtRest);
//for(int i=0; i<pv->size(); ++i) printf("ProcessName='%s'\n",(*pv)[i]->GetProcessName().c_str());
                }
            }
        } else if(type == 2) {
                printf("particlefilter %s: %lu decays  %lu killed\n",
                        filter->getName().c_str(),nDecayed,nKilled);
        }
}

G4bool ParticleFilterPlacement::IsApplicable

(

const G4ParticleDefinition &

pd

)

References BLCMDparticlefilter::decaySet, and filter.

Referenced by callback().

{
        if(filter->decaySet.count(pd.GetParticleName()) > 0)
                return G4Decay::IsApplicable(pd);
        return false;
}

G4double ParticleFilterPlacement::AtRestGetPhysicalInteractionLength	(	const G4Track &	track,
		G4ForceCondition *	condition
	)

References filter, BLElement::getName(), nDecayed, BLCMDparticlefilter::steppingVerbose, and vol.

{
        // we are only applied to particlies listed in decaySet.
        if(track.GetVolume() == vol || track.GetNextVolume() == vol) {
                ++nDecayed;
                *condition = Forced;
                if(filter->steppingVerbose) 
                        printf("particlefilter '%s' forced Decay\n",
                                        filter->getName().c_str());
                return DBL_MIN;
        }

        *condition = NotForced;
        return DBL_MAX;
}

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

References filter, BLElement::getName(), nDecayed, BLCMDparticlefilter::steppingVerbose, and vol.

{
        // we are only applied to particlies listed in decaySet.
        if(track.GetVolume() == vol || track.GetNextVolume() == vol) {
                ++nDecayed;
                *condition = Forced;
                if(filter->steppingVerbose) 
                        printf("particlefilter '%s' forced Decay\n",
                                        filter->getName().c_str());
                return DBL_MIN;
        }

        *condition = NotForced;
        return DBL_MAX;
}

void ParticleFilterPlacement::UserSteppingAction

(

const G4Step *

step

)

[virtual]

Implements BLManager::SteppingAction.

References BEAM, BLEvaluator::evaluate(), filter, BLManager::getObject(), BLCMDparticlefilter::keepSet, BLCMDparticlefilter::killSet, nKilled, nWait, referenceWait, BLCMDparticlefilter::require, BLCMDparticlefilter::steppingVerbose, VISUAL, and vol.

{
        // handle all states

        G4Track *track = step->GetTrack();
        G4VPhysicalVolume *preVol = 
                                step->GetPreStepPoint()->GetPhysicalVolume();
        G4VPhysicalVolume *postVol = 
                                step->GetPostStepPoint()->GetPhysicalVolume();

        // only handle the step that enters the volume
        if(preVol == postVol || postVol != vol) return;

//printf("ParticleFilterPlacement nWait=%d referenceWait=%d\n",nWait,referenceWait);
        // wait until track has hit us nWait times.
        if(BLManager::getObject()->getState() == BEAM) {
                if(--nWait > 0) return;
        } else if(BLManager::getObject()->getState() == VISUAL) {
                if(--nWait > 0) return;
        } else {
                if(--referenceWait > 0) return;
        }
//printf("ParticleFilterPlacement-2 nWait=%d referenceWait=%d\n",nWait,referenceWait);

        // we get called for every particle transiting our volume, so we
        // need to check for presence in killSet and keepSet, then require.
        G4ParticleDefinition *def = track->GetDefinition();
        if(filter->killSet.count(def->GetParticleName()) > 0 ||
                        (filter->keepSet.size() > 0 &&
                         filter->keepSet.count(def->GetParticleName()) == 0)) {
                track->SetTrackStatus(fStopAndKill);
                ++nKilled;
                if(filter->steppingVerbose) 
                        printf("ParticleFilterPlacement killed track\n");
        } else if(filter->require != "") {
                static BLEvaluator *e=0;
                if(!e)
                        e = new BLEvaluator();
                G4ThreeVector position = track->GetPosition();
                e->setVariable("x",position[0]);
                e->setVariable("y",position[1]);
                e->setVariable("z",position[2]);
                e->setVariable("t",track->GetGlobalTime());
                G4ThreeVector mom = track->GetMomentum();
                e->setVariable("Px",mom[0]);
                e->setVariable("Py",mom[1]);
                e->setVariable("Pz",mom[2]);
                e->setVariable("Ptot",sqrt(mom[0]*mom[0]+mom[1]*mom[1]+
                                                        mom[2]*mom[2]));
                e->setVariable("PDGid",def->GetPDGEncoding());
                e->setVariable("EventID",BLManager::getObject()->
                                getEventID());
                e->setVariable("TrackID",BLManager::getObject()->
                                getExternalTrackID(track));
                e->setVariable("ParentID",BLManager::getObject()->
                                getExternalParentID(track));
                if(e->evaluate(filter->require) == 0.0) {
                        track->SetTrackStatus(fStopAndKill);
                        ++nKilled;
                        if(filter->steppingVerbose) 
                                printf("ParticleFilterPlacement killed track\n");
                }
        }
}

void ParticleFilterPlacement::PreUserTrackingAction

(

const G4Track *

track

)

[virtual]

Implements BLManager::TrackingAction.

References filter, BLCMDparticlefilter::nWait, nWait, BLCMDparticlefilter::referenceWait, and referenceWait.

{
        nWait = filter->nWait;
        referenceWait = filter->referenceWait;
//printf("ParticleFilterPlacement-PreTracking nWait=%d referenceWait=%d\n",nWait,referenceWait);
}

void ParticleFilterPlacement::PostUserTrackingAction

(

const G4Track *

track

)

[inline, virtual]

Implements BLManager::TrackingAction.

{ }

---

Member Data Documentation

BLCMDparticlefilter* ParticleFilterPlacement::filter [private]

Referenced by AtRestGetPhysicalInteractionLength(), callback(), IsApplicable(), ParticleFilterPlacement(), PostStepGetPhysicalInteractionLength(), PreUserTrackingAction(), and UserSteppingAction().

G4VPhysicalVolume* ParticleFilterPlacement::vol [private]

Referenced by AtRestGetPhysicalInteractionLength(), ParticleFilterPlacement(), PostStepGetPhysicalInteractionLength(), and UserSteppingAction().

unsigned long ParticleFilterPlacement::nDecayed [private]

Referenced by AtRestGetPhysicalInteractionLength(), callback(), ParticleFilterPlacement(), and PostStepGetPhysicalInteractionLength().

unsigned long ParticleFilterPlacement::nKilled [private]

Referenced by callback(), ParticleFilterPlacement(), and UserSteppingAction().

int ParticleFilterPlacement::nWait [private]

Referenced by PreUserTrackingAction(), and UserSteppingAction().

int ParticleFilterPlacement::referenceWait [private]

Referenced by PreUserTrackingAction(), and UserSteppingAction().

---

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

• BLCMDparticlefilter.cc