G4VIntegrationDriver Class Reference

#include <G4VIntegrationDriver.hh>

Inheritance diagram for G4VIntegrationDriver:

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

Static Protected Attributes
static constexpr G4double	max_stepping_decrease = 0.1
static constexpr G4double	max_stepping_increase = 5

Friends
std::ostream &	operator<< (std::ostream &os, const G4VIntegrationDriver &id)

Detailed Description

Definition at line 51 of file G4VIntegrationDriver.hh.

Constructor & Destructor Documentation

~G4VIntegrationDriver()

virtual G4VIntegrationDriver::~G4VIntegrationDriver ( )

virtualdefault

Member Function Documentation

AccurateAdvance()

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

pure virtual

Implemented in G4BFieldIntegrationDriver, G4IntegrationDriver< T >, G4InterpolationDriver< T >, G4FSALIntegrationDriver< T >, G4IntegrationDriver< G4BulirschStoer >, G4MagInt_Driver, and G4OldMagIntDriver.

Referenced by G4BFieldIntegrationDriver::AccurateAdvance(), G4ChordFinder::ApproxCurvePointS(), G4ChordFinder::ApproxCurvePointV(), and G4BrentLocator::EstimateIntersectionPoint().

AdvanceChordLimited()

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

pure virtual

Implemented in G4BFieldIntegrationDriver, G4IntegrationDriver< G4BulirschStoer >, G4FSALIntegrationDriver< T >, G4InterpolationDriver< T >, G4IntegrationDriver< T >, G4MagInt_Driver, and G4OldMagIntDriver.

Referenced by G4BFieldIntegrationDriver::AdvanceChordLimited().

ComputeNewStepSize()

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

pure virtual

Implemented in G4BFieldIntegrationDriver, G4IntegrationDriver< G4BulirschStoer >, G4MagInt_Driver, G4OldMagIntDriver, and G4RKIntegrationDriver< T >.

Referenced by G4BFieldIntegrationDriver::ComputeNewStepSize().

DoesReIntegrate()

virtual G4bool G4VIntegrationDriver::DoesReIntegrate ( ) const

pure virtual

Implemented in G4BFieldIntegrationDriver, G4IntegrationDriver< G4BulirschStoer >, G4FSALIntegrationDriver< T >, G4IntegrationDriver< T >, G4InterpolationDriver< T >, G4MagInt_Driver, and G4OldMagIntDriver.

Referenced by G4BFieldIntegrationDriver::DoesReIntegrate(), and G4MultiLevelLocator::EstimateIntersectionPoint().

GetDerivatives() [1/2]

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

pure virtual

Implemented in G4BFieldIntegrationDriver, G4IntegrationDriver< G4BulirschStoer >, G4RKIntegrationDriver< T >, G4MagInt_Driver, and G4OldMagIntDriver.

Referenced by G4BFieldIntegrationDriver::GetDerivatives().

GetDerivatives() [2/2]

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

pure virtual

Implemented in G4BFieldIntegrationDriver, G4IntegrationDriver< G4BulirschStoer >, G4MagInt_Driver, G4OldMagIntDriver, and G4RKIntegrationDriver< T >.

GetEquationOfMotion()

virtual G4EquationOfMotion * G4VIntegrationDriver::GetEquationOfMotion ( )

pure virtual

Implemented in G4BFieldIntegrationDriver, G4IntegrationDriver< G4BulirschStoer >, G4MagInt_Driver, G4OldMagIntDriver, and G4RKIntegrationDriver< T >.

Referenced by G4BFieldIntegrationDriver::GetEquationOfMotion(), G4ErrorPropagatorManager::InitFieldForBackwards(), and G4FieldManager::SetDetectorField().

GetStepper() [1/2]

virtual const G4MagIntegratorStepper * G4VIntegrationDriver::GetStepper ( ) const

pure virtual

Implemented in G4BFieldIntegrationDriver, G4IntegrationDriver< G4BulirschStoer >, G4MagInt_Driver, G4OldMagIntDriver, and G4RKIntegrationDriver< T >.

Referenced by G4BFieldIntegrationDriver::GetStepper().

GetStepper() [2/2]

virtual G4MagIntegratorStepper * G4VIntegrationDriver::GetStepper ( )

pure virtual

Implemented in G4BFieldIntegrationDriver, G4IntegrationDriver< G4BulirschStoer >, G4MagInt_Driver, G4OldMagIntDriver, and G4RKIntegrationDriver< T >.

GetVerboseLevel()

virtual G4int G4VIntegrationDriver::GetVerboseLevel ( ) const

pure virtual

Implemented in G4BFieldIntegrationDriver, G4IntegrationDriver< G4BulirschStoer >, G4FSALIntegrationDriver< T >, G4IntegrationDriver< T >, G4InterpolationDriver< T >, G4MagInt_Driver, and G4OldMagIntDriver.

Referenced by G4BFieldIntegrationDriver::GetVerboseLevel().

OnComputeStep()

virtual void G4VIntegrationDriver::OnComputeStep ( )

pure virtual

Implemented in G4BFieldIntegrationDriver, G4IntegrationDriver< G4BulirschStoer >, G4FSALIntegrationDriver< T >, G4IntegrationDriver< T >, G4InterpolationDriver< T >, G4MagInt_Driver, and G4OldMagIntDriver.

Referenced by G4BFieldIntegrationDriver::AdvanceChordLimited().

OnStartTracking()

virtual void G4VIntegrationDriver::OnStartTracking ( )

pure virtual

Implemented in G4BFieldIntegrationDriver, G4IntegrationDriver< G4BulirschStoer >, G4FSALIntegrationDriver< T >, G4IntegrationDriver< T >, G4InterpolationDriver< T >, G4MagInt_Driver, and G4OldMagIntDriver.

QuickAdvance()

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

inlinevirtual

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

Definition at line 83 of file G4VIntegrationDriver.hh.

                                             { return false; }

RenewStepperAndAdjust()

void G4VIntegrationDriver::RenewStepperAndAdjust ( G4MagIntegratorStepper *  pItsStepper )

virtual

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()

virtual void G4VIntegrationDriver::SetEquationOfMotion ( G4EquationOfMotion *  equation )

pure virtual

Implemented in G4BFieldIntegrationDriver, G4IntegrationDriver< G4BulirschStoer >, G4MagInt_Driver, G4OldMagIntDriver, and G4RKIntegrationDriver< T >.

SetVerboseLevel()

virtual void G4VIntegrationDriver::SetVerboseLevel ( G4int  level )

pure virtual

Implemented in G4BFieldIntegrationDriver, G4IntegrationDriver< G4BulirschStoer >, G4InterpolationDriver< T >, G4FSALIntegrationDriver< T >, G4IntegrationDriver< T >, G4MagInt_Driver, and G4OldMagIntDriver.

Referenced by G4PropagatorInField::SetVerboseLevel().

StreamInfo()

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

pure virtual

Implemented in G4BFieldIntegrationDriver, G4IntegrationDriver< G4BulirschStoer >, G4FSALIntegrationDriver< T >, G4IntegrationDriver< T >, G4InterpolationDriver< T >, G4MagInt_Driver, G4OldMagIntDriver, and G4RKIntegrationDriver< T >.

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const G4VIntegrationDriver &  id  )

friend

Definition at line 43 of file G4VIntegrationDriver.cc.

{
   id.StreamInfo( os );
   return os;
}

Field Documentation

max_stepping_decrease

constexpr G4double G4VIntegrationDriver::max_stepping_decrease = 0.1

staticconstexprprotected

Definition at line 123 of file G4VIntegrationDriver.hh.

Referenced by G4MagInt_Driver::ComputeNewStepSize_WithinLimits(), and G4OldMagIntDriver::ComputeNewStepSize_WithinLimits().

max_stepping_increase

constexpr G4double G4VIntegrationDriver::max_stepping_increase = 5

staticconstexprprotected

Definition at line 122 of file G4VIntegrationDriver.hh.

Referenced by G4OldMagIntDriver::ComputeNewStepSize(), G4MagInt_Driver::ComputeNewStepSize_WithinLimits(), G4OldMagIntDriver::ComputeNewStepSize_WithinLimits(), G4MagInt_Driver::ComputeNewStepSize_WithoutReductionLimit(), G4MagInt_Driver::OneGoodStep(), and G4OldMagIntDriver::OneGoodStep().

---

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

• source/geometry/magneticfield/include/G4VIntegrationDriver.hh
• source/geometry/magneticfield/src/G4VIntegrationDriver.cc