G4BOptnForceFreeFlight Class Reference

#include <G4BOptnForceFreeFlight.hh>

Inheritance diagram for G4BOptnForceFreeFlight:

Collaboration diagram for G4BOptnForceFreeFlight:

Public Member Functions
	G4BOptnForceFreeFlight (G4String name)
virtual	~G4BOptnForceFreeFlight ()
virtual const G4VBiasingInteractionLaw *	ProvideOccurenceBiasingInteractionLaw (const G4BiasingProcessInterface *, G4ForceCondition &)
virtual G4bool	DenyProcessPostStepDoIt (const G4BiasingProcessInterface *, const G4Track *, const G4Step *, G4double &)
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 *)
virtual G4VParticleChange *	GenerateBiasingFinalState (const G4Track *, const G4Step *)
G4ILawForceFreeFlight *	GetForceFreeFlightLaw ()
void	ResetInitialTrackWeight (G4double w)
G4bool	OperationComplete () const
Public Member Functions inherited from G4VBiasingOperation
	G4VBiasingOperation (G4String name)
virtual	~G4VBiasingOperation ()
virtual G4double	ProposeAlongStepLimit (const G4BiasingProcessInterface *)
virtual G4GPILSelection	ProposeGPILSelection (const G4GPILSelection wrappedProcessSelection)
const G4String &	GetName () const
std::size_t	GetUniqueID () const

Private Attributes
G4ILawForceFreeFlight *	fForceFreeFlightInteractionLaw
G4double	fCumulatedWeightChange
G4double	fInitialTrackWeight
G4ParticleChange	fParticleChange
G4bool	fOperationComplete

Detailed Description

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

~G4BOptnForceFreeFlight()

G4BOptnForceFreeFlight::~G4BOptnForceFreeFlight ( )

virtual

Definition at line 42 of file G4BOptnForceFreeFlight.cc.

{
  if ( fForceFreeFlightInteractionLaw ) delete fForceFreeFlightInteractionLaw;
}

Member Function Documentation

AlongMoveBy()

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

virtual

Reimplemented from G4VBiasingOperation.

Definition at line 131 of file G4BOptnForceFreeFlight.cc.

{
  fCumulatedWeightChange *= weightChange;
}

ApplyFinalStateBiasing()

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

virtual

Implements G4VBiasingOperation.

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

Here is the call graph for this function:

DenyProcessPostStepDoIt()

G4bool G4BOptnForceFreeFlight::DenyProcessPostStepDoIt ( const G4BiasingProcessInterface *  , const G4Track *  , const G4Step *  step, G4double &  proposedWeight  )

virtual

Definition at line 54 of file G4BOptnForceFreeFlight.cc.

{
  // -- force free flight always deny process to apply its doit.
  // -- if reaching boundary, track is restored with non-zero weight
  if ( fInitialTrackWeight <= DBL_MIN )
    {
      G4ExceptionDescription ed;
      ed << " Initial track weight is null ! " << G4endl;
      G4Exception(" G4BOptnForceFreeFlight::DenyProcessPostStepDoIt(...)",
          "BIAS.GEN.05",
          JustWarning,
          ed);
    }
  if ( fCumulatedWeightChange <= DBL_MIN )
    {
      G4ExceptionDescription ed;
      ed << " Cumulated weight is null ! " << G4endl;
      G4Exception(" G4BOptnForceFreeFlight::DenyProcessPostStepDoIt(...)",
          "BIAS.GEN.06",
          JustWarning,
          ed);
    }
  if ( step->GetPostStepPoint()->GetStepStatus() == fGeomBoundary )
    {
      if ( proposedWeight <= DBL_MIN ) proposedWeight  = fCumulatedWeightChange * fInitialTrackWeight;
      else                             proposedWeight *= fCumulatedWeightChange;
    }
  
  return true;
}

Here is the call graph for this function:

DistanceToApplyOperation()

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

inlinevirtual

Implements G4VBiasingOperation.

Definition at line 73 of file G4BOptnForceFreeFlight.hh.

                                                           {return DBL_MAX;}

GenerateBiasingFinalState()

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

inlinevirtual

Implements G4VBiasingOperation.

Definition at line 76 of file G4BOptnForceFreeFlight.hh.

                                                           {return 0;}

GetForceFreeFlightLaw()

G4ILawForceFreeFlight* G4BOptnForceFreeFlight::GetForceFreeFlightLaw ( )

inline

Definition at line 84 of file G4BOptnForceFreeFlight.hh.

                                                 {
    return fForceFreeFlightInteractionLaw;
  }

OperationComplete()

G4bool G4BOptnForceFreeFlight::OperationComplete ( ) const

inline

Definition at line 89 of file G4BOptnForceFreeFlight.hh.

{ return fOperationComplete; }

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

ResetInitialTrackWeight()

void G4BOptnForceFreeFlight::ResetInitialTrackWeight ( G4double  w )

inline

Definition at line 88 of file G4BOptnForceFreeFlight.hh.

{fInitialTrackWeight = w; fCumulatedWeightChange = 1.0;}

Here is the caller graph for this function:

Member Data Documentation

fCumulatedWeightChange

G4double G4BOptnForceFreeFlight::fCumulatedWeightChange

private

Definition at line 93 of file G4BOptnForceFreeFlight.hh.

fForceFreeFlightInteractionLaw

G4ILawForceFreeFlight* G4BOptnForceFreeFlight::fForceFreeFlightInteractionLaw

private

Definition at line 92 of file G4BOptnForceFreeFlight.hh.

fInitialTrackWeight

G4double G4BOptnForceFreeFlight::fInitialTrackWeight

private

Definition at line 93 of file G4BOptnForceFreeFlight.hh.

fOperationComplete

G4bool G4BOptnForceFreeFlight::fOperationComplete

private

Definition at line 96 of file G4BOptnForceFreeFlight.hh.

fParticleChange

G4ParticleChange G4BOptnForceFreeFlight::fParticleChange

private

Definition at line 95 of file G4BOptnForceFreeFlight.hh.

---

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

• G4BOptnForceFreeFlight.hh
• G4BOptnForceFreeFlight.cc