G4BOptnForceCommonTruncatedExp Class Reference

#include <G4BOptnForceCommonTruncatedExp.hh>

Inheritance diagram for G4BOptnForceCommonTruncatedExp:

Collaboration diagram for G4BOptnForceCommonTruncatedExp:

Public Member Functions
	G4BOptnForceCommonTruncatedExp (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)
size_t	GetNumberOfSharing () const
void	SetInteractionOccured (G4bool b)
G4bool	GetInteractionOccured () const
Public Member Functions inherited from G4VBiasingOperation
	G4VBiasingOperation (G4String name)
virtual	~G4VBiasingOperation ()
virtual void	AlongMoveBy (const G4BiasingProcessInterface *, const G4Step *, G4double)
const G4String &	GetName () const
std::size_t	GetUniqueID () const

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

Detailed Description

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

~G4BOptnForceCommonTruncatedExp()

G4BOptnForceCommonTruncatedExp::~G4BOptnForceCommonTruncatedExp ( )

virtual

Definition at line 47 of file G4BOptnForceCommonTruncatedExp.cc.

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

Here is the call graph for this function:

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

Here is the caller graph for this function:

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

Here is the caller graph for this function:

DistanceToApplyOperation()

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

inlinevirtual

Implements G4VBiasingOperation.

Definition at line 79 of file G4BOptnForceCommonTruncatedExp.hh.

                                                           {return DBL_MAX;}

GenerateBiasingFinalState()

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

inlinevirtual

Implements G4VBiasingOperation.

Definition at line 82 of file G4BOptnForceCommonTruncatedExp.hh.

                                                           {return 0;}

GetCommonTruncatedExpLaw()

G4ILawCommonTruncatedExp* G4BOptnForceCommonTruncatedExp::GetCommonTruncatedExpLaw ( )

inline

Definition at line 89 of file G4BOptnForceCommonTruncatedExp.hh.

  {
    return fCommonTruncatedExpLaw;
  }

GetForceFreeFlightLaw()

G4ILawForceFreeFlight* G4BOptnForceCommonTruncatedExp::GetForceFreeFlightLaw ( )

inline

Definition at line 93 of file G4BOptnForceCommonTruncatedExp.hh.

  {
    return fForceFreeFlightLaw;
  }

Here is the call graph for this function:

GetInitialMomentum()

const G4ThreeVector& G4BOptnForceCommonTruncatedExp::GetInitialMomentum ( ) const

inline

Definition at line 101 of file G4BOptnForceCommonTruncatedExp.hh.

{ return fInitialMomentum; }

Here is the caller graph for this function:

GetInteractionOccured()

G4bool G4BOptnForceCommonTruncatedExp::GetInteractionOccured ( ) const

inline

Definition at line 108 of file G4BOptnForceCommonTruncatedExp.hh.

{ return fInteractionOccured; }

Here is the caller graph for this function:

GetMaximumDistance()

G4double G4BOptnForceCommonTruncatedExp::GetMaximumDistance ( ) const

inline

Definition at line 102 of file G4BOptnForceCommonTruncatedExp.hh.

{ return fMaximumDistance; }

Here is the call graph for this function:

Here is the caller graph for this function:

GetNumberOfSharing()

size_t G4BOptnForceCommonTruncatedExp::GetNumberOfSharing ( ) const

inline

Definition at line 106 of file G4BOptnForceCommonTruncatedExp.hh.

{ return fNumberOfSharing;}

Here is the caller graph for this function:

GetProcessToApply()

const G4VProcess* G4BOptnForceCommonTruncatedExp::GetProcessToApply ( ) const

inline

Definition at line 104 of file G4BOptnForceCommonTruncatedExp.hh.

{ return fProcessToApply; }

Here is the call graph for this function:

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

Here is the call graph for this function:

Here is the caller graph for this function:

ProposeAlongStepLimit()

virtual G4double G4BOptnForceCommonTruncatedExp::ProposeAlongStepLimit ( const G4BiasingProcessInterface *  )

inlinevirtual

Reimplemented from G4VBiasingOperation.

Definition at line 72 of file G4BOptnForceCommonTruncatedExp.hh.

{ return DBL_MAX; }

Here is the call graph for this function:

ProposeGPILSelection()

G4GPILSelection G4BOptnForceCommonTruncatedExp::ProposeGPILSelection ( const G4GPILSelection  processSelection )

virtual

Reimplemented from G4VBiasingOperation.

Definition at line 70 of file G4BOptnForceCommonTruncatedExp.cc.

{
  return NotCandidateForSelection;
}

Here is the caller graph for this function:

ProvideOccurenceBiasingInteractionLaw()

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

virtual

Implements G4VBiasingOperation.

Definition at line 54 of file G4BOptnForceCommonTruncatedExp.cc.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Sample()

void G4BOptnForceCommonTruncatedExp::Sample

(

)

Definition at line 158 of file G4BOptnForceCommonTruncatedExp.cc.

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

Here is the call graph for this function:

Here is the caller graph for this function:

SetInteractionOccured()

void G4BOptnForceCommonTruncatedExp::SetInteractionOccured ( G4bool  b )

inline

Definition at line 107 of file G4BOptnForceCommonTruncatedExp.hh.

{ fInteractionOccured = b;    }

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

fCommonTruncatedExpLaw

G4ILawCommonTruncatedExp* G4BOptnForceCommonTruncatedExp::fCommonTruncatedExpLaw

private

Definition at line 111 of file G4BOptnForceCommonTruncatedExp.hh.

fCrossSections

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

private

Definition at line 114 of file G4BOptnForceCommonTruncatedExp.hh.

fDummyParticleChange

G4ParticleChangeForNothing G4BOptnForceCommonTruncatedExp::fDummyParticleChange

private

Definition at line 120 of file G4BOptnForceCommonTruncatedExp.hh.

fForceFreeFlightLaw

G4ILawForceFreeFlight* G4BOptnForceCommonTruncatedExp::fForceFreeFlightLaw

private

Definition at line 112 of file G4BOptnForceCommonTruncatedExp.hh.

fInitialMomentum

G4ThreeVector G4BOptnForceCommonTruncatedExp::fInitialMomentum

private

Definition at line 118 of file G4BOptnForceCommonTruncatedExp.hh.

fInteractionOccured

G4bool G4BOptnForceCommonTruncatedExp::fInteractionOccured

private

Definition at line 117 of file G4BOptnForceCommonTruncatedExp.hh.

fMaximumDistance

G4double G4BOptnForceCommonTruncatedExp::fMaximumDistance

private

Definition at line 119 of file G4BOptnForceCommonTruncatedExp.hh.

fNumberOfSharing

size_t G4BOptnForceCommonTruncatedExp::fNumberOfSharing

private

Definition at line 115 of file G4BOptnForceCommonTruncatedExp.hh.

fProcessToApply

const G4VProcess* G4BOptnForceCommonTruncatedExp::fProcessToApply

private

Definition at line 116 of file G4BOptnForceCommonTruncatedExp.hh.

fTotalCrossSection

G4double G4BOptnForceCommonTruncatedExp::fTotalCrossSection

private

Definition at line 113 of file G4BOptnForceCommonTruncatedExp.hh.

---

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

• G4BOptnForceCommonTruncatedExp.hh
• G4BOptnForceCommonTruncatedExp.cc