G4InteractionLawPhysical Class Reference

#include <G4InteractionLawPhysical.hh>

Inheritance diagram for G4InteractionLawPhysical:

Public Member Functions
virtual G4double	ComputeEffectiveCrossSectionAt (G4double length) const
virtual G4double	ComputeNonInteractionProbabilityAt (G4double length) const
	G4InteractionLawPhysical (G4String name="exponentialLaw")
const G4String &	GetName () const
G4double	GetPhysicalCrossSection () const
G4double	GetSampledInteractionLength () const
virtual G4bool	IsEffectiveCrossSectionInfinite () const
virtual G4bool	IsSingular () const
G4double	Sample ()
virtual G4double	SampleInteractionLength ()
void	SetPhysicalCrossSection (G4double crossSection)
G4double	UpdateForStep (G4double truePathLength)
virtual G4double	UpdateInteractionLengthForStep (G4double truePathLength)
virtual	~G4InteractionLawPhysical ()

Private Attributes
G4double	fCrossSection
G4bool	fCrossSectionDefined
G4String	fName
G4double	fNumberOfInteractionLength
G4double	fSampledInteractionLength

Detailed Description

Definition at line 44 of file G4InteractionLawPhysical.hh.

Constructor & Destructor Documentation

G4InteractionLawPhysical()

G4InteractionLawPhysical::G4InteractionLawPhysical

(

G4String

name = "exponentialLaw"

)

Definition at line 29 of file G4InteractionLawPhysical.cc.

  : G4VBiasingInteractionLaw(name),
    fCrossSection(0.0),
    fCrossSectionDefined(false),
    fNumberOfInteractionLength(-1.0)
{}

~G4InteractionLawPhysical()

G4InteractionLawPhysical::~G4InteractionLawPhysical ( )

virtual

Definition at line 36 of file G4InteractionLawPhysical.cc.

{}

Member Function Documentation

ComputeEffectiveCrossSectionAt()

G4double G4InteractionLawPhysical::ComputeEffectiveCrossSectionAt ( G4double  length ) const

virtual

Implements G4VBiasingInteractionLaw.

Definition at line 53 of file G4InteractionLawPhysical.cc.

{
  if (!fCrossSectionDefined) G4Exception("G4InteractionLawPhysical::ComputeEffectiveCrossSection(..)",
                     "BIAS.GEN.15",
                     JustWarning,
                     "Cross-section value requested, but has not been defined yet. Assumes 0 !");
  return fCrossSection;
}

References fCrossSection, fCrossSectionDefined, G4Exception(), and JustWarning.

Referenced by G4BiasingProcessInterface::PostStepDoIt().

ComputeNonInteractionProbabilityAt()

G4double G4InteractionLawPhysical::ComputeNonInteractionProbabilityAt ( G4double  length ) const

virtual

Implements G4VBiasingInteractionLaw.

Definition at line 62 of file G4InteractionLawPhysical.cc.

{
  if (!fCrossSectionDefined) G4Exception("G4InteractionLawPhysical::ComputeNonInteractionProbability(..)",
                     "BIAS.GEN.16",
                     JustWarning,
                     "Non interaction probabitlity value requested, but cross section has not been defined yet. Assumes it to be 0 !");
  // -- allows zero cross-section case, by convention:
  if ( fCrossSection == 0.0 ) return 1.0;
  else return std::exp(-fCrossSection*stepLength);
}

References fCrossSection, fCrossSectionDefined, G4Exception(), and JustWarning.

Referenced by G4BiasingProcessInterface::AlongStepDoIt().

GetName()

const G4String & G4VBiasingInteractionLaw::GetName ( ) const

inlineinherited

Definition at line 67 of file G4VBiasingInteractionLaw.hh.

{ return fName; }

References G4VBiasingInteractionLaw::fName.

Referenced by G4BiasingProcessInterface::AlongStepDoIt(), G4ILawCommonTruncatedExp::ComputeNonInteractionProbabilityAt(), G4ILawTruncatedExp::UpdateInteractionLengthForStep(), and UpdateInteractionLengthForStep().

GetPhysicalCrossSection()

G4double G4InteractionLawPhysical::GetPhysicalCrossSection ( ) const

inline

Definition at line 52 of file G4InteractionLawPhysical.hh.

{return fCrossSection;}

References fCrossSection.

Referenced by G4BOptnChangeCrossSection::GetBiasedCrossSection().

GetSampledInteractionLength()

G4double G4VBiasingInteractionLaw::GetSampledInteractionLength ( ) const

inlineinherited

Definition at line 107 of file G4VBiasingInteractionLaw.hh.

{ return fSampledInteractionLength; }

References G4VBiasingInteractionLaw::fSampledInteractionLength.

Referenced by G4BiasingProcessInterface::PostStepGetPhysicalInteractionLength().

IsEffectiveCrossSectionInfinite()

virtual G4bool G4VBiasingInteractionLaw::IsEffectiveCrossSectionInfinite ( ) const

inlinevirtualinherited

Reimplemented in G4ILawCommonTruncatedExp.

Definition at line 90 of file G4VBiasingInteractionLaw.hh.

{return false;}

Referenced by G4ILawCommonTruncatedExp::IsEffectiveCrossSectionInfinite(), and G4BiasingProcessInterface::PostStepDoIt().

IsSingular()

virtual G4bool G4VBiasingInteractionLaw::IsSingular ( ) const

inlinevirtualinherited

Reimplemented in G4ILawCommonTruncatedExp, G4ILawForceFreeFlight, and G4ILawTruncatedExp.

Definition at line 88 of file G4VBiasingInteractionLaw.hh.

{return false;}

Referenced by G4BiasingProcessInterface::PostStepDoIt().

Sample()

G4double G4VBiasingInteractionLaw::Sample ( )

inlineinherited

Definition at line 97 of file G4VBiasingInteractionLaw.hh.

  {
    fSampledInteractionLength = SampleInteractionLength();
    return fSampledInteractionLength;
  }

References G4VBiasingInteractionLaw::fSampledInteractionLength, and G4VBiasingInteractionLaw::SampleInteractionLength().

Referenced by G4BOptnChangeCrossSection::Sample(), and G4BOptnForceCommonTruncatedExp::Sample().

SampleInteractionLength()

G4double G4InteractionLawPhysical::SampleInteractionLength ( )

virtual

Implements G4VBiasingInteractionLaw.

Definition at line 73 of file G4InteractionLawPhysical.cc.

{
  if ( !fCrossSectionDefined || fCrossSection < 0.0 )  G4Exception("G4InteractionLawPhysical::Sample(..)",
                                   "BIAS.GEN.17",
                                   FatalException,
                                   "Trying to sample while cross-section is not defined or < 0 !");
  if ( fCrossSection == 0.0 ) return DBL_MAX;
 
  fNumberOfInteractionLength =  -std::log( G4UniformRand() );
  return fNumberOfInteractionLength/fCrossSection;
}

References DBL_MAX, FatalException, fCrossSection, fCrossSectionDefined, fNumberOfInteractionLength, G4Exception(), and G4UniformRand.

SetPhysicalCrossSection()

void G4InteractionLawPhysical::SetPhysicalCrossSection

(

G4double

crossSection

)

Definition at line 39 of file G4InteractionLawPhysical.cc.

{
  if (crossSection < 0.0)
    {
      G4Exception("G4InteractionLawPhysical::SetPhysicalCrossSection(..)",
          "BIAS.GEN.14",
          JustWarning,
          "Cross-section value passed is negative. It is set to zero !");
      crossSection = 0.0;
    }
  fCrossSectionDefined = true;
  fCrossSection        = crossSection;
}

References fCrossSection, fCrossSectionDefined, G4Exception(), and JustWarning.

Referenced by G4BiasingProcessInterface::PostStepGetPhysicalInteractionLength(), and G4BOptnChangeCrossSection::SetBiasedCrossSection().

UpdateForStep()

G4double G4VBiasingInteractionLaw::UpdateForStep ( G4double  truePathLength )

inlineinherited

Definition at line 102 of file G4VBiasingInteractionLaw.hh.

  {
    fSampledInteractionLength = UpdateInteractionLengthForStep(truePathLength);
    return fSampledInteractionLength;
  }

References G4VBiasingInteractionLaw::fSampledInteractionLength, and G4VBiasingInteractionLaw::UpdateInteractionLengthForStep().

Referenced by G4BOptnForceCommonTruncatedExp::UpdateForStep(), and G4BOptnChangeCrossSection::UpdateForStep().

UpdateInteractionLengthForStep()

G4double G4InteractionLawPhysical::UpdateInteractionLengthForStep ( G4double  truePathLength )

virtual

Reimplemented from G4VBiasingInteractionLaw.

Definition at line 86 of file G4InteractionLawPhysical.cc.

{
  fNumberOfInteractionLength -= truePathLength*fCrossSection;
  
  if ( fNumberOfInteractionLength < 0 ) 
    {
      G4ExceptionDescription ed;
      ed << " Negative number of interaction length for `" << GetName() << "' " << fNumberOfInteractionLength << ", set it to zero !" << G4endl; 
      G4Exception("G4InteractionLawPhysical::UpdateInteractionLengthForStep(...)",
          "BIAS.GEN.13",
          JustWarning,
          ed);
      fNumberOfInteractionLength = 0.;
    }
  return  fNumberOfInteractionLength/fCrossSection;
}

References fCrossSection, fNumberOfInteractionLength, G4endl, G4Exception(), G4VBiasingInteractionLaw::GetName(), and JustWarning.

Field Documentation

fCrossSection

G4double G4InteractionLawPhysical::fCrossSection

private

Definition at line 64 of file G4InteractionLawPhysical.hh.

Referenced by ComputeEffectiveCrossSectionAt(), ComputeNonInteractionProbabilityAt(), GetPhysicalCrossSection(), SampleInteractionLength(), SetPhysicalCrossSection(), and UpdateInteractionLengthForStep().

fCrossSectionDefined

G4bool G4InteractionLawPhysical::fCrossSectionDefined

private

Definition at line 65 of file G4InteractionLawPhysical.hh.

Referenced by ComputeEffectiveCrossSectionAt(), ComputeNonInteractionProbabilityAt(), SampleInteractionLength(), and SetPhysicalCrossSection().

fName

G4String G4VBiasingInteractionLaw::fName

privateinherited

Definition at line 111 of file G4VBiasingInteractionLaw.hh.

Referenced by G4VBiasingInteractionLaw::GetName().

fNumberOfInteractionLength

G4double G4InteractionLawPhysical::fNumberOfInteractionLength

private

Definition at line 66 of file G4InteractionLawPhysical.hh.

Referenced by SampleInteractionLength(), and UpdateInteractionLengthForStep().

fSampledInteractionLength

G4double G4VBiasingInteractionLaw::fSampledInteractionLength

privateinherited

Definition at line 112 of file G4VBiasingInteractionLaw.hh.

Referenced by G4VBiasingInteractionLaw::GetSampledInteractionLength(), G4VBiasingInteractionLaw::Sample(), and G4VBiasingInteractionLaw::UpdateForStep().

---

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

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