G4MagIntegratorStepper Class Reference

#include <G4MagIntegratorStepper.hh>

Inheritance diagram for G4MagIntegratorStepper:

Public Member Functions
virtual G4double	DistChord () const =0
	G4MagIntegratorStepper (const G4MagIntegratorStepper &)=delete
	G4MagIntegratorStepper (G4EquationOfMotion *Equation, G4int numIntegrationVariables, G4int numStateVariables=12, G4bool isFSAL=false)
G4EquationOfMotion *	GetEquationOfMotion ()
const G4EquationOfMotion *	GetEquationOfMotion () const
unsigned long	GetfNoRHSCalls ()
G4int	GetNumberOfStateVariables () const
G4int	GetNumberOfVariables () const
G4int	IntegrationOrder ()
virtual G4int	IntegratorOrder () const =0
G4bool	IsFSAL () const
void	NormalisePolarizationVector (G4double vec[12])
void	NormaliseTangentVector (G4double vec[6])
G4MagIntegratorStepper &	operator= (const G4MagIntegratorStepper &)=delete
void	ResetfNORHSCalls ()
void	RightHandSide (const G4double y[], G4double dydx[]) const
void	RightHandSide (const G4double y[], G4double dydx[], G4double field[]) const
void	SetEquationOfMotion (G4EquationOfMotion *newEquation)
virtual void	Stepper (const G4double y[], const G4double dydx[], G4double h, G4double yout[], G4double yerr[])=0
virtual	~G4MagIntegratorStepper ()=default

Protected Member Functions
void	SetFSAL (G4bool flag=true)
void	SetIntegrationOrder (G4int order)

Private Attributes
G4EquationOfMotion *	fEquation_Rhs = nullptr
G4int	fIntegrationOrder = -1
G4bool	fIsFSAL = false
const G4int	fNoIntegrationVariables = 0
unsigned long	fNoRHSCalls = 0UL
const G4int	fNoStateVariables = 0

Detailed Description

Definition at line 47 of file G4MagIntegratorStepper.hh.

Constructor & Destructor Documentation

G4MagIntegratorStepper() [1/2]

G4MagIntegratorStepper::G4MagIntegratorStepper	(	G4EquationOfMotion *	Equation,
		G4int	numIntegrationVariables,
		G4int	numStateVariables = 12,
		G4bool	isFSAL = false
	)

Definition at line 37 of file G4MagIntegratorStepper.cc.

  : fEquation_Rhs(Equation),
    fNoIntegrationVariables(num_integration_vars),
    fNoStateVariables(std::max(num_state_vars,8)),
    fIsFSAL(isFSAL)
{
  if( Equation == nullptr ) {
     G4Exception( "G4MagIntegratorStepper::G4MagIntegratorStepper", "GeomField0003",
                  FatalErrorInArgument, "Must have non-null equation." );
  }
  assert( Equation != nullptr );
}

References FatalErrorInArgument, and G4Exception().

~G4MagIntegratorStepper()

virtual G4MagIntegratorStepper::~G4MagIntegratorStepper ( )

virtualdefault

G4MagIntegratorStepper() [2/2]

G4MagIntegratorStepper::G4MagIntegratorStepper ( const G4MagIntegratorStepper &  )

delete

Member Function Documentation

DistChord()

virtual G4double G4MagIntegratorStepper::DistChord ( ) const

pure virtual

Implemented in G4BogackiShampine45, G4CashKarpRKF45, G4ConstRK4, G4DoLoMcPriRK34, G4DormandPrinceRK56, G4DormandPrinceRK78, G4ExactHelixStepper, G4HelixExplicitEuler, G4HelixMixedStepper, G4MagErrorStepper, G4MagHelicalStepper, G4RKG3_Stepper, G4TsitourasRK45, G4BogackiShampine23, G4DormandPrince745, G4NystromRK4, G4RK547FEq1, G4RK547FEq2, G4RK547FEq3, G4TCashKarpRKF45< T_Equation, N >, G4TDormandPrince45< T_Equation, N >, G4TMagErrorStepper< T_Stepper, T_Equation, N >, G4TMagErrorStepper< G4TClassicalRK4< T_Equation, N >, T_Equation, N >, G4TMagErrorStepper< G4TExplicitEuler< T_Equation, N >, T_Equation, N >, G4TMagErrorStepper< G4TSimpleHeum< T_Equation, N >, T_Equation, N >, and G4TMagErrorStepper< G4TSimpleRunge< T_Equation, N >, T_Equation, N >.

GetEquationOfMotion() [1/2]

G4EquationOfMotion * G4MagIntegratorStepper::GetEquationOfMotion ( )

inline

Referenced by G4MagInt_Driver::GetEquationOfMotion(), G4OldMagIntDriver::GetEquationOfMotion(), G4NystromRK4::GetField(), G4DormandPrince745::GetSpecificEquation(), G4NystromRK4::SetDistanceForConstantField(), G4RKG3_Stepper::StepNoErr(), and G4RKG3_Stepper::Stepper().

GetEquationOfMotion() [2/2]

const G4EquationOfMotion * G4MagIntegratorStepper::GetEquationOfMotion ( ) const

inline

GetfNoRHSCalls()

unsigned long G4MagIntegratorStepper::GetfNoRHSCalls ( )

inline

GetNumberOfStateVariables()

G4int G4MagIntegratorStepper::GetNumberOfStateVariables ( ) const

inline

Referenced by G4BogackiShampine45::G4BogackiShampine45(), G4CashKarpRKF45::G4CashKarpRKF45(), G4SimpleRunge::G4SimpleRunge(), G4TSimpleRunge< T_Equation, N >::G4TSimpleRunge(), G4TsitourasRK45::G4TsitourasRK45(), G4BogackiShampine23::makeStep(), G4RK547FEq1::makeStep(), G4RK547FEq2::makeStep(), G4RK547FEq3::makeStep(), G4ConstRK4::Stepper(), G4MagErrorStepper::Stepper(), and G4TMagErrorStepper< T_Stepper, T_Equation, N >::Stepper().

GetNumberOfVariables()

G4int G4MagIntegratorStepper::GetNumberOfVariables ( ) const

inline

Referenced by G4ExplicitEuler::DumbStepper(), G4ImplicitEuler::DumbStepper(), G4ClassicalRK4::DumbStepper(), G4ChordFinder::G4ChordFinder(), G4BogackiShampine45::GetLastDydx(), G4DoLoMcPriRK34::Interpolate(), G4TsitourasRK45::Interpolate(), G4DormandPrince745::Interpolate4thOrder(), G4DormandPrince745::Interpolate5thOrder(), G4DormandPrinceRK56::Interpolate_high(), G4DormandPrinceRK56::Interpolate_low(), G4BogackiShampine45::InterpolateHigh(), G4BogackiShampine23::makeStep(), G4RK547FEq1::makeStep(), G4RK547FEq2::makeStep(), G4RK547FEq3::makeStep(), G4DormandPrinceRK56::SetupInterpolate_high(), G4DormandPrinceRK56::SetupInterpolate_low(), G4DormandPrince745::SetupInterpolation5thOrder(), G4BogackiShampine45::SetupInterpolationHigh(), G4BogackiShampine45::Stepper(), G4CashKarpRKF45::Stepper(), G4DoLoMcPriRK34::Stepper(), G4DormandPrinceRK56::Stepper(), G4DormandPrinceRK78::Stepper(), G4MagErrorStepper::Stepper(), G4TsitourasRK45::Stepper(), and G4DormandPrince745::Stepper().

IntegrationOrder()

G4int G4MagIntegratorStepper::IntegrationOrder ( )

inline

IntegratorOrder()

virtual G4int G4MagIntegratorStepper::IntegratorOrder ( ) const

pure virtual

Implemented in G4BogackiShampine45, G4CashKarpRKF45, G4ClassicalRK4, G4ConstRK4, G4DoLoMcPriRK34, G4DormandPrinceRK56, G4DormandPrinceRK78, G4ExactHelixStepper, G4ExplicitEuler, G4HelixExplicitEuler, G4HelixHeum, G4HelixImplicitEuler, G4HelixMixedStepper, G4HelixSimpleRunge, G4ImplicitEuler, G4RKG3_Stepper, G4SimpleHeum, G4SimpleRunge, G4TClassicalRK4< T_Equation, N >, G4TExplicitEuler< T_Equation, N >, G4TSimpleHeum< T_Equation, N >, G4TSimpleRunge< T_Equation, N >, G4TsitourasRK45, G4BogackiShampine23, G4DormandPrince745, G4NystromRK4, G4RK547FEq1, G4RK547FEq2, G4RK547FEq3, G4TCashKarpRKF45< T_Equation, N >, and G4TDormandPrince45< T_Equation, N >.

Referenced by G4MagInt_Driver::G4MagInt_Driver(), G4OldMagIntDriver::G4OldMagIntDriver(), and G4MagErrorStepper::Stepper().

IsFSAL()

G4bool G4MagIntegratorStepper::IsFSAL ( ) const

inline

NormalisePolarizationVector()

void G4MagIntegratorStepper::NormalisePolarizationVector ( G4double  vec[12] )

inline

Referenced by G4SimpleHeum::DumbStepper(), and G4ClassicalRK4::DumbStepper().

NormaliseTangentVector()

void G4MagIntegratorStepper::NormaliseTangentVector ( G4double  vec[6] )

inline

operator=()

G4MagIntegratorStepper & G4MagIntegratorStepper::operator= ( const G4MagIntegratorStepper &  )

delete

ResetfNORHSCalls()

void G4MagIntegratorStepper::ResetfNORHSCalls ( )

inline

RightHandSide() [1/2]

void G4MagIntegratorStepper::RightHandSide ( const G4double  y[], G4double  dydx[]  ) const

inline

Referenced by G4MagInt_Driver::AccurateAdvance(), G4OldMagIntDriver::AccurateAdvance(), G4ImplicitEuler::DumbStepper(), G4SimpleHeum::DumbStepper(), G4SimpleRunge::DumbStepper(), G4ClassicalRK4::DumbStepper(), G4MagInt_Driver::GetDerivatives(), G4OldMagIntDriver::GetDerivatives(), G4BogackiShampine23::makeStep(), G4RK547FEq1::makeStep(), G4RK547FEq2::makeStep(), G4RK547FEq3::makeStep(), G4DormandPrinceRK56::SetupInterpolate_high(), G4DormandPrinceRK56::SetupInterpolate_low(), G4DormandPrince745::SetupInterpolation5thOrder(), G4BogackiShampine45::SetupInterpolationHigh(), G4BogackiShampine45::Stepper(), G4CashKarpRKF45::Stepper(), G4DoLoMcPriRK34::Stepper(), G4DormandPrinceRK56::Stepper(), G4DormandPrinceRK78::Stepper(), G4MagErrorStepper::Stepper(), G4TsitourasRK45::Stepper(), and G4DormandPrince745::Stepper().

RightHandSide() [2/2]

void G4MagIntegratorStepper::RightHandSide ( const G4double  y[], G4double  dydx[], G4double  field[]  ) const

inline

SetEquationOfMotion()

void G4MagIntegratorStepper::SetEquationOfMotion ( G4EquationOfMotion *  newEquation )

inline

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

SetFSAL()

void G4MagIntegratorStepper::SetFSAL ( G4bool  flag = true )

inlineprotected

Referenced by G4BogackiShampine23::G4BogackiShampine23().

SetIntegrationOrder()

void G4MagIntegratorStepper::SetIntegrationOrder ( G4int  order )

inlineprotected

Referenced by G4BogackiShampine23::G4BogackiShampine23().

Stepper()

virtual void G4MagIntegratorStepper::Stepper ( const G4double  y[], const G4double  dydx[], G4double  h, G4double  yout[], G4double  yerr[]  )

pure virtual

Implemented in G4BogackiShampine45, G4CashKarpRKF45, G4ConstRK4, G4DoLoMcPriRK34, G4DormandPrinceRK56, G4DormandPrinceRK78, G4ExactHelixStepper, G4HelixMixedStepper, G4MagErrorStepper, G4MagHelicalStepper, G4TsitourasRK45, G4NystromRK4, G4RKG3_Stepper, G4BogackiShampine23, G4DormandPrince745, G4RK547FEq1, G4RK547FEq2, G4RK547FEq3, G4TCashKarpRKF45< T_Equation, N >, G4TDormandPrince45< T_Equation, N >, G4TMagErrorStepper< T_Stepper, T_Equation, N >, G4TMagErrorStepper< G4TClassicalRK4< T_Equation, N >, T_Equation, N >, G4TMagErrorStepper< G4TExplicitEuler< T_Equation, N >, T_Equation, N >, G4TMagErrorStepper< G4TSimpleHeum< T_Equation, N >, T_Equation, N >, and G4TMagErrorStepper< G4TSimpleRunge< T_Equation, N >, T_Equation, N >.

Referenced by G4HelixMixedStepper::Stepper().

Field Documentation

fEquation_Rhs

G4EquationOfMotion* G4MagIntegratorStepper::fEquation_Rhs = nullptr

private

Definition at line 124 of file G4MagIntegratorStepper.hh.

fIntegrationOrder

G4int G4MagIntegratorStepper::fIntegrationOrder = -1

private

Definition at line 134 of file G4MagIntegratorStepper.hh.

fIsFSAL

G4bool G4MagIntegratorStepper::fIsFSAL = false

private

Definition at line 136 of file G4MagIntegratorStepper.hh.

fNoIntegrationVariables

const G4int G4MagIntegratorStepper::fNoIntegrationVariables = 0

private

Definition at line 125 of file G4MagIntegratorStepper.hh.

fNoRHSCalls

unsigned long G4MagIntegratorStepper::fNoRHSCalls = 0UL

mutableprivate

Definition at line 128 of file G4MagIntegratorStepper.hh.

fNoStateVariables

const G4int G4MagIntegratorStepper::fNoStateVariables = 0

private

Definition at line 126 of file G4MagIntegratorStepper.hh.

---

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

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