G4BOptnForceFreeFlight Class Reference

#include <G4BOptnForceFreeFlight.hh>

Inheritance diagram for G4BOptnForceFreeFlight:

Public Member Functions
virtual void	AlongMoveBy (const G4BiasingProcessInterface *, const G4Step *, G4double)
virtual G4VParticleChange *	ApplyFinalStateBiasing (const G4BiasingProcessInterface *, const G4Track *, const G4Step *, G4bool &)
virtual G4double	DistanceToApplyOperation (const G4Track *, G4double, G4ForceCondition *)
	G4BOptnForceFreeFlight (G4String name)
virtual G4VParticleChange *	GenerateBiasingFinalState (const G4Track *, const G4Step *)
G4ILawForceFreeFlight *	GetForceFreeFlightLaw ()
const G4String &	GetName () const
std::size_t	GetUniqueID () const
G4bool	OperationComplete () const
virtual G4double	ProposeAlongStepLimit (const G4BiasingProcessInterface *)
virtual G4GPILSelection	ProposeGPILSelection (const G4GPILSelection wrappedProcessSelection)
virtual const G4VBiasingInteractionLaw *	ProvideOccurenceBiasingInteractionLaw (const G4BiasingProcessInterface *, G4ForceCondition &)
void	ResetInitialTrackWeight (G4double w)
virtual	~G4BOptnForceFreeFlight ()

Private Attributes
G4double	fCumulatedWeightChange
G4ILawForceFreeFlight *	fForceFreeFlightInteractionLaw
G4double	fInitialTrackWeight
const G4String	fName
G4bool	fOperationComplete
G4ParticleChange	fParticleChange
std::size_t	fUniqueID

Detailed Description

Definition at line 55 of file G4BOptnForceFreeFlight.hh.

Constructor & Destructor Documentation

G4BOptnForceFreeFlight()

G4BOptnForceFreeFlight::G4BOptnForceFreeFlight

(

G4String

name

)

Definition at line 33 of file G4BOptnForceFreeFlight.cc.

  : G4VBiasingOperation    ( name ),
    fCumulatedWeightChange ( -1.0 ),
    fInitialTrackWeight    ( -1.0 ),
    fOperationComplete     ( true )
{
  fForceFreeFlightInteractionLaw = new G4ILawForceFreeFlight("LawForOperation"+name);
}

References fForceFreeFlightInteractionLaw, and G4InuclParticleNames::name().

~G4BOptnForceFreeFlight()

G4BOptnForceFreeFlight::~G4BOptnForceFreeFlight ( )

virtual

Definition at line 42 of file G4BOptnForceFreeFlight.cc.

{
  if ( fForceFreeFlightInteractionLaw ) delete fForceFreeFlightInteractionLaw;
}

References fForceFreeFlightInteractionLaw.

Member Function Documentation

AlongMoveBy()

void G4BOptnForceFreeFlight::AlongMoveBy ( const G4BiasingProcessInterface *  , const G4Step *  , G4double  weightChange  )

virtual

Reimplemented from G4VBiasingOperation.

Definition at line 101 of file G4BOptnForceFreeFlight.cc.

{
  fCumulatedWeightChange *= weightChange;
}

References fCumulatedWeightChange.

ApplyFinalStateBiasing()

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

virtual

Implements G4VBiasingOperation.

Definition at line 55 of file G4BOptnForceFreeFlight.cc.

{
  // -- If the track is reaching the volume boundary, its free flight ends. In this case, its zero
  // -- weight is brought back to non-zero value: its initial weight is restored by the first
  // -- ApplyFinalStateBiasing operation called, and the weight for force free flight is applied
  // -- is applied by each operation.
  // -- If the track is not reaching the volume boundary, it zero weight flight continues.
 
  fParticleChange.Initialize( *track );
  forceFinalState    = true;
  if ( step->GetPostStepPoint()->GetStepStatus() == fGeomBoundary )
    {
      // -- Sanity checks:
      if ( fInitialTrackWeight <= DBL_MIN )
    {
      G4ExceptionDescription ed;
      ed << " Initial track weight is null ! " << G4endl;
      G4Exception(" G4BOptnForceFreeFlight::ApplyFinalStateBiasing(...)",
              "BIAS.GEN.05",
              JustWarning,
              ed);
    }
      if ( fCumulatedWeightChange <= DBL_MIN )
    {
      G4ExceptionDescription ed;
      ed << " Cumulated weight is null ! " << G4endl;
      G4Exception(" G4BOptnForceFreeFlight::ApplyFinalStateBiasing(...)",
              "BIAS.GEN.06",
              JustWarning,
              ed);
    }
 
      G4double proposedWeight = track->GetWeight();
      if ( callingProcess->GetIsFirstPostStepDoItInterface() ) proposedWeight  = fCumulatedWeightChange * fInitialTrackWeight;
      else                                                     proposedWeight *= fCumulatedWeightChange;
      fParticleChange.ProposeWeight(proposedWeight);
      fOperationComplete = true;
    }
  
  return &fParticleChange;
}

References DBL_MIN, fCumulatedWeightChange, fGeomBoundary, fInitialTrackWeight, fOperationComplete, fParticleChange, G4endl, G4Exception(), G4BiasingProcessInterface::GetIsFirstPostStepDoItInterface(), G4Step::GetPostStepPoint(), G4StepPoint::GetStepStatus(), G4Track::GetWeight(), G4ParticleChange::Initialize(), JustWarning, and G4VParticleChange::ProposeWeight().

DistanceToApplyOperation()

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

inlinevirtual

Implements G4VBiasingOperation.

Definition at line 71 of file G4BOptnForceFreeFlight.hh.

                                                           {return DBL_MAX;}

References DBL_MAX.

GenerateBiasingFinalState()

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

inlinevirtual

Implements G4VBiasingOperation.

Definition at line 74 of file G4BOptnForceFreeFlight.hh.

                                                           {return 0;}

GetForceFreeFlightLaw()

G4ILawForceFreeFlight * G4BOptnForceFreeFlight::GetForceFreeFlightLaw ( )

inline

Definition at line 82 of file G4BOptnForceFreeFlight.hh.

                                                 {
    return fForceFreeFlightInteractionLaw;
  }

References fForceFreeFlightInteractionLaw.

GetName()

const G4String & G4VBiasingOperation::GetName ( ) const

inlineinherited

Definition at line 198 of file G4VBiasingOperation.hh.

{return fName;}

References G4VBiasingOperation::fName.

GetUniqueID()

std::size_t G4VBiasingOperation::GetUniqueID ( ) const

inlineinherited

Definition at line 199 of file G4VBiasingOperation.hh.

{return fUniqueID;}

References G4VBiasingOperation::fUniqueID.

OperationComplete()

G4bool G4BOptnForceFreeFlight::OperationComplete ( ) const

inline

Definition at line 87 of file G4BOptnForceFreeFlight.hh.

{ return fOperationComplete; }

References fOperationComplete.

ProposeAlongStepLimit()

virtual G4double G4VBiasingOperation::ProposeAlongStepLimit ( const G4BiasingProcessInterface *  )

inlinevirtualinherited

Reimplemented in G4BOptnForceCommonTruncatedExp.

Definition at line 127 of file G4VBiasingOperation.hh.

{ return DBL_MAX; }

References DBL_MAX.

Referenced by G4BiasingProcessInterface::AlongStepGetPhysicalInteractionLength().

ProposeGPILSelection()

virtual G4GPILSelection G4VBiasingOperation::ProposeGPILSelection ( const G4GPILSelection  wrappedProcessSelection )

inlinevirtualinherited

Reimplemented in G4BOptnForceCommonTruncatedExp.

Definition at line 131 of file G4VBiasingOperation.hh.

  {return wrappedProcessSelection;}

Referenced by G4BiasingProcessInterface::AlongStepGetPhysicalInteractionLength().

ProvideOccurenceBiasingInteractionLaw()

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

virtual

Implements G4VBiasingOperation.

Definition at line 47 of file G4BOptnForceFreeFlight.cc.

{
  fOperationComplete = false;
  proposeForceCondition = Forced;
  return fForceFreeFlightInteractionLaw;
}

References fForceFreeFlightInteractionLaw, fOperationComplete, and Forced.

ResetInitialTrackWeight()

void G4BOptnForceFreeFlight::ResetInitialTrackWeight ( G4double  w )

inline

Definition at line 86 of file G4BOptnForceFreeFlight.hh.

{fInitialTrackWeight = w; fCumulatedWeightChange = 1.0;}

References fCumulatedWeightChange, and fInitialTrackWeight.

Referenced by G4BOptrForceCollision::ProposeOccurenceBiasingOperation().

Field Documentation

fCumulatedWeightChange

G4double G4BOptnForceFreeFlight::fCumulatedWeightChange

private

Definition at line 91 of file G4BOptnForceFreeFlight.hh.

Referenced by AlongMoveBy(), ApplyFinalStateBiasing(), and ResetInitialTrackWeight().

fForceFreeFlightInteractionLaw

G4ILawForceFreeFlight* G4BOptnForceFreeFlight::fForceFreeFlightInteractionLaw

private

Definition at line 90 of file G4BOptnForceFreeFlight.hh.

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

fInitialTrackWeight

G4double G4BOptnForceFreeFlight::fInitialTrackWeight

private

Definition at line 92 of file G4BOptnForceFreeFlight.hh.

Referenced by ApplyFinalStateBiasing(), and ResetInitialTrackWeight().

fName

const G4String G4VBiasingOperation::fName

privateinherited

Definition at line 203 of file G4VBiasingOperation.hh.

Referenced by G4VBiasingOperation::GetName().

fOperationComplete

G4bool G4BOptnForceFreeFlight::fOperationComplete

private

Definition at line 94 of file G4BOptnForceFreeFlight.hh.

Referenced by ApplyFinalStateBiasing(), OperationComplete(), and ProvideOccurenceBiasingInteractionLaw().

fParticleChange

G4ParticleChange G4BOptnForceFreeFlight::fParticleChange

private

Definition at line 93 of file G4BOptnForceFreeFlight.hh.

Referenced by ApplyFinalStateBiasing().

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/G4BOptnForceFreeFlight.hh
• source/processes/biasing/generic/src/G4BOptnForceFreeFlight.cc