G4BOptnForceCommonTruncatedExp Class Reference

#include <G4BOptnForceCommonTruncatedExp.hh>

Inheritance diagram for G4BOptnForceCommonTruncatedExp:

Public Member Functions
void	AddCrossSection (const G4VProcess *, G4double)
virtual void	AlongMoveBy (const G4BiasingProcessInterface *, const G4Step *, G4double)
virtual G4VParticleChange *	ApplyFinalStateBiasing (const G4BiasingProcessInterface *, const G4Track *, const G4Step *, G4bool &)
void	ChooseProcessToApply ()
virtual G4double	DistanceToApplyOperation (const G4Track *, G4double, G4ForceCondition *)
	G4BOptnForceCommonTruncatedExp (G4String name)
virtual G4VParticleChange *	GenerateBiasingFinalState (const G4Track *, const G4Step *)
G4ILawCommonTruncatedExp *	GetCommonTruncatedExpLaw ()
G4ILawForceFreeFlight *	GetForceFreeFlightLaw ()
const G4ThreeVector &	GetInitialMomentum () const
G4bool	GetInteractionOccured () const
G4double	GetMaximumDistance () const
const G4String &	GetName () const
size_t	GetNumberOfSharing () const
const G4VProcess *	GetProcessToApply () const
std::size_t	GetUniqueID () const
void	Initialize (const G4Track *)
virtual G4double	ProposeAlongStepLimit (const G4BiasingProcessInterface *)
virtual G4GPILSelection	ProposeGPILSelection (const G4GPILSelection processSelection)
virtual const G4VBiasingInteractionLaw *	ProvideOccurenceBiasingInteractionLaw (const G4BiasingProcessInterface *, G4ForceCondition &)
void	Sample ()
void	SetInteractionOccured (G4bool b)
void	UpdateForStep (const G4Step *)
virtual	~G4BOptnForceCommonTruncatedExp ()

Private Attributes
G4ILawCommonTruncatedExp *	fCommonTruncatedExpLaw
std::map< const G4VProcess *, G4double >	fCrossSections
G4ParticleChangeForNothing	fDummyParticleChange
G4ILawForceFreeFlight *	fForceFreeFlightLaw
G4ThreeVector	fInitialMomentum
G4bool	fInteractionOccured
G4double	fMaximumDistance
const G4String	fName
size_t	fNumberOfSharing
const G4VProcess *	fProcessToApply
G4double	fTotalCrossSection
std::size_t	fUniqueID

Detailed Description

Definition at line 59 of file G4BOptnForceCommonTruncatedExp.hh.

Constructor & Destructor Documentation

G4BOptnForceCommonTruncatedExp()

G4BOptnForceCommonTruncatedExp::G4BOptnForceCommonTruncatedExp

(

G4String

name

)

Definition at line 34 of file G4BOptnForceCommonTruncatedExp.cc.

  : G4VBiasingOperation(name),
    fNumberOfSharing(0),
    fProcessToApply(nullptr),
    fInteractionOccured(false),
    fMaximumDistance(-1.0)
{
  fCommonTruncatedExpLaw = new G4ILawCommonTruncatedExp("ExpLawForOperation"+name);
  fForceFreeFlightLaw    = new G4ILawForceFreeFlight   ("FFFLawForOperation"+name);
  
  fTotalCrossSection = 0.0;
}

References fCommonTruncatedExpLaw, fForceFreeFlightLaw, fTotalCrossSection, and G4InuclParticleNames::name().

~G4BOptnForceCommonTruncatedExp()

G4BOptnForceCommonTruncatedExp::~G4BOptnForceCommonTruncatedExp ( )

virtual

Definition at line 47 of file G4BOptnForceCommonTruncatedExp.cc.

{
  if ( fCommonTruncatedExpLaw ) delete fCommonTruncatedExpLaw;
  if ( fForceFreeFlightLaw )    delete fForceFreeFlightLaw;
}

References fCommonTruncatedExpLaw, and fForceFreeFlightLaw.

Member Function Documentation

AddCrossSection()

void G4BOptnForceCommonTruncatedExp::AddCrossSection	(	const G4VProcess *	process,
		G4double	crossSection
	)

Definition at line 116 of file G4BOptnForceCommonTruncatedExp.cc.

{
  fTotalCrossSection      += crossSection;
  fCrossSections[process]  = crossSection;
  fNumberOfSharing         = fCrossSections.size();
}

References fCrossSections, fNumberOfSharing, and fTotalCrossSection.

Referenced by G4BOptrForceCollision::ProposeOccurenceBiasingOperation().

AlongMoveBy()

virtual void G4VBiasingOperation::AlongMoveBy ( const G4BiasingProcessInterface *  , const G4Step *  , G4double    )

inlinevirtualinherited

Reimplemented in G4BOptnForceFreeFlight.

Definition at line 139 of file G4VBiasingOperation.hh.

                                                                               {}

Referenced by G4BiasingProcessInterface::AlongStepDoIt().

ApplyFinalStateBiasing()

G4VParticleChange * G4BOptnForceCommonTruncatedExp::ApplyFinalStateBiasing ( const G4BiasingProcessInterface *  callingProcess, const G4Track *  track, const G4Step *  step, G4bool &  forceFinalState  )

virtual

Implements G4VBiasingOperation.

Definition at line 76 of file G4BOptnForceCommonTruncatedExp.cc.

{
  if ( callingProcess->GetWrappedProcess() != fProcessToApply )
    {
      forceFinalState = true;
      fDummyParticleChange.Initialize( *track );
      return &fDummyParticleChange; 
    }
  if ( fInteractionOccured )
    {
      forceFinalState = true;
      fDummyParticleChange.Initialize( *track );
      return &fDummyParticleChange;
    }
  
  // -- checks if process won the GPIL race:
  G4double processGPIL = callingProcess->GetPostStepGPIL() < callingProcess->GetAlongStepGPIL() ?
    callingProcess->GetPostStepGPIL() : callingProcess->GetAlongStepGPIL() ;
  if ( processGPIL <= step->GetStepLength() )
    {
      // -- if process won, wrapped process produces the final state.
      // -- In this case, the weight for occurrence biasing is applied
      // -- by the callingProcess, at exit of present method. This is
      // -- selected by "forceFinalState = false":
      forceFinalState     = false;
      fInteractionOccured = true;
      return callingProcess->GetWrappedProcess()->PostStepDoIt( *track, *step );
    }
  else
    {
      forceFinalState = true;
      fDummyParticleChange.Initialize( *track );
      return &fDummyParticleChange; 
    }
}

References fDummyParticleChange, fInteractionOccured, fProcessToApply, G4BiasingProcessInterface::GetAlongStepGPIL(), G4BiasingProcessInterface::GetPostStepGPIL(), G4BiasingProcessInterface::GetWrappedProcess(), G4ParticleChangeForNothing::Initialize(), and G4VProcess::PostStepDoIt().

ChooseProcessToApply()

void G4BOptnForceCommonTruncatedExp::ChooseProcessToApply

(

)

Definition at line 167 of file G4BOptnForceCommonTruncatedExp.cc.

{
  G4double sigmaRand   = G4UniformRand() * fTotalCrossSection;
  G4double sigmaSelect = 0.0;
  for ( std::map< const G4VProcess*, G4double>::const_iterator it = fCrossSections.begin();
    it != fCrossSections.end();
    it++)
    {
      sigmaSelect += (*it).second;
      if ( sigmaRand <= sigmaSelect )
    {
      fProcessToApply = (*it).first;
      break;
    }
    }
}

References fCrossSections, fProcessToApply, fTotalCrossSection, and G4UniformRand.

Referenced by Sample().

DistanceToApplyOperation()

virtual G4double G4BOptnForceCommonTruncatedExp::DistanceToApplyOperation ( const G4Track *  , G4double  , G4ForceCondition *    )

inlinevirtual

Implements G4VBiasingOperation.

Definition at line 78 of file G4BOptnForceCommonTruncatedExp.hh.

                                                           {return DBL_MAX;}

References DBL_MAX.

GenerateBiasingFinalState()

virtual G4VParticleChange * G4BOptnForceCommonTruncatedExp::GenerateBiasingFinalState ( const G4Track *  , const G4Step *    )

inlinevirtual

Implements G4VBiasingOperation.

Definition at line 81 of file G4BOptnForceCommonTruncatedExp.hh.

                                                           {return 0;}

GetCommonTruncatedExpLaw()

G4ILawCommonTruncatedExp * G4BOptnForceCommonTruncatedExp::GetCommonTruncatedExpLaw ( )

inline

Definition at line 88 of file G4BOptnForceCommonTruncatedExp.hh.

  {
    return fCommonTruncatedExpLaw;
  }

References fCommonTruncatedExpLaw.

GetForceFreeFlightLaw()

G4ILawForceFreeFlight * G4BOptnForceCommonTruncatedExp::GetForceFreeFlightLaw ( )

inline

Definition at line 92 of file G4BOptnForceCommonTruncatedExp.hh.

  {
    return fForceFreeFlightLaw;
  }

References fForceFreeFlightLaw.

GetInitialMomentum()

const G4ThreeVector & G4BOptnForceCommonTruncatedExp::GetInitialMomentum ( ) const

inline

Definition at line 100 of file G4BOptnForceCommonTruncatedExp.hh.

{ return fInitialMomentum; }

References fInitialMomentum.

Referenced by G4BOptrForceCollision::ProposeOccurenceBiasingOperation().

GetInteractionOccured()

G4bool G4BOptnForceCommonTruncatedExp::GetInteractionOccured ( ) const

inline

Definition at line 107 of file G4BOptnForceCommonTruncatedExp.hh.

{ return fInteractionOccured; }

References fInteractionOccured.

Referenced by G4BOptrForceCollision::OperationApplied().

GetMaximumDistance()

G4double G4BOptnForceCommonTruncatedExp::GetMaximumDistance ( ) const

inline

Definition at line 101 of file G4BOptnForceCommonTruncatedExp.hh.

{ return fMaximumDistance; }

References fMaximumDistance.

Referenced by G4BOptrForceCollision::ProposeOccurenceBiasingOperation().

GetName()

const G4String & G4VBiasingOperation::GetName ( ) const

inlineinherited

Definition at line 198 of file G4VBiasingOperation.hh.

{return fName;}

References G4VBiasingOperation::fName.

GetNumberOfSharing()

size_t G4BOptnForceCommonTruncatedExp::GetNumberOfSharing ( ) const

inline

Definition at line 105 of file G4BOptnForceCommonTruncatedExp.hh.

{ return fNumberOfSharing;}

References fNumberOfSharing.

Referenced by G4BOptrForceCollision::ProposeOccurenceBiasingOperation().

GetProcessToApply()

const G4VProcess * G4BOptnForceCommonTruncatedExp::GetProcessToApply ( ) const

inline

Definition at line 103 of file G4BOptnForceCommonTruncatedExp.hh.

{ return fProcessToApply; }

References fProcessToApply.

GetUniqueID()

std::size_t G4VBiasingOperation::GetUniqueID ( ) const

inlineinherited

Definition at line 199 of file G4VBiasingOperation.hh.

{return fUniqueID;}

References G4VBiasingOperation::fUniqueID.

Initialize()

void G4BOptnForceCommonTruncatedExp::Initialize

(

const G4Track *

track

)

Definition at line 124 of file G4BOptnForceCommonTruncatedExp.cc.

{
  fCrossSections.clear();
  fTotalCrossSection  = 0.0;
  fNumberOfSharing    = 0;
  fProcessToApply     = 0;
  fInteractionOccured = false;
  fInitialMomentum    = track->GetMomentum();
 
  G4VSolid* currentSolid = track->GetVolume()->GetLogicalVolume()->GetSolid();
  G4ThreeVector  localPosition = (G4TransportationManager::GetTransportationManager()->
                  GetNavigatorForTracking()->
                  GetGlobalToLocalTransform()).TransformPoint(track->GetPosition());
  G4ThreeVector localDirection = (G4TransportationManager::GetTransportationManager()->
                  GetNavigatorForTracking()->
                  GetGlobalToLocalTransform()).TransformAxis(track->GetMomentumDirection());
  fMaximumDistance = currentSolid->DistanceToOut(localPosition, localDirection);
  if ( fMaximumDistance <= DBL_MIN )  fMaximumDistance = 0.0;
  fCommonTruncatedExpLaw->SetMaximumDistance( fMaximumDistance );
}

References DBL_MIN, G4VSolid::DistanceToOut(), fCommonTruncatedExpLaw, fCrossSections, fInitialMomentum, fInteractionOccured, fMaximumDistance, fNumberOfSharing, fProcessToApply, fTotalCrossSection, G4VPhysicalVolume::GetLogicalVolume(), G4Track::GetMomentum(), G4Track::GetMomentumDirection(), G4Track::GetPosition(), G4LogicalVolume::GetSolid(), G4TransportationManager::GetTransportationManager(), G4Track::GetVolume(), and G4ILawCommonTruncatedExp::SetMaximumDistance().

Referenced by G4BOptrForceCollision::ProposeOccurenceBiasingOperation().

ProposeAlongStepLimit()

virtual G4double G4BOptnForceCommonTruncatedExp::ProposeAlongStepLimit ( const G4BiasingProcessInterface *  )

inlinevirtual

Reimplemented from G4VBiasingOperation.

Definition at line 71 of file G4BOptnForceCommonTruncatedExp.hh.

{ return DBL_MAX; }

References DBL_MAX.

ProposeGPILSelection()

G4GPILSelection G4BOptnForceCommonTruncatedExp::ProposeGPILSelection ( const G4GPILSelection  processSelection )

virtual

Reimplemented from G4VBiasingOperation.

Definition at line 70 of file G4BOptnForceCommonTruncatedExp.cc.

{
  return NotCandidateForSelection;
}

References NotCandidateForSelection.

ProvideOccurenceBiasingInteractionLaw()

const G4VBiasingInteractionLaw * G4BOptnForceCommonTruncatedExp::ProvideOccurenceBiasingInteractionLaw ( const G4BiasingProcessInterface *  callingProcess, G4ForceCondition &  proposeForceCondition  )

virtual

Implements G4VBiasingOperation.

Definition at line 53 of file G4BOptnForceCommonTruncatedExp.cc.

{
  if ( callingProcess->GetWrappedProcess() == fProcessToApply )
    {
      proposeForceCondition =                 Forced;
      return                  fCommonTruncatedExpLaw;
    }
  else
    {
      proposeForceCondition =                 Forced;
      return                     fForceFreeFlightLaw;
    }
}

References fCommonTruncatedExpLaw, fForceFreeFlightLaw, Forced, fProcessToApply, and G4BiasingProcessInterface::GetWrappedProcess().

Sample()

void G4BOptnForceCommonTruncatedExp::Sample

(

)

Definition at line 158 of file G4BOptnForceCommonTruncatedExp.cc.

{
  fCommonTruncatedExpLaw->SetForceCrossSection( fTotalCrossSection );
  fCommonTruncatedExpLaw->Sample();
  ChooseProcessToApply();
  fCommonTruncatedExpLaw->SetSelectedProcessXSfraction(fCrossSections[fProcessToApply] / fTotalCrossSection);
}

References ChooseProcessToApply(), fCommonTruncatedExpLaw, fCrossSections, fProcessToApply, fTotalCrossSection, G4VBiasingInteractionLaw::Sample(), G4ILawCommonTruncatedExp::SetForceCrossSection(), and G4ILawCommonTruncatedExp::SetSelectedProcessXSfraction().

Referenced by G4BOptrForceCollision::ProposeOccurenceBiasingOperation().

SetInteractionOccured()

void G4BOptnForceCommonTruncatedExp::SetInteractionOccured ( G4bool  b )

inline

Definition at line 106 of file G4BOptnForceCommonTruncatedExp.hh.

{ fInteractionOccured = b;    }

References fInteractionOccured.

UpdateForStep()

void G4BOptnForceCommonTruncatedExp::UpdateForStep

(

const G4Step *

step

)

Definition at line 146 of file G4BOptnForceCommonTruncatedExp.cc.

{
  fCrossSections.clear();
  fTotalCrossSection  = 0.0;
  fNumberOfSharing    = 0;
  fProcessToApply     = 0;
  
  fCommonTruncatedExpLaw->UpdateForStep( step->GetStepLength() );
  fMaximumDistance = fCommonTruncatedExpLaw->GetMaximumDistance();
}

References fCommonTruncatedExpLaw, fCrossSections, fMaximumDistance, fNumberOfSharing, fProcessToApply, fTotalCrossSection, G4ILawCommonTruncatedExp::GetMaximumDistance(), G4Step::GetStepLength(), and G4VBiasingInteractionLaw::UpdateForStep().

Referenced by G4BOptrForceCollision::ProposeOccurenceBiasingOperation().

Field Documentation

fCommonTruncatedExpLaw

G4ILawCommonTruncatedExp* G4BOptnForceCommonTruncatedExp::fCommonTruncatedExpLaw

private

Definition at line 110 of file G4BOptnForceCommonTruncatedExp.hh.

Referenced by G4BOptnForceCommonTruncatedExp(), GetCommonTruncatedExpLaw(), Initialize(), ProvideOccurenceBiasingInteractionLaw(), Sample(), UpdateForStep(), and ~G4BOptnForceCommonTruncatedExp().

fCrossSections

std::map< const G4VProcess*, G4double > G4BOptnForceCommonTruncatedExp::fCrossSections

private

Definition at line 113 of file G4BOptnForceCommonTruncatedExp.hh.

Referenced by AddCrossSection(), ChooseProcessToApply(), Initialize(), Sample(), and UpdateForStep().

fDummyParticleChange

G4ParticleChangeForNothing G4BOptnForceCommonTruncatedExp::fDummyParticleChange

private

Definition at line 119 of file G4BOptnForceCommonTruncatedExp.hh.

Referenced by ApplyFinalStateBiasing().

fForceFreeFlightLaw

G4ILawForceFreeFlight* G4BOptnForceCommonTruncatedExp::fForceFreeFlightLaw

private

Definition at line 111 of file G4BOptnForceCommonTruncatedExp.hh.

Referenced by G4BOptnForceCommonTruncatedExp(), GetForceFreeFlightLaw(), ProvideOccurenceBiasingInteractionLaw(), and ~G4BOptnForceCommonTruncatedExp().

fInitialMomentum

G4ThreeVector G4BOptnForceCommonTruncatedExp::fInitialMomentum

private

Definition at line 117 of file G4BOptnForceCommonTruncatedExp.hh.

Referenced by GetInitialMomentum(), and Initialize().

fInteractionOccured

G4bool G4BOptnForceCommonTruncatedExp::fInteractionOccured

private

Definition at line 116 of file G4BOptnForceCommonTruncatedExp.hh.

Referenced by ApplyFinalStateBiasing(), GetInteractionOccured(), Initialize(), and SetInteractionOccured().

fMaximumDistance

G4double G4BOptnForceCommonTruncatedExp::fMaximumDistance

private

Definition at line 118 of file G4BOptnForceCommonTruncatedExp.hh.

Referenced by GetMaximumDistance(), Initialize(), and UpdateForStep().

fName

const G4String G4VBiasingOperation::fName

privateinherited

Definition at line 203 of file G4VBiasingOperation.hh.

Referenced by G4VBiasingOperation::GetName().

fNumberOfSharing

size_t G4BOptnForceCommonTruncatedExp::fNumberOfSharing

private

Definition at line 114 of file G4BOptnForceCommonTruncatedExp.hh.

Referenced by AddCrossSection(), GetNumberOfSharing(), Initialize(), and UpdateForStep().

fProcessToApply

const G4VProcess* G4BOptnForceCommonTruncatedExp::fProcessToApply

private

Definition at line 115 of file G4BOptnForceCommonTruncatedExp.hh.

Referenced by ApplyFinalStateBiasing(), ChooseProcessToApply(), GetProcessToApply(), Initialize(), ProvideOccurenceBiasingInteractionLaw(), Sample(), and UpdateForStep().

fTotalCrossSection

G4double G4BOptnForceCommonTruncatedExp::fTotalCrossSection

private

Definition at line 112 of file G4BOptnForceCommonTruncatedExp.hh.

Referenced by AddCrossSection(), ChooseProcessToApply(), G4BOptnForceCommonTruncatedExp(), Initialize(), Sample(), and UpdateForStep().

fUniqueID

std::size_t G4VBiasingOperation::fUniqueID

privateinherited

Definition at line 205 of file G4VBiasingOperation.hh.

Referenced by G4VBiasingOperation::G4VBiasingOperation(), and G4VBiasingOperation::GetUniqueID().

---

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

• source/processes/biasing/generic/include/G4BOptnForceCommonTruncatedExp.hh
• source/processes/biasing/generic/src/G4BOptnForceCommonTruncatedExp.cc