G4BFieldIntegrationDriver Class Reference

#include <G4BFieldIntegrationDriver.hh>

Inheritance diagram for G4BFieldIntegrationDriver:

Public Member Functions
	G4BFieldIntegrationDriver (std::unique_ptr< G4VIntegrationDriver > smallStepDriver, std::unique_ptr< G4VIntegrationDriver > largeStepDriver)
	G4BFieldIntegrationDriver (const G4BFieldIntegrationDriver &)=delete
const G4BFieldIntegrationDriver &	operator= (const G4BFieldIntegrationDriver &)=delete
G4double	AdvanceChordLimited (G4FieldTrack &track, G4double hstep, G4double eps, G4double chordDistance) override
G4bool	AccurateAdvance (G4FieldTrack &track, G4double hstep, G4double eps, G4double hinitial=0) override
G4bool	DoesReIntegrate () const override
void	GetDerivatives (const G4FieldTrack &track, G4double dydx[]) const override
void	GetDerivatives (const G4FieldTrack &track, G4double dydx[], G4double field[]) const override
void	SetEquationOfMotion (G4EquationOfMotion *equation) override
G4EquationOfMotion *	GetEquationOfMotion () override
const G4MagIntegratorStepper *	GetStepper () const override
G4MagIntegratorStepper *	GetStepper () override
G4double	ComputeNewStepSize (G4double errMaxNorm, G4double hstepCurrent) override
void	SetVerboseLevel (G4int level) override
G4int	GetVerboseLevel () const override
void	OnComputeStep (const G4FieldTrack *track) override
void	OnStartTracking () override
void	StreamInfo (std::ostream &os) const override
void	PrintStatistics () const
Public Member Functions inherited from G4VIntegrationDriver
virtual	~G4VIntegrationDriver ()=default
virtual void	RenewStepperAndAdjust (G4MagIntegratorStepper *pItsStepper)
virtual G4bool	QuickAdvance (G4FieldTrack &, const G4double[], G4double, G4double &, G4double &)

Additional Inherited Members
Static Protected Attributes inherited from G4VIntegrationDriver
static constexpr G4double	max_stepping_increase = 5
static constexpr G4double	max_stepping_decrease = 0.1

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

G4BFieldIntegrationDriver() [2/2]

G4BFieldIntegrationDriver::G4BFieldIntegrationDriver ( const G4BFieldIntegrationDriver & )

delete

Member Function Documentation

AccurateAdvance()

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

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

ComputeNewStepSize()

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

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 104 of file G4BFieldIntegrationDriver.hh.

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

DoesReIntegrate()

G4bool G4BFieldIntegrationDriver::DoesReIntegrate ( ) const

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 66 of file G4BFieldIntegrationDriver.hh.

    {
      return fCurrDriver->DoesReIntegrate();
    }

GetDerivatives() [1/2]

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

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 72 of file G4BFieldIntegrationDriver.hh.

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

GetDerivatives() [2/2]

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

GetEquationOfMotion()

G4EquationOfMotion * G4BFieldIntegrationDriver::GetEquationOfMotion ( )

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 88 of file G4BFieldIntegrationDriver.hh.

    {
      return fCurrDriver->GetEquationOfMotion();
    }

GetStepper() [1/2]

const G4MagIntegratorStepper * G4BFieldIntegrationDriver::GetStepper ( ) const

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 94 of file G4BFieldIntegrationDriver.hh.

    {
      return fCurrDriver->GetStepper();
    }

GetStepper() [2/2]

G4MagIntegratorStepper * G4BFieldIntegrationDriver::GetStepper ( )

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 99 of file G4BFieldIntegrationDriver.hh.

    {
      return fCurrDriver->GetStepper();
    }

GetVerboseLevel()

G4int G4BFieldIntegrationDriver::GetVerboseLevel ( ) const

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 116 of file G4BFieldIntegrationDriver.hh.

    {
      return fCurrDriver->GetVerboseLevel();
    }

OnComputeStep()

void G4BFieldIntegrationDriver::OnComputeStep ( const G4FieldTrack * track )

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 121 of file G4BFieldIntegrationDriver.hh.

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

OnStartTracking()

void G4BFieldIntegrationDriver::OnStartTracking ( )

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 127 of file G4BFieldIntegrationDriver.hh.

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

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

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

SetVerboseLevel()

void G4BFieldIntegrationDriver::SetVerboseLevel ( G4int level )

inlineoverridevirtual

Implements G4VIntegrationDriver.

Definition at line 110 of file G4BFieldIntegrationDriver.hh.

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

StreamInfo()

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

---

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

• G4BFieldIntegrationDriver.hh
• G4BFieldIntegrationDriver.cc