G4ILawTruncatedExp Class Reference

#include <G4ILawTruncatedExp.hh>

Inheritance diagram for G4ILawTruncatedExp:

Public Member Functions
virtual G4double	ComputeEffectiveCrossSectionAt (G4double length) const
virtual G4double	ComputeNonInteractionProbabilityAt (G4double length) const
	G4ILawTruncatedExp (G4String name="expForceInteractionLaw")
G4double	GetInteractionDistance () const
G4double	GetMaximumDistance () const
const G4String &	GetName () const
G4double	GetSampledInteractionLength () const
virtual G4bool	IsEffectiveCrossSectionInfinite () const
virtual G4bool	IsSingular () const
G4double	Sample ()
virtual G4double	SampleInteractionLength ()
void	SetForceCrossSection (G4double xs)
void	SetMaximumDistance (G4double d)
G4double	UpdateForStep (G4double truePathLength)
virtual G4double	UpdateInteractionLengthForStep (G4double truePathLength)
virtual	~G4ILawTruncatedExp ()

Private Attributes
G4double	fCrossSection
G4double	fCrossSectionDefined
G4double	fInteractionDistance
G4bool	fIsSingular
G4double	fMaximumDistance
G4String	fName
G4double	fSampledInteractionLength

Detailed Description

Definition at line 45 of file G4ILawTruncatedExp.hh.

Constructor & Destructor Documentation

G4ILawTruncatedExp()

G4ILawTruncatedExp::G4ILawTruncatedExp

(

G4String

name = "expForceInteractionLaw"

)

Definition at line 31 of file G4ILawTruncatedExp.cc.

  : G4VBiasingInteractionLaw(name),
    fMaximumDistance(0.0),
    fCrossSection(0.0),
    fCrossSectionDefined(false),
    fIsSingular(false)
{}

~G4ILawTruncatedExp()

G4ILawTruncatedExp::~G4ILawTruncatedExp ( )

virtual

Definition at line 39 of file G4ILawTruncatedExp.cc.

{}

Member Function Documentation

ComputeEffectiveCrossSectionAt()

G4double G4ILawTruncatedExp::ComputeEffectiveCrossSectionAt ( G4double  length ) const

virtual

Implements G4VBiasingInteractionLaw.

Definition at line 58 of file G4ILawTruncatedExp.cc.

{
  if ( !fCrossSectionDefined )
    {
      G4Exception("G4ILawTruncatedExp::ComputeEffectiveCrossSection(..)",
          "BIAS.GEN.10",
          JustWarning,
          "Cross-section value requested, but has not been defined yet. Assumes 0 !");
      // -- zero cross-section, returns the limit form of the effective cross-section:
      return 1.0 / ( fMaximumDistance - distance );
    }
  G4double denum = 1.0 - std::exp( -fCrossSection * ( fMaximumDistance - distance) );
  return fCrossSection / denum;
}

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

Referenced by G4ILawCommonTruncatedExp::ComputeEffectiveCrossSectionAt().

ComputeNonInteractionProbabilityAt()

G4double G4ILawTruncatedExp::ComputeNonInteractionProbabilityAt ( G4double  length ) const

virtual

Implements G4VBiasingInteractionLaw.

Definition at line 73 of file G4ILawTruncatedExp.cc.

{
  if (!fCrossSectionDefined)
    {
      G4Exception("G4ILawTruncatedExp::ComputeNonInteractionProbability(..)",
          "BIAS.GEN.11",
          JustWarning,
          "Non interaction probability value requested, but cross section has not been defined yet. Assumes it to be 0 !");
      // -- return limit case of null cross-section:
      return 1.0 - distance / fMaximumDistance;
    }
  G4double   num = 1.0 - std::exp( -fCrossSection*distance         );
  G4double denum = 1.0 - std::exp( -fCrossSection*fMaximumDistance );
  return 1.0 - num/denum;
}

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

Referenced by G4ILawCommonTruncatedExp::ComputeNonInteractionProbabilityAt().

GetInteractionDistance()

G4double G4ILawTruncatedExp::GetInteractionDistance ( ) const

inline

Definition at line 66 of file G4ILawTruncatedExp.hh.

{ return fInteractionDistance; }

References fInteractionDistance.

Referenced by G4ILawCommonTruncatedExp::GetInteractionDistance().

GetMaximumDistance()

G4double G4ILawTruncatedExp::GetMaximumDistance ( ) const

inline

Definition at line 65 of file G4ILawTruncatedExp.hh.

{ return fMaximumDistance;}

References fMaximumDistance.

Referenced by G4ILawCommonTruncatedExp::GetMaximumDistance().

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(), UpdateInteractionLengthForStep(), and G4InteractionLawPhysical::UpdateInteractionLengthForStep().

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 G4ILawTruncatedExp::IsSingular ( ) const

inlinevirtual

Reimplemented from G4VBiasingInteractionLaw.

Definition at line 58 of file G4ILawTruncatedExp.hh.

{return fIsSingular;}

References fIsSingular.

Referenced by G4ILawCommonTruncatedExp::IsSingular().

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 G4ILawTruncatedExp::SampleInteractionLength ( )

virtual

Implements G4VBiasingInteractionLaw.

Definition at line 89 of file G4ILawTruncatedExp.cc.

{
  if ( !fCrossSectionDefined )
    {
      G4Exception("G4ILawTruncatedExp::Sample(..)",
          "BIAS.GEN.12",
          JustWarning,
          "Trying to sample while cross-section is not defined, assuming 0 !");
      fInteractionDistance = G4UniformRand() * fMaximumDistance;
      return fInteractionDistance;
    }
  fInteractionDistance = -std::log(1.0 - G4UniformRand()* (1.0 - std::exp(-fCrossSection*fMaximumDistance)))/fCrossSection;
  return fInteractionDistance;
}

References fCrossSection, fCrossSectionDefined, fInteractionDistance, fMaximumDistance, G4Exception(), G4UniformRand, and JustWarning.

Referenced by G4ILawCommonTruncatedExp::SampleInteractionLength().

SetForceCrossSection()

void G4ILawTruncatedExp::SetForceCrossSection

(

G4double

xs

)

Definition at line 42 of file G4ILawTruncatedExp.cc.

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

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

Referenced by G4ILawCommonTruncatedExp::SetForceCrossSection().

SetMaximumDistance()

void G4ILawTruncatedExp::SetMaximumDistance ( G4double  d )

inline

Definition at line 64 of file G4ILawTruncatedExp.hh.

{ fMaximumDistance = d;}

References fMaximumDistance.

Referenced by G4ILawCommonTruncatedExp::SetMaximumDistance().

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 G4ILawTruncatedExp::UpdateInteractionLengthForStep ( G4double  truePathLength )

virtual

Reimplemented from G4VBiasingInteractionLaw.

Definition at line 105 of file G4ILawTruncatedExp.cc.

{
  fInteractionDistance -= truePathLength;
  fMaximumDistance     -= truePathLength;
  
  if ( fInteractionDistance < 0 )
    {
      G4ExceptionDescription ed;
      ed << " Negative number of interaction length for `" << GetName() << "' " << fInteractionDistance << ", set it to zero !" << G4endl; 
      G4Exception("G4ILawTruncatedExp::UpdateInteractionLengthForStep(...)",
          "BIAS.GEN.13",
          JustWarning,
          "Trying to sample while cross-section is not defined, assuming 0 !");
      fInteractionDistance = 0.;
    }
  
  return  fInteractionDistance;
}

References fInteractionDistance, fMaximumDistance, G4endl, G4Exception(), G4VBiasingInteractionLaw::GetName(), and JustWarning.

Referenced by G4ILawCommonTruncatedExp::UpdateInteractionLengthForStep().

Field Documentation

fCrossSection

G4double G4ILawTruncatedExp::fCrossSection

private

Definition at line 70 of file G4ILawTruncatedExp.hh.

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

fCrossSectionDefined

G4double G4ILawTruncatedExp::fCrossSectionDefined

private

Definition at line 71 of file G4ILawTruncatedExp.hh.

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

fInteractionDistance

G4double G4ILawTruncatedExp::fInteractionDistance

private

Definition at line 73 of file G4ILawTruncatedExp.hh.

Referenced by GetInteractionDistance(), SampleInteractionLength(), and UpdateInteractionLengthForStep().

fIsSingular

G4bool G4ILawTruncatedExp::fIsSingular

private

Definition at line 72 of file G4ILawTruncatedExp.hh.

Referenced by IsSingular(), and SetForceCrossSection().

fMaximumDistance

G4double G4ILawTruncatedExp::fMaximumDistance

private

Definition at line 69 of file G4ILawTruncatedExp.hh.

Referenced by ComputeEffectiveCrossSectionAt(), ComputeNonInteractionProbabilityAt(), GetMaximumDistance(), SampleInteractionLength(), SetMaximumDistance(), and UpdateInteractionLengthForStep().

fName

G4String G4VBiasingInteractionLaw::fName

privateinherited

Definition at line 111 of file G4VBiasingInteractionLaw.hh.

Referenced by G4VBiasingInteractionLaw::GetName().

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