#include <G4BFieldIntegrationDriver.hh>

Inheritance diagram for G4BFieldIntegrationDriver:

Public Member Functions
virtual G4bool	AccurateAdvance (G4FieldTrack &track, G4double hstep, G4double eps, G4double hinitial=0) override

virtual G4double	AdvanceChordLimited (G4FieldTrack &track, G4double hstep, G4double eps, G4double chordDistance) override

virtual G4double	ComputeNewStepSize (G4double errMaxNorm, G4double hstepCurrent) override

virtual G4bool	DoesReIntegrate () const override

	G4BFieldIntegrationDriver (const G4BFieldIntegrationDriver &)=delete

	G4BFieldIntegrationDriver (std::unique_ptr< G4VIntegrationDriver > smallStepDriver, std::unique_ptr< G4VIntegrationDriver > largeStepDriver)

virtual void	GetDerivatives (const G4FieldTrack &track, G4double dydx[]) const override

virtual void	GetDerivatives (const G4FieldTrack &track, G4double dydx[], G4double field[]) const override

virtual G4EquationOfMotion *	GetEquationOfMotion () override

virtual const G4MagIntegratorStepper *	GetStepper () const override

virtual G4MagIntegratorStepper *	GetStepper () override

virtual G4int	GetVerboseLevel () const override

virtual void	OnComputeStep () override

virtual void	OnStartTracking () override

const G4BFieldIntegrationDriver &	operator= (const G4BFieldIntegrationDriver &)=delete

void	PrintStatistics () const

virtual G4bool	QuickAdvance (G4FieldTrack &, const G4double[], G4double, G4double &, G4double &)

virtual void	RenewStepperAndAdjust (G4MagIntegratorStepper *pItsStepper)

virtual void	SetEquationOfMotion (G4EquationOfMotion *equation) override

virtual void	SetVerboseLevel (G4int level) override

virtual void	StreamInfo (std::ostream &os) const override

Static Protected Attributes
static constexpr G4double	max_stepping_decrease = 0.1

static constexpr G4double	max_stepping_increase = 5

Private Member Functions
G4double	CurvatureRadius (const G4FieldTrack &track) const

void	GetFieldValue (const G4FieldTrack &track, G4double Field[]) const

Private Attributes
G4VIntegrationDriver *	fCurrDriver = nullptr

G4Mag_EqRhs *	fEquation = nullptr

G4int	fLargeDriverSteps = 0

std::unique_ptr< G4VIntegrationDriver >	fLargeStepDriver

G4int	fSmallDriverSteps = 0

std::unique_ptr< G4VIntegrationDriver >	fSmallStepDriver

Detailed Description

Definition at line 42 of file G4BFieldIntegrationDriver.hh.

Constructor & Destructor Documentation

◆ G4BFieldIntegrationDriver() [1/2]

G4BFieldIntegrationDriver::G4BFieldIntegrationDriver	(	std::unique_ptr< G4VIntegrationDriver >	smallStepDriver,
		std::unique_ptr< G4VIntegrationDriver >	largeStepDriver
	)

Definition at line 62 of file G4BFieldIntegrationDriver.cc.

    : fSmallStepDriver(std::move(smallStepDriver)),
      fLargeStepDriver(std::move(largeStepDriver)),
      fCurrDriver(fSmallStepDriver.get()),
      fEquation(toMagneticEquation(fCurrDriver->GetEquationOfMotion()))
{
    if (fSmallStepDriver->GetEquationOfMotion()
     != fLargeStepDriver->GetEquationOfMotion())
    {
        G4Exception("G4BFieldIntegrationDriver Constructor:",
                    "GeomField1001", FatalException, "different EoM");  
    }
}

References FatalException, fLargeStepDriver, fSmallStepDriver, and G4Exception().

◆ G4BFieldIntegrationDriver() [2/2]

G4BFieldIntegrationDriver::G4BFieldIntegrationDriver ( const G4BFieldIntegrationDriver & )

delete

Member Function Documentation

◆ AccurateAdvance()

virtual G4bool G4BFieldIntegrationDriver::AccurateAdvance	(	G4FieldTrack &	track,
		G4double	hstep,
		G4double	eps,
		G4double	hinitial = `0`
	)

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 58 of file G4BFieldIntegrationDriver.hh.

    {
        return fCurrDriver->AccurateAdvance(track, hstep, eps, hinitial);
    }

References G4VIntegrationDriver::AccurateAdvance(), eps, and fCurrDriver.

◆ AdvanceChordLimited()

G4double G4BFieldIntegrationDriver::AdvanceChordLimited	(	G4FieldTrack &	track,
		G4double	hstep,
		G4double	eps,
		G4double	chordDistance
	)

overridevirtual

Implements G4VIntegrationDriver.

Definition at line 78 of file G4BFieldIntegrationDriver.cc.

{
    const G4double radius = CurvatureRadius(yCurrent);
 
    G4VIntegrationDriver* driver = nullptr;
    if (chordDistance < 2 * radius)
    {
        stepMax = std::min(stepMax, twopi * radius);
        driver = fSmallStepDriver.get();
        ++fSmallDriverSteps;
    } else
    {
        driver = fLargeStepDriver.get();
        ++fLargeDriverSteps;
    }
 
    if (driver != fCurrDriver)
    {
        driver->OnComputeStep();
    }
 
    fCurrDriver = driver;
 
    return fCurrDriver->AdvanceChordLimited(yCurrent, stepMax,
                                            epsStep, chordDistance);
}

References G4VIntegrationDriver::AdvanceChordLimited(), CurvatureRadius(), fCurrDriver, fLargeDriverSteps, fLargeStepDriver, fSmallDriverSteps, fSmallStepDriver, G4INCL::Math::min(), G4VIntegrationDriver::OnComputeStep(), and twopi.

◆ ComputeNewStepSize()

virtual G4double G4BFieldIntegrationDriver::ComputeNewStepSize	(	G4double	errMaxNorm,
		G4double	hstepCurrent
	)

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 104 of file G4BFieldIntegrationDriver.hh.

    {
        return fCurrDriver->ComputeNewStepSize(errMaxNorm, hstepCurrent);
    }

References G4VIntegrationDriver::ComputeNewStepSize(), and fCurrDriver.

◆ CurvatureRadius()

G4double G4BFieldIntegrationDriver::CurvatureRadius ( const G4FieldTrack & track ) const

private

Definition at line 117 of file G4BFieldIntegrationDriver.cc.

{
    G4double field[G4Field::MAX_NUMBER_OF_COMPONENTS];
    
    GetFieldValue(track, field);
    
    const G4double Bmag2 =   field[0] * field[0]
                           + field[1] * field[1]
                           + field[2] * field[2] ;
    if (Bmag2 == 0.0 )
    {
       return DBL_MAX;
    }
 
    const G4double momentum2 = track.GetMomentum().mag2();
    const G4double fCof_inv = eplus / std::abs(fEquation->FCof());
 
    return std::sqrt(momentum2 / Bmag2) * fCof_inv;
}

References DBL_MAX, eplus, G4Mag_EqRhs::FCof(), fEquation, GetFieldValue(), G4FieldTrack::GetMomentum(), CLHEP::Hep3Vector::mag2(), and G4Field::MAX_NUMBER_OF_COMPONENTS.

Referenced by AdvanceChordLimited().

◆ DoesReIntegrate()

virtual G4bool G4BFieldIntegrationDriver::DoesReIntegrate ( ) const

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 66 of file G4BFieldIntegrationDriver.hh.

    {
       return fCurrDriver->DoesReIntegrate();
    }

References G4VIntegrationDriver::DoesReIntegrate(), and fCurrDriver.

◆ GetDerivatives() [1/2]

virtual void G4BFieldIntegrationDriver::GetDerivatives	(	const G4FieldTrack &	track,
		G4double	dydx[]
	)		const

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 72 of file G4BFieldIntegrationDriver.hh.

    {
        fCurrDriver->GetDerivatives(track, dydx);
    }

References fCurrDriver, and G4VIntegrationDriver::GetDerivatives().

◆ GetDerivatives() [2/2]

virtual void G4BFieldIntegrationDriver::GetDerivatives	(	const G4FieldTrack &	track,
		G4double	dydx[],
		G4double	field[]
	)		const

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 79 of file G4BFieldIntegrationDriver.hh.

    {
        fCurrDriver->GetDerivatives(track, dydx, field);
    }

References fCurrDriver, and G4VIntegrationDriver::GetDerivatives().

◆ GetEquationOfMotion()

virtual G4EquationOfMotion * G4BFieldIntegrationDriver::GetEquationOfMotion ( )

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 88 of file G4BFieldIntegrationDriver.hh.

    {
        return fCurrDriver->GetEquationOfMotion();
    }

References fCurrDriver, and G4VIntegrationDriver::GetEquationOfMotion().

◆ GetFieldValue()

void G4BFieldIntegrationDriver::GetFieldValue	(	const G4FieldTrack &	track,
		G4double	Field[]
	)		const

private

Definition at line 138 of file G4BFieldIntegrationDriver.cc.

{
    G4ThreeVector pos= track.GetPosition();
    G4double positionTime[4]= { pos.x(), pos.y(), pos.z(),
                                track.GetLabTimeOfFlight() } ;
    
    fEquation->GetFieldValue(positionTime, Field);
}

References fEquation, G4EquationOfMotion::GetFieldValue(), G4FieldTrack::GetLabTimeOfFlight(), G4FieldTrack::GetPosition(), and pos.

Referenced by CurvatureRadius().

◆ GetStepper() [1/2]

virtual const G4MagIntegratorStepper * G4BFieldIntegrationDriver::GetStepper ( ) const

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 94 of file G4BFieldIntegrationDriver.hh.

    {
        return fCurrDriver->GetStepper();
    }

References fCurrDriver, and G4VIntegrationDriver::GetStepper().

◆ GetStepper() [2/2]

virtual G4MagIntegratorStepper * G4BFieldIntegrationDriver::GetStepper ( )

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 99 of file G4BFieldIntegrationDriver.hh.

    {
        return fCurrDriver->GetStepper();
    }

References fCurrDriver, and G4VIntegrationDriver::GetStepper().

◆ GetVerboseLevel()

virtual G4int G4BFieldIntegrationDriver::GetVerboseLevel ( ) const

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 116 of file G4BFieldIntegrationDriver.hh.

    {
        return fCurrDriver->GetVerboseLevel();
    }

References fCurrDriver, and G4VIntegrationDriver::GetVerboseLevel().

◆ OnComputeStep()

virtual void G4BFieldIntegrationDriver::OnComputeStep ( )

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 121 of file G4BFieldIntegrationDriver.hh.

    {
        fSmallStepDriver->OnComputeStep();
        fLargeStepDriver->OnComputeStep();
    }

References fLargeStepDriver, and fSmallStepDriver.

◆ OnStartTracking()

virtual void G4BFieldIntegrationDriver::OnStartTracking ( )

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 127 of file G4BFieldIntegrationDriver.hh.

    {
        fSmallStepDriver->OnStartTracking();
        fLargeStepDriver->OnStartTracking();
    }

References fLargeStepDriver, and fSmallStepDriver.

◆ operator=()

const G4BFieldIntegrationDriver & G4BFieldIntegrationDriver::operator= ( const G4BFieldIntegrationDriver & )

delete

◆ PrintStatistics()

void G4BFieldIntegrationDriver::PrintStatistics ( ) const

Definition at line 148 of file G4BFieldIntegrationDriver.cc.

{
    const auto totSteps = fSmallDriverSteps + fLargeDriverSteps;
    const auto toFraction = [&](double value) { return value / totSteps * 100; };
 
    G4cout << "============= G4BFieldIntegrationDriver statistics ===========\n"
           << "total steps " << totSteps << " "
           << "smallDriverSteps " << toFraction(fSmallDriverSteps) << " "
           << "largeDriverSteps " << toFraction(fLargeDriverSteps) << "\n"
           << "======================================\n";
}

References fLargeDriverSteps, fSmallDriverSteps, and G4cout.

◆ QuickAdvance()

virtual G4bool G4VIntegrationDriver::QuickAdvance	(	G4FieldTrack &	,
		const	G4double[],
		G4double	,
		G4double &	,
		G4double &
	)

inlinevirtualinherited

Reimplemented in G4FSALIntegrationDriver< T >, G4IntegrationDriver< T >, G4MagInt_Driver, G4OldMagIntDriver, and G4IntegrationDriver< G4BulirschStoer >.

Definition at line 83 of file G4VIntegrationDriver.hh.

87 { return false; }

◆ RenewStepperAndAdjust()

void G4VIntegrationDriver::RenewStepperAndAdjust ( G4MagIntegratorStepper * pItsStepper )

virtualinherited

Reimplemented in G4MagInt_Driver, G4OldMagIntDriver, and G4RKIntegrationDriver< T >.

Definition at line 34 of file G4VIntegrationDriver.cc.

{
  G4Exception("G4VIntegrationDriver::RenewStepperAndAdjust",
              "Geometry001", FatalException,
       "This method exists only for the original G4MagIntegratorDriver class. "
       "Not defined for other classes derived from G4VIntegrationDriver");
}

References FatalException, and G4Exception().

◆ SetEquationOfMotion()

void G4BFieldIntegrationDriver::SetEquationOfMotion ( G4EquationOfMotion * equation )

overridevirtual

Implements G4VIntegrationDriver.

Definition at line 109 of file G4BFieldIntegrationDriver.cc.

{
    fEquation = toMagneticEquation(equation);
    fSmallStepDriver->SetEquationOfMotion(equation);
    fLargeStepDriver->SetEquationOfMotion(equation);
}

References fEquation, fLargeStepDriver, fSmallStepDriver, and anonymous_namespace{G4BFieldIntegrationDriver.cc}::toMagneticEquation().

◆ SetVerboseLevel()

virtual void G4BFieldIntegrationDriver::SetVerboseLevel ( G4int level )

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 110 of file G4BFieldIntegrationDriver.hh.

    {
        fSmallStepDriver->SetVerboseLevel(level);
        fLargeStepDriver->SetVerboseLevel(level);
    }

References fLargeStepDriver, and fSmallStepDriver.

◆ StreamInfo()

virtual void G4BFieldIntegrationDriver::StreamInfo ( std::ostream & os ) const

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 133 of file G4BFieldIntegrationDriver.hh.

    {
       os << "Small Step Driver Info: " << std::endl;
       fSmallStepDriver->StreamInfo(os);
       os << "Large Step Driver Info: " << std::endl;        
       fLargeStepDriver->StreamInfo(os);
    }