G4DNASecondOrderReaction Class Reference

#include <G4DNASecondOrderReaction.hh>

Inheritance diagram for G4DNASecondOrderReaction:

Classes
struct	SecondOrderReactionState

Public Member Functions
	G4DNASecondOrderReaction (const G4String &aName="DNASecondOrderReaction", G4ProcessType type=fDecay)
	~G4DNASecondOrderReaction () override
	G4DNASecondOrderReaction (const G4DNASecondOrderReaction &)
G4DNASecondOrderReaction &	operator= (const G4DNASecondOrderReaction &)
void	StartTracking (G4Track *) override
void	SetReaction (const G4MolecularConfiguration *, const G4Material *, double)
void	BuildPhysicsTable (const G4ParticleDefinition &) override
G4double	PostStepGetPhysicalInteractionLength (const G4Track &track, G4double previousStepSize, G4ForceCondition *condition) override
G4VParticleChange *	PostStepDoIt (const G4Track &, const G4Step &) override
G4double	AtRestGetPhysicalInteractionLength (const G4Track &, G4ForceCondition *) override
G4VParticleChange *	AtRestDoIt (const G4Track &, const G4Step &) override
G4double	AlongStepGetPhysicalInteractionLength (const G4Track &, G4double, G4double, G4double &, G4GPILSelection *) override
G4VParticleChange *	AlongStepDoIt (const G4Track &, const G4Step &) override
Public Member Functions inherited from G4VITProcess
	G4VITProcess (const G4String &name, G4ProcessType type=fNotDefined)
	~G4VITProcess () override
	G4VITProcess (const G4VITProcess &other)
G4VITProcess &	operator= (const G4VITProcess &other)
G4bool	operator== (const G4VITProcess &right) const
G4bool	operator!= (const G4VITProcess &right) const
size_t	GetProcessID () const
G4shared_ptr< G4ProcessState_Lock >	GetProcessState ()
void	SetProcessState (G4shared_ptr< G4ProcessState_Lock > aProcInfo)
void	ResetProcessState ()
void	StartTracking (G4Track *) override
void	BuildPhysicsTable (const G4ParticleDefinition &) override
G4double	GetInteractionTimeLeft ()
void	ResetNumberOfInteractionLengthLeft () override
G4bool	ProposesTimeStep () const
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	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 ()
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 &)

Protected Attributes
G4bool	fIsInitialized
G4double	fReturnedValue
const std::vector< double > *	fpMoleculeDensity
G4double	fReactionRate
G4double	fConcentration
G4double	fMolarMassOfMaterial
G4ParticleChange	fParticleChange
const G4MolecularConfiguration *	fpMolecularConfiguration
const G4Material *	fpMaterial
Protected Attributes inherited from G4VITProcess
G4shared_ptr< G4ProcessState >	fpState
G4bool	fProposesTimeStep
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

Additional Inherited Members
Static Public Member Functions inherited from G4VITProcess
static const size_t &	GetMaxProcessIndex ()
Static Public Member Functions inherited from G4VProcess
static const G4String &	GetProcessTypeName (G4ProcessType)
Protected Member Functions inherited from G4VITProcess
void	RetrieveProcessInfo ()
void	CreateInfo ()
template<typename T>
T *	GetState ()
virtual void	SubtractNumberOfInteractionLengthLeft (G4double previousStepSize)
virtual void	ClearInteractionTimeLeft ()
virtual void	ClearNumberOfInteractionLengthLeft ()
void	SetInstantiateProcessState (G4bool flag)
G4bool	InstantiateProcessState ()
Protected Member Functions inherited from G4VProcess
void	SubtractNumberOfInteractionLengthLeft (G4double prevStepSize)
void	ClearNumberOfInteractionLengthLeft ()

Detailed Description

Definition at line 54 of file G4DNASecondOrderReaction.hh.

Constructor & Destructor Documentation

G4DNASecondOrderReaction() [1/2]

G4DNASecondOrderReaction::G4DNASecondOrderReaction	(	const G4String &	aName = "DNASecondOrderReaction",
		G4ProcessType	type = fDecay )

Definition at line 71 of file G4DNASecondOrderReaction.cc.

                                                                                            :
        G4VITProcess(aName,type)
{
  Create();
}

Referenced by G4DNASecondOrderReaction(), operator=(), and ~G4DNASecondOrderReaction().

~G4DNASecondOrderReaction()

G4DNASecondOrderReaction::~G4DNASecondOrderReaction ( )

overridedefault

G4DNASecondOrderReaction() [2/2]

G4DNASecondOrderReaction::G4DNASecondOrderReaction

(

const G4DNASecondOrderReaction &

rhs

)

Definition at line 77 of file G4DNASecondOrderReaction.cc.

                                                                                     :
        G4VITProcess(rhs)
{
  Create();
}

Member Function Documentation

AlongStepDoIt()

G4VParticleChange * G4DNASecondOrderReaction::AlongStepDoIt ( const G4Track & , const G4Step &  )

inlineoverridevirtual

Implements G4VProcess.

Definition at line 102 of file G4DNASecondOrderReaction.hh.

                                     {return nullptr;}

AlongStepGetPhysicalInteractionLength()

G4double G4DNASecondOrderReaction::AlongStepGetPhysicalInteractionLength ( const G4Track & , G4double , G4double , G4double & , G4GPILSelection *  )

inlineoverridevirtual

Implements G4VProcess.

Definition at line 93 of file G4DNASecondOrderReaction.hh.

                                    { return -1.0; }

AtRestDoIt()

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

inlineoverridevirtual

Implements G4VProcess.

Definition at line 87 of file G4DNASecondOrderReaction.hh.

                        {return nullptr;}

AtRestGetPhysicalInteractionLength()

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

inlineoverridevirtual

Implements G4VProcess.

Definition at line 82 of file G4DNASecondOrderReaction.hh.

                        { return -1.0; }

BuildPhysicsTable()

void G4DNASecondOrderReaction::BuildPhysicsTable ( const G4ParticleDefinition & )

overridevirtual

Reimplemented from G4VProcess.

Definition at line 100 of file G4DNASecondOrderReaction.cc.

{
  fpMoleculeDensity = G4DNAMolecularMaterial::Instance()->GetNumMolPerVolTableFor(fpMaterial);
  fMolarMassOfMaterial = fpMaterial->GetMassOfMolecule()*CLHEP::Avogadro*1e3;
  fIsInitialized = true;
}

operator=()

G4DNASecondOrderReaction & G4DNASecondOrderReaction::operator=

(

const G4DNASecondOrderReaction &

rhs

)

Definition at line 86 of file G4DNASecondOrderReaction.cc.

{
  if (this == &rhs) return *this; // handle self assignment
 
  //assignment operator
  return *this;
}

PostStepDoIt()

G4VParticleChange * G4DNASecondOrderReaction::PostStepDoIt ( const G4Track & track, const G4Step &  )

overridevirtual

Implements G4VProcess.

Definition at line 247 of file G4DNASecondOrderReaction.cc.

{
  G4Molecule* molecule = GetMolecule(track);
#ifdef G4VERBOSE
  if(verboseLevel > 1)
  {
    G4cout << "___________" << G4endl;
    G4cout << ">>> Beginning of G4DNASecondOrderReaction verbose" << G4endl;
    G4cout << ">>> Returned value : " << G4BestUnit(fReturnedValue,"Time") << G4endl;
    G4cout << ">>> Time Step : " << G4BestUnit(G4VScheduler::Instance()->GetTimeStep(),"Time") << G4endl;
    G4cout << ">>> Reaction : " << molecule->GetName() << " + " << fpMaterial->GetName() << G4endl;
    G4cout << ">>> End of G4DNASecondOrderReaction verbose <<<" << G4endl;
  }
#endif
  fReturnedValue  = DBL_MAX;
  fParticleChange.Initialize(track);
  fParticleChange.ProposeTrackStatus(fStopAndKill);
  G4DNADamage::Instance()->AddIndirectDamage(fpMaterial->GetName(),molecule,track.GetPosition(),track.GetGlobalTime());
  State(fPreviousTimeAtPreStepPoint) = -1;
  return &fParticleChange;
}

PostStepGetPhysicalInteractionLength()

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

overridevirtual

Implements G4VProcess.

Definition at line 132 of file G4DNASecondOrderReaction.cc.

{
  //    G4cout << "G4DNASecondOrderReaction::PostStepGetPhysicalInteractionLength" << G4endl;
  //    G4cout << "For reaction : " << fpMaterial->GetName() << " + " << fpMolecularConfiguration->GetName() << G4endl;
 
  //_______________________________________________________________________
  // Check whether the track is in the good material (maybe composite material)
  const G4Material* material = track.GetMaterial();
 
  G4Molecule* mol = GetMolecule(track);
  if(mol == nullptr) return DBL_MAX;
  if(mol->GetMolecularConfiguration() != fpMolecularConfiguration)
  {
    //        G4cout <<"mol->GetMolecularConfiguration() != fpMolecularConfiguration" << G4endl;
    return DBL_MAX;
  }
 
  G4double molDensity = (*fpMoleculeDensity)[material->GetIndex()];
 
  if(molDensity == 0.0) // ie : not found
  {
    if(State(fIsInGoodMaterial))
    {
      ResetNumberOfInteractionLengthLeft();
      //State(fPreviousTimeAtPreStepPoint) = -1;
      State(fIsInGoodMaterial) = false;
    }
 
    // G4cout << " Material " << fpMaterial->GetName() << " not found "
    //        <<" | name of current material : " << material->GetName()
    //        << G4endl;
 
    return DBL_MAX; // Becareful return here !!
  }
 
  //    G4cout << " Va calculer le temps d'interaction " << G4endl;
 
  State(fIsInGoodMaterial) = true;
 
  //  fConcentration = molDensity/fMolarMassOfMaterial;
  fConcentration = molDensity/CLHEP::Avogadro;
  // G4cout << "Concentration : " << fConcentration / (g/mole)<< G4endl;
 
  //_______________________________________________________________________
  // Either initialize the lapse of time left
  // meaning
  // => the track enters for the first time in the material
  // or substract the previous time step to the previously calculated lapse
  // of time left
  // meaning
  // => the track has not left this material since the previous call
  G4double previousTimeStep(-1.);
 
  if(State(fPreviousTimeAtPreStepPoint) != -1)
  {
    previousTimeStep = track.GetGlobalTime() -
        State(fPreviousTimeAtPreStepPoint) ;
  }
 
  State(fPreviousTimeAtPreStepPoint) = track.GetGlobalTime();
 
  // condition is set to "Not Forced"
  *pForceCond = NotForced;
 
  if (
      (previousTimeStep < 0.0) ||
      (fpState->theNumberOfInteractionLengthLeft<=0.0)) {
    // beggining of tracking (or just after DoIt of this process)
    ResetNumberOfInteractionLengthLeft();
  } else if ( previousTimeStep  > 0.0) {
    // get mean free path
    // subtract NumberOfInteractionLengthLeft
    SubtractNumberOfInteractionLengthLeft( previousTimeStep );
  } else {
    // zero time step
    //  Force trigerring the process
    //*pForceCond = Forced;
  }
 
  fpState->currentInteractionLength = 1/(fReactionRate*fConcentration);
 
  //    G4cout << "fpState->currentInteractionLength = "
  //        <<  fpState->currentInteractionLength << G4endl;
 
  G4double value;
  if (fpState->currentInteractionLength <DBL_MAX) {
    value = fpState->theNumberOfInteractionLengthLeft
        * (fpState->currentInteractionLength);
  } else {
    value = DBL_MAX;
  }
#ifdef G4VERBOSE
  if (verboseLevel>2) {
    G4cout << "G4VITRestDiscreteProcess::PostStepGetPhysicalInteractionLength ";
    G4cout << "[ " << GetProcessName() << "]" <<G4endl;
    track.GetDynamicParticle()->DumpInfo();
    G4cout << " in Material  " <<  track.GetMaterial()->GetName() <<G4endl;
    G4cout << "InteractionLength= " << value/cm <<"[cm] " <<G4endl;
  }
#endif
 
//  G4cout << "currentInteractionLength : " << fpState->currentInteractionLength << G4endl;
//  G4cout << "Material : " << fpMaterial->GetName()
//      << "ID: " << track.GetTrackID()
//      << " Returned time : " << G4BestUnit(value,"Time") << G4endl;
 
  if(value < fReturnedValue)
    fReturnedValue  = value;
 
  return value*-1;
  // multiple by -1 to indicate to the tracking system that we are returning a time
}

SetReaction()

void G4DNASecondOrderReaction::SetReaction	(	const G4MolecularConfiguration *	molConf,
		const G4Material *	mat,
		double	reactionRate )

Definition at line 116 of file G4DNASecondOrderReaction.cc.

{
  if(fIsInitialized)
  {
    G4ExceptionDescription exceptionDescription ;
    exceptionDescription << "G4DNASecondOrderReaction was already initialised. ";
    exceptionDescription << "You cannot set a reaction after initialisation.";
    G4Exception("G4DNASecondOrderReaction::SetReaction","G4DNASecondOrderReaction001",
                FatalErrorInArgument,exceptionDescription);
  }
  fpMolecularConfiguration = molConf;
  fpMaterial = mat;
  fReactionRate = reactionRate;
}

StartTracking()

void G4DNASecondOrderReaction::StartTracking ( G4Track * track )

overridevirtual

Reimplemented from G4VProcess.

Definition at line 108 of file G4DNASecondOrderReaction.cc.

{
  G4VProcess::StartTracking(track);
  G4VITProcess::fpState = std::make_shared<SecondOrderReactionState>();
  G4VITProcess::StartTracking(track);
}

Member Data Documentation

fConcentration

G4double G4DNASecondOrderReaction::fConcentration

protected

Definition at line 126 of file G4DNASecondOrderReaction.hh.

Referenced by PostStepGetPhysicalInteractionLength().

fIsInitialized

G4bool G4DNASecondOrderReaction::fIsInitialized

protected

Definition at line 120 of file G4DNASecondOrderReaction.hh.

Referenced by BuildPhysicsTable(), and SetReaction().

fMolarMassOfMaterial

G4double G4DNASecondOrderReaction::fMolarMassOfMaterial

protected

Definition at line 127 of file G4DNASecondOrderReaction.hh.

Referenced by BuildPhysicsTable().

fParticleChange

G4ParticleChange G4DNASecondOrderReaction::fParticleChange

protected

Definition at line 128 of file G4DNASecondOrderReaction.hh.

Referenced by PostStepDoIt().

fpMaterial

const G4Material* G4DNASecondOrderReaction::fpMaterial

protected

Definition at line 131 of file G4DNASecondOrderReaction.hh.

Referenced by BuildPhysicsTable(), PostStepDoIt(), and SetReaction().

fpMolecularConfiguration

const G4MolecularConfiguration* G4DNASecondOrderReaction::fpMolecularConfiguration

protected

Definition at line 130 of file G4DNASecondOrderReaction.hh.

Referenced by PostStepGetPhysicalInteractionLength(), and SetReaction().

fpMoleculeDensity

const std::vector<double>* G4DNASecondOrderReaction::fpMoleculeDensity

protected

Definition at line 124 of file G4DNASecondOrderReaction.hh.

Referenced by BuildPhysicsTable().

fReactionRate

G4double G4DNASecondOrderReaction::fReactionRate

protected

Definition at line 125 of file G4DNASecondOrderReaction.hh.

Referenced by PostStepGetPhysicalInteractionLength(), and SetReaction().

fReturnedValue

G4double G4DNASecondOrderReaction::fReturnedValue

protected

Definition at line 122 of file G4DNASecondOrderReaction.hh.

Referenced by PostStepDoIt(), and PostStepGetPhysicalInteractionLength().

---

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

• G4DNASecondOrderReaction.hh
• G4DNASecondOrderReaction.cc