G4BOptnForceCommonTruncatedExp Class Reference

#include <G4BOptnForceCommonTruncatedExp.hh>

Inheritance diagram for G4BOptnForceCommonTruncatedExp:

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

Detailed Description

Definition at line 56 of file G4BOptnForceCommonTruncatedExp.hh.

Constructor & Destructor Documentation

G4BOptnForceCommonTruncatedExp()

G4BOptnForceCommonTruncatedExp::G4BOptnForceCommonTruncatedExp

(

const G4String &

name

)

Definition at line 36 of file G4BOptnForceCommonTruncatedExp.cc.

  : G4VBiasingOperation(name)
{
  fCommonTruncatedExpLaw = new G4ILawCommonTruncatedExp("ExpLawForOperation"+name);
  fForceFreeFlightLaw    = new G4ILawForceFreeFlight   ("FFFLawForOperation"+name);
}

~G4BOptnForceCommonTruncatedExp()

G4BOptnForceCommonTruncatedExp::~G4BOptnForceCommonTruncatedExp ( )

virtual

Definition at line 44 of file G4BOptnForceCommonTruncatedExp.cc.

{
  delete fCommonTruncatedExpLaw;
  delete fForceFreeFlightLaw;
}

Member Function Documentation

AddCrossSection()

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

Definition at line 114 of file G4BOptnForceCommonTruncatedExp.cc.

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

ApplyFinalStateBiasing()

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

virtual

Implements G4VBiasingOperation.

Definition at line 72 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; 
  }
}

ChooseProcessToApply()

void G4BOptnForceCommonTruncatedExp::ChooseProcessToApply

(

)

Definition at line 162 of file G4BOptnForceCommonTruncatedExp.cc.

{
  G4double sigmaRand   = G4UniformRand() * fTotalCrossSection;
  G4double sigmaSelect = 0.0;
  for ( auto it = fCrossSections.cbegin(); it != fCrossSections.cend(); ++it)
  {
    sigmaSelect += (*it).second;
    if ( sigmaRand <= sigmaSelect )
    {
      fProcessToApply = (*it).first;
      break;
    }
  }
}

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; }

GenerateBiasingFinalState()

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

inlinevirtual

Implements G4VBiasingOperation.

Definition at line 81 of file G4BOptnForceCommonTruncatedExp.hh.

{ return nullptr; }

GetCommonTruncatedExpLaw()

G4ILawCommonTruncatedExp * G4BOptnForceCommonTruncatedExp::GetCommonTruncatedExpLaw ( )

inline

Definition at line 86 of file G4BOptnForceCommonTruncatedExp.hh.

    {
      return fCommonTruncatedExpLaw;
    }

GetForceFreeFlightLaw()

G4ILawForceFreeFlight * G4BOptnForceCommonTruncatedExp::GetForceFreeFlightLaw ( )

inline

Definition at line 90 of file G4BOptnForceCommonTruncatedExp.hh.

    {
      return fForceFreeFlightLaw;
    }

GetInitialMomentum()

const G4ThreeVector & G4BOptnForceCommonTruncatedExp::GetInitialMomentum ( ) const

inline

Definition at line 98 of file G4BOptnForceCommonTruncatedExp.hh.

{ return fInitialMomentum; }

GetInteractionOccured()

G4bool G4BOptnForceCommonTruncatedExp::GetInteractionOccured ( ) const

inline

Definition at line 105 of file G4BOptnForceCommonTruncatedExp.hh.

{ return fInteractionOccured; }

GetMaximumDistance()

G4double G4BOptnForceCommonTruncatedExp::GetMaximumDistance ( ) const

inline

Definition at line 99 of file G4BOptnForceCommonTruncatedExp.hh.

{ return fMaximumDistance; }

GetNumberOfSharing()

std::size_t G4BOptnForceCommonTruncatedExp::GetNumberOfSharing ( ) const

inline

Definition at line 103 of file G4BOptnForceCommonTruncatedExp.hh.

{ return fNumberOfSharing; }

GetProcessToApply()

const G4VProcess * G4BOptnForceCommonTruncatedExp::GetProcessToApply ( ) const

inline

Definition at line 101 of file G4BOptnForceCommonTruncatedExp.hh.

{ return fProcessToApply; }

Initialize()

void G4BOptnForceCommonTruncatedExp::Initialize

(

const G4Track *

track

)

Definition at line 122 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 );
}

ProposeAlongStepLimit()

virtual G4double G4BOptnForceCommonTruncatedExp::ProposeAlongStepLimit ( const G4BiasingProcessInterface * )

inlinevirtual

Reimplemented from G4VBiasingOperation.

Definition at line 70 of file G4BOptnForceCommonTruncatedExp.hh.

{ return DBL_MAX; }

ProposeGPILSelection()

G4GPILSelection G4BOptnForceCommonTruncatedExp::ProposeGPILSelection ( const G4GPILSelection processSelection )

virtual

Reimplemented from G4VBiasingOperation.

Definition at line 66 of file G4BOptnForceCommonTruncatedExp.cc.

{
  return NotCandidateForSelection;
}

ProvideOccurenceBiasingInteractionLaw()

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

virtual

Implements G4VBiasingOperation.

Definition at line 50 of file G4BOptnForceCommonTruncatedExp.cc.

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

Sample()

void G4BOptnForceCommonTruncatedExp::Sample

(

)

Definition at line 154 of file G4BOptnForceCommonTruncatedExp.cc.

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

SetInteractionOccured()

void G4BOptnForceCommonTruncatedExp::SetInteractionOccured ( G4bool b )

inline

Definition at line 104 of file G4BOptnForceCommonTruncatedExp.hh.

{ fInteractionOccured = b; }

UpdateForStep()

void G4BOptnForceCommonTruncatedExp::UpdateForStep

(

const G4Step *

step

)

Definition at line 143 of file G4BOptnForceCommonTruncatedExp.cc.

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

---

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

• G4BOptnForceCommonTruncatedExp.hh
• G4BOptnForceCommonTruncatedExp.cc