XWrapperDiscreteProcess Class Reference

#include <XWrapperDiscreteProcess.hh>

Inheritance diagram for XWrapperDiscreteProcess:

Collaboration diagram for XWrapperDiscreteProcess:

Public Member Functions
	XWrapperDiscreteProcess (const G4String &processName="XWrapperDiscreteProcess")
	XWrapperDiscreteProcess (const G4String &, G4VDiscreteProcess *)
G4int	ItHasToWork (const G4Track &)
virtual	~XWrapperDiscreteProcess ()
void	RegisterProcess (G4VDiscreteProcess *)
void	RegisterProcess (G4VDiscreteProcess *, G4int, G4int aBool=0)
G4double	GetDensity (const G4Track &)
G4double	GetDensityPreviousStep (const G4Track &)
void	SetNucleiOrElectronFlag (G4int)
G4int	GetNucleiOrElectronFlag ()
virtual G4VParticleChange *	PostStepDoIt (const G4Track &, const G4Step &)
virtual G4VParticleChange *	AtRestDoIt (const G4Track &aTrack, const G4Step &aStep)
virtual G4double	PostStepGetPhysicalInteractionLength (const G4Track &, G4double, G4ForceCondition *)
virtual G4double	AtRestGetPhysicalInteractionLength (const G4Track &aTrack, G4ForceCondition *condition)
void	StartTracking (G4Track *)
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)
virtual void	EndTracking ()
virtual void	SetProcessManager (const G4ProcessManager *aPM)
virtual const G4ProcessManager *	GetProcessManager ()
virtual void	ResetNumberOfInteractionLengthLeft ()
virtual void	DumpInfo () const
virtual void	SetMasterProcess (G4VProcess *masterP)
virtual void	BuildWorkerPhysicsTable (const G4ParticleDefinition &aPD)
virtual void	PrepareWorkerPhysicsTable (const G4ParticleDefinition &aPD)
Public Member Functions inherited from G4VDiscreteProcess
	G4VDiscreteProcess (const G4String &, G4ProcessType aType=fNotDefined)
	G4VDiscreteProcess (G4VDiscreteProcess &)
virtual	~G4VDiscreteProcess ()
virtual G4double	AlongStepGetPhysicalInteractionLength (const G4Track &, G4double, G4double, G4double &, G4GPILSelection *)
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 ()
G4int	operator== (const G4VProcess &right) const
G4int	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)
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)
G4double	GetNumberOfInteractionLengthLeft () const
G4double	GetTotalNumberOfInteractionLengthTraversed () const
G4bool	isAtRestDoItIsEnabled () const
G4bool	isAlongStepDoItIsEnabled () const
G4bool	isPostStepDoItIsEnabled () const
void	SetVerboseLevel (G4int value)
G4int	GetVerboseLevel () const
const G4VProcess *	GetMasterProcess () const

Protected Member Functions
virtual G4double	GetMeanFreePath (const G4Track &, G4double, G4ForceCondition *)
Protected Member Functions inherited from G4VProcess
void	SubtractNumberOfInteractionLengthLeft (G4double previousStepSize)
void	ClearNumberOfInteractionLengthLeft ()

Private Member Functions
	XWrapperDiscreteProcess (XWrapperDiscreteProcess &)
XWrapperDiscreteProcess &	operator= (const XWrapperDiscreteProcess &)

Private Attributes
G4int	bBothOrCrystalOrDetectorPhysics
	Decide whether to use nuclei (+1) or electron (-1) or both (0) More...
G4int	bNucleiOrElectronFlag
G4VDiscreteProcess *	fRegisteredProcess
G4ParticleChangeForNothing *	fParticleChangeForNothing

Additional Inherited Members
Static Public Member Functions inherited from G4VProcess
static const G4String &	GetProcessTypeName (G4ProcessType)
Protected Attributes inherited from G4VProcess
const G4ProcessManager *	aProcessManager
G4VParticleChange *	pParticleChange
G4ParticleChange	aParticleChange
G4double	theNumberOfInteractionLengthLeft
G4double	currentInteractionLength
G4double	theInitialNumberOfInteractionLength
G4String	theProcessName
G4String	thePhysicsTableFileName
G4ProcessType	theProcessType
G4int	theProcessSubType
G4double	thePILfactor
G4bool	enableAtRestDoIt
G4bool	enableAlongStepDoIt
G4bool	enablePostStepDoIt
G4int	verboseLevel

Detailed Description

Definition at line 38 of file XWrapperDiscreteProcess.hh.

Constructor & Destructor Documentation

XWrapperDiscreteProcess() [1/3]

XWrapperDiscreteProcess::XWrapperDiscreteProcess

(

const G4String &

processName = "XWrapperDiscreteProcess"

)

Definition at line 42 of file XWrapperDiscreteProcess.cc.

:G4VDiscreteProcess(aName){
    if (verboseLevel>1) {
        G4cout << GetProcessName() << " is created "<< G4endl;
    }
    bNucleiOrElectronFlag = +0;
    bBothOrCrystalOrDetectorPhysics = +0;
    fParticleChangeForNothing = new G4ParticleChangeForNothing();
}

Here is the call graph for this function:

Here is the caller graph for this function:

XWrapperDiscreteProcess() [2/3]

XWrapperDiscreteProcess::XWrapperDiscreteProcess	(	const G4String &	,
		G4VDiscreteProcess *	toRegister
	)

Definition at line 55 of file XWrapperDiscreteProcess.cc.

:G4VDiscreteProcess("XWrapperDiscreteProcess"){
    fRegisteredProcess = toRegister;
    theProcessType = fRegisteredProcess->GetProcessType();
    theProcessSubType = fRegisteredProcess->GetProcessSubType();
    enableAtRestDoIt = fRegisteredProcess->isAtRestDoItIsEnabled();
    enableAlongStepDoIt = fRegisteredProcess->isAlongStepDoItIsEnabled();
    enablePostStepDoIt = fRegisteredProcess->isPostStepDoItIsEnabled();
    bNucleiOrElectronFlag = +0;
    bBothOrCrystalOrDetectorPhysics = +0;
    fParticleChangeForNothing = new G4ParticleChangeForNothing();
}

Here is the call graph for this function:

~XWrapperDiscreteProcess()

XWrapperDiscreteProcess::~XWrapperDiscreteProcess ( )

virtual

Definition at line 71 of file XWrapperDiscreteProcess.cc.

                                                 {
    ;
}

Here is the call graph for this function:

XWrapperDiscreteProcess() [3/3]

XWrapperDiscreteProcess::XWrapperDiscreteProcess ( XWrapperDiscreteProcess &  right )

private

Definition at line 78 of file XWrapperDiscreteProcess.cc.

                                                       :
G4VDiscreteProcess(right){
    ;
}

Member Function Documentation

AtRestDoIt()

virtual G4VParticleChange* XWrapperDiscreteProcess::AtRestDoIt ( const G4Track &  aTrack, const G4Step &  aStep  )

inlinevirtual

Reimplemented from G4VDiscreteProcess.

Definition at line 81 of file XWrapperDiscreteProcess.hh.

                                                              {
        return fRegisteredProcess->AtRestDoIt(aTrack,aStep);
    }

Here is the call graph for this function:

AtRestGetPhysicalInteractionLength()

virtual G4double XWrapperDiscreteProcess::AtRestGetPhysicalInteractionLength ( const G4Track &  aTrack, G4ForceCondition *  condition  )

inlinevirtual

Reimplemented from G4VDiscreteProcess.

Definition at line 89 of file XWrapperDiscreteProcess.hh.

                                                 {
        return fRegisteredProcess->AtRestGetPhysicalInteractionLength(aTrack,
               condition);
    };

Here is the call graph for this function:

BuildPhysicsTable()

void XWrapperDiscreteProcess::BuildPhysicsTable ( const G4ParticleDefinition &  aParticleDefinition )

virtual

Reimplemented from G4VProcess.

Definition at line 314 of file XWrapperDiscreteProcess.cc.

                                                                  {
    fRegisteredProcess->BuildPhysicsTable(aParticleDefinition);
}

Here is the call graph for this function:

Here is the caller graph for this function:

BuildWorkerPhysicsTable()

virtual void XWrapperDiscreteProcess::BuildWorkerPhysicsTable ( const G4ParticleDefinition &  aPD )

inlinevirtual

Reimplemented from G4VProcess.

Definition at line 130 of file XWrapperDiscreteProcess.hh.

        {fRegisteredProcess->BuildWorkerPhysicsTable(aPD);};

Here is the call graph for this function:

DumpInfo()

virtual void XWrapperDiscreteProcess::DumpInfo ( ) const

inlinevirtual

Reimplemented from G4VProcess.

Definition at line 123 of file XWrapperDiscreteProcess.hh.

{fRegisteredProcess->DumpInfo();};

Here is the call graph for this function:

EndTracking()

virtual void XWrapperDiscreteProcess::EndTracking ( )

inlinevirtual

Reimplemented from G4VProcess.

Definition at line 114 of file XWrapperDiscreteProcess.hh.

{fRegisteredProcess->EndTracking();};

Here is the call graph for this function:

GetDensity()

G4double XWrapperDiscreteProcess::GetDensity

(

const G4Track &

aTrack

)

Definition at line 149 of file XWrapperDiscreteProcess.cc.

                                                                 {
    //Retrieve nuclei and electron density
    //from ExExChParticleUserInfo object
    G4double vDensity = 1.;
    
    if(ItHasToWork(aTrack)){
        ExExChParticleUserInfo* chanInfo =
        (ExExChParticleUserInfo*) aTrack.GetUserInformation();
        
        if(chanInfo){
            if(bNucleiOrElectronFlag == +1){
                vDensity = chanInfo->GetNucleiDensity();
            }
            else if(bNucleiOrElectronFlag == -1){
                vDensity = chanInfo->GetElectronDensity();
            }
            else{
                vDensity = (chanInfo->GetNucleiDensity()
                            + chanInfo->GetElectronDensity())/2.;
            }
        }
    }
    
    return vDensity;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetDensityPreviousStep()

G4double XWrapperDiscreteProcess::GetDensityPreviousStep

(

const G4Track &

aTrack

)

Definition at line 178 of file XWrapperDiscreteProcess.cc.

                                             {
    //Retrieve nuclei and electron density
    //from ExExChParticleUserInfo object
    
    G4double vDensityPreviousStep = 1.;
    
    if(ItHasToWork(aTrack)){
        ExExChParticleUserInfo* chanInfo =
        (ExExChParticleUserInfo*) aTrack.GetUserInformation();

        if(bNucleiOrElectronFlag == +1){
            vDensityPreviousStep = chanInfo->GetNucleiDensityPreviousStep();
        }
        else if(bNucleiOrElectronFlag == -1){
            vDensityPreviousStep = chanInfo->GetElectronDensityPreviousStep();
        }
        else{
            vDensityPreviousStep =
            (chanInfo->GetNucleiDensityPreviousStep()
             + chanInfo->GetElectronDensityPreviousStep())/2.;
        }
    }
    
    return vDensityPreviousStep;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetMeanFreePath()

G4double XWrapperDiscreteProcess::GetMeanFreePath ( const G4Track &  , G4double  , G4ForceCondition *    )

protectedvirtual

Implements G4VDiscreteProcess.

Definition at line 231 of file XWrapperDiscreteProcess.cc.

                                                                    {
    return DBL_MAX;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetNucleiOrElectronFlag()

G4int XWrapperDiscreteProcess::GetNucleiOrElectronFlag

(

)

Definition at line 117 of file XWrapperDiscreteProcess.cc.

                                                      {
    return bNucleiOrElectronFlag;
}

GetProcessManager()

virtual const G4ProcessManager* XWrapperDiscreteProcess::GetProcessManager ( )

inlinevirtual

Reimplemented from G4VProcess.

Definition at line 118 of file XWrapperDiscreteProcess.hh.

            {return fRegisteredProcess->GetProcessManager();};

Here is the call graph for this function:

IsApplicable()

G4bool XWrapperDiscreteProcess::IsApplicable ( const G4ParticleDefinition &  aParticleDefinition )

virtual

Reimplemented from G4VProcess.

Definition at line 307 of file XWrapperDiscreteProcess.cc.

                                                             {
    return fRegisteredProcess->IsApplicable(aParticleDefinition);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ItHasToWork()

G4int XWrapperDiscreteProcess::ItHasToWork

(

const G4Track &

aTrack

)

Definition at line 123 of file XWrapperDiscreteProcess.cc.

                                                               {
    ExExChParticleUserInfo* chanInfo =
    (ExExChParticleUserInfo*) aTrack.GetUserInformation();
    
    if(chanInfo){
        if((chanInfo->GetInTheCrystal() == true) &&
           (bBothOrCrystalOrDetectorPhysics == 1 ||
            bBothOrCrystalOrDetectorPhysics == 0)){
            return 1;
        }
        if((chanInfo->GetInTheCrystal() == false) &&
           (bBothOrCrystalOrDetectorPhysics == 2 ||
            bBothOrCrystalOrDetectorPhysics == 0)){
            return 2;
        }
    }
    else {
        G4cout << G4endl << "XWrapperDiscreteProcess::";
        G4cout << "ERROR - no ExExChParticleUserInfo object Detected";
        G4cout << G4endl;
    }
    
    return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

XWrapperDiscreteProcess& XWrapperDiscreteProcess::operator= ( const XWrapperDiscreteProcess &  )

private

PostStepDoIt()

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

virtual

Reimplemented from G4VDiscreteProcess.

Definition at line 291 of file XWrapperDiscreteProcess.cc.

                                                                              {
    if(ItHasToWork(aTrack) == 1){
        return fRegisteredProcess->PostStepDoIt(aTrack, aStep);
    }
    else if(ItHasToWork(aTrack) == 2){
        return fRegisteredProcess->PostStepDoIt(aTrack, aStep);
    }
    pParticleChange = fParticleChangeForNothing;
    return pParticleChange;
}

Here is the call graph for this function:

PostStepGetPhysicalInteractionLength()

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

virtual

Reimplemented from G4VDiscreteProcess.

Definition at line 240 of file XWrapperDiscreteProcess.cc.

                                                                  {
    if(ItHasToWork(aTrack) == 1){
        G4double vDensity = GetDensity(aTrack);
        G4double vDensityPreviousStep = GetDensityPreviousStep(aTrack);
        
        if ( (previousStepSize < 0.0) ||
             (theNumberOfInteractionLengthLeft<=0.0)) {
            // beginning of tracking (or just after DoIt of this process)
            ResetNumberOfInteractionLengthLeft();
        } else if ( previousStepSize > 0.0) {
            // subtract NumberOfInteractionLengthLeft
            SubtractNumberOfInteractionLengthLeft(previousStepSize
                                                  * vDensityPreviousStep);
        } else {
            // zero step DO NOTHING
        }
        
        G4double regIntLength =
        fRegisteredProcess->PostStepGetPhysicalInteractionLength(aTrack,
                                       previousStepSize * vDensityPreviousStep,
                                       condition);
        G4double regIntNumber =
        fRegisteredProcess->GetNumberOfInteractionLengthLeft();
        if(regIntNumber!=0){
          currentInteractionLength = regIntLength / regIntNumber;
        }
        else{
          return DBL_MAX;
        }
        theNumberOfInteractionLengthLeft = regIntNumber;
        
        currentInteractionLength =
        theNumberOfInteractionLengthLeft * currentInteractionLength;
        if ( vDensity == 0. ) return DBL_MAX;
        currentInteractionLength /= vDensity;
        return currentInteractionLength;
    }
    else if(ItHasToWork(aTrack) == 2){
        return fRegisteredProcess->PostStepGetPhysicalInteractionLength(aTrack,
                                                     previousStepSize,
                                                     condition);
    }
    else{
        return DBL_MAX;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

PreparePhysicsTable()

void XWrapperDiscreteProcess::PreparePhysicsTable ( const G4ParticleDefinition &  aParticleDefinition )

virtual

Reimplemented from G4VProcess.

Definition at line 321 of file XWrapperDiscreteProcess.cc.

                                                                    {
    fRegisteredProcess->PreparePhysicsTable(aParticleDefinition);
}

Here is the call graph for this function:

Here is the caller graph for this function:

PrepareWorkerPhysicsTable()

virtual void XWrapperDiscreteProcess::PrepareWorkerPhysicsTable ( const G4ParticleDefinition &  aPD )

inlinevirtual

Reimplemented from G4VProcess.

Definition at line 132 of file XWrapperDiscreteProcess.hh.

        {fRegisteredProcess->PrepareWorkerPhysicsTable(aPD);};

Here is the call graph for this function:

RegisterProcess() [1/2]

void XWrapperDiscreteProcess::RegisterProcess

(

G4VDiscreteProcess *

toRegister

)

Definition at line 85 of file XWrapperDiscreteProcess.cc.

                                                                           {
    fRegisteredProcess = toRegister;
    theProcessType = fRegisteredProcess->GetProcessType();
    theProcessSubType = fRegisteredProcess->GetProcessSubType();
    enableAtRestDoIt = fRegisteredProcess->isAtRestDoItIsEnabled();
    enableAlongStepDoIt = fRegisteredProcess->isAlongStepDoItIsEnabled();
    enablePostStepDoIt = fRegisteredProcess->isPostStepDoItIsEnabled();
}

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterProcess() [2/2]

void XWrapperDiscreteProcess::RegisterProcess	(	G4VDiscreteProcess *	toRegister,
		G4int	flag,
		G4int	aBool = 0
	)

Definition at line 96 of file XWrapperDiscreteProcess.cc.

                                                           {
    fRegisteredProcess = toRegister;
    bNucleiOrElectronFlag = flag;
    bBothOrCrystalOrDetectorPhysics = region;
    theProcessType = fRegisteredProcess->GetProcessType();
    theProcessSubType = fRegisteredProcess->GetProcessSubType();
    enableAtRestDoIt = fRegisteredProcess->isAtRestDoItIsEnabled();
    enableAlongStepDoIt = fRegisteredProcess->isAlongStepDoItIsEnabled();
    enablePostStepDoIt = fRegisteredProcess->isPostStepDoItIsEnabled();
}

Here is the call graph for this function:

ResetNumberOfInteractionLengthLeft()

virtual void XWrapperDiscreteProcess::ResetNumberOfInteractionLengthLeft ( )

inlinevirtual

Reimplemented from G4VProcess.

Definition at line 120 of file XWrapperDiscreteProcess.hh.

            {fRegisteredProcess->ResetNumberOfInteractionLengthLeft();};

Here is the call graph for this function:

Here is the caller graph for this function:

RetrievePhysicsTable()

G4bool XWrapperDiscreteProcess::RetrievePhysicsTable ( const G4ParticleDefinition *  aParticleDefinition, const G4String &  aString, G4bool  aBool  )

virtual

Reimplemented from G4VProcess.

Definition at line 339 of file XWrapperDiscreteProcess.cc.

                                  {
    return fRegisteredProcess->RetrievePhysicsTable(aParticleDefinition,
                                                    aString,
                                                    aBool);
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetMasterProcess()

virtual void XWrapperDiscreteProcess::SetMasterProcess ( G4VProcess *  masterP )

inlinevirtual

Reimplemented from G4VProcess.

Definition at line 125 of file XWrapperDiscreteProcess.hh.

                                                      {
        fRegisteredProcess->SetMasterProcess(
           static_cast<XWrapperDiscreteProcess*>(masterP)->fRegisteredProcess
        );
    };

Here is the call graph for this function:

SetNucleiOrElectronFlag()

void XWrapperDiscreteProcess::SetNucleiOrElectronFlag

(

G4int

flag

)

Definition at line 111 of file XWrapperDiscreteProcess.cc.

                                                               {
    bNucleiOrElectronFlag = flag;
}

SetProcessManager()

virtual void XWrapperDiscreteProcess::SetProcessManager ( const G4ProcessManager *  aPM )

inlinevirtual

Reimplemented from G4VProcess.

Definition at line 116 of file XWrapperDiscreteProcess.hh.

            {fRegisteredProcess->SetProcessManager(aPM);};

Here is the call graph for this function:

StartTracking()

void XWrapperDiscreteProcess::StartTracking ( G4Track *  aTrack )

virtual

Reimplemented from G4VProcess.

Definition at line 222 of file XWrapperDiscreteProcess.cc.

                                                          {
    fRegisteredProcess->StartTracking(aTrack);
    currentInteractionLength = -1.0;
    theNumberOfInteractionLengthLeft = -1.0;
    theInitialNumberOfInteractionLength = -1.0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

StorePhysicsTable()

G4bool XWrapperDiscreteProcess::StorePhysicsTable ( const G4ParticleDefinition *  aParticleDefinition, const G4String &  aString, G4bool  aBool  )

virtual

Reimplemented from G4VProcess.

Definition at line 328 of file XWrapperDiscreteProcess.cc.

                               {
    return fRegisteredProcess->StorePhysicsTable(aParticleDefinition,
                                                 aString,
                                                 aBool);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

bBothOrCrystalOrDetectorPhysics

G4int XWrapperDiscreteProcess::bBothOrCrystalOrDetectorPhysics

private

Decide whether to use nuclei (+1) or electron (-1) or both (0)

Definition at line 68 of file XWrapperDiscreteProcess.hh.

bNucleiOrElectronFlag

G4int XWrapperDiscreteProcess::bNucleiOrElectronFlag

private

Definition at line 69 of file XWrapperDiscreteProcess.hh.

fParticleChangeForNothing

G4ParticleChangeForNothing* XWrapperDiscreteProcess::fParticleChangeForNothing

private

Definition at line 71 of file XWrapperDiscreteProcess.hh.

fRegisteredProcess

G4VDiscreteProcess* XWrapperDiscreteProcess::fRegisteredProcess

private

Definition at line 70 of file XWrapperDiscreteProcess.hh.

---

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

• XWrapperDiscreteProcess.hh
• XWrapperDiscreteProcess.cc