G4BogackiShampine23 Class Reference

G4BogackiShampine23 is an integrator of particle's equation of motion based on the Bogacki-Shampine non-FSAL implementation. More...

#include <G4BogackiShampine23.hh>

Inheritance diagram for G4BogackiShampine23:

Public Member Functions
	G4BogackiShampine23 (G4EquationOfMotion *EqRhs, G4int numberOfVariables=6)
	~G4BogackiShampine23 () override=default
	G4BogackiShampine23 (const G4BogackiShampine23 &)=delete
G4BogackiShampine23 &	operator= (const G4BogackiShampine23 &)=delete
void	Stepper (const G4double yInput[], const G4double dydx[], G4double hstep, G4double yOutput[], G4double yError[]) override
void	Stepper (const G4double yInput[], const G4double dydx[], G4double hstep, G4double yOutput[], G4double yError[], G4double dydxOutput[])
G4double	DistChord () const override
G4int	IntegratorOrder () const override
G4StepperType	StepperType () const override
Public Member Functions inherited from G4MagIntegratorStepper
	G4MagIntegratorStepper (G4EquationOfMotion *Equation, G4int numIntegrationVariables, G4int numStateVariables=12, G4bool isFSAL=false)
virtual	~G4MagIntegratorStepper ()=default
	G4MagIntegratorStepper (const G4MagIntegratorStepper &)=delete
G4MagIntegratorStepper &	operator= (const G4MagIntegratorStepper &)=delete
void	NormaliseTangentVector (G4double vec[6])
void	NormalisePolarizationVector (G4double vec[12])
void	RightHandSide (const G4double y[], G4double dydx[]) const
void	RightHandSide (const G4double y[], G4double dydx[], G4double field[]) const
G4int	GetNumberOfVariables () const
G4int	GetNumberOfStateVariables () const
G4int	IntegrationOrder ()
G4EquationOfMotion *	GetEquationOfMotion ()
const G4EquationOfMotion *	GetEquationOfMotion () const
void	SetEquationOfMotion (G4EquationOfMotion *newEquation)
unsigned long	GetfNoRHSCalls ()
void	ResetfNORHSCalls ()
G4bool	IsFSAL () const
G4bool	isQSS () const
void	SetIsQSS (G4bool val)

Additional Inherited Members
Protected Member Functions inherited from G4MagIntegratorStepper
void	SetIntegrationOrder (G4int order)
void	SetFSAL (G4bool flag=true)

Detailed Description

G4BogackiShampine23 is an integrator of particle's equation of motion based on the Bogacki-Shampine non-FSAL implementation.

Definition at line 55 of file G4BogackiShampine23.hh.

Constructor & Destructor Documentation

G4BogackiShampine23() [1/2]

G4BogackiShampine23::G4BogackiShampine23	(	G4EquationOfMotion *	EqRhs,
		G4int	numberOfVariables = 6 )

Constructor for G4BogackiShampine23.

Parameters

[in]	EqRhs	Pointer to the provided equation of motion.
[in]	numberOfVariables	The number of integration variables.

Definition at line 55 of file G4BogackiShampine23.cc.

  : G4MagIntegratorStepper(EqRhs, integrationVariables)
{
  SetIntegrationOrder(3);
  SetFSAL(true);
}

Referenced by G4BogackiShampine23(), and operator=().

~G4BogackiShampine23()

G4BogackiShampine23::~G4BogackiShampine23 ( )

overridedefault

Default Destructor.

G4BogackiShampine23() [2/2]

G4BogackiShampine23::G4BogackiShampine23 ( const G4BogackiShampine23 & )

delete

Copy constructor and assignment operator not allowed.

Member Function Documentation

DistChord()

G4double G4BogackiShampine23::DistChord ( ) const

overridevirtual

Returns the distance from chord line.

Implements G4MagIntegratorStepper.

Definition at line 148 of file G4BogackiShampine23.cc.

{
  G4double yMid[G4FieldTrack::ncompSVEC];
  makeStep(fyIn, fdydx, fhstep / 2., yMid);
 
  const G4ThreeVector begin = makeVector(fyIn, Value3D::Position);
  const G4ThreeVector mid = makeVector(yMid, Value3D::Position);
  const G4ThreeVector end = makeVector(fyOut, Value3D::Position);
 
  return G4LineSection::Distline(mid, begin, end);
}

IntegratorOrder()

G4int G4BogackiShampine23::IntegratorOrder ( ) const

inlineoverridevirtual

Returns the order, 3, of integration.

Implements G4MagIntegratorStepper.

Definition at line 119 of file G4BogackiShampine23.hh.

{ return 3; }

operator=()

G4BogackiShampine23 & G4BogackiShampine23::operator= ( const G4BogackiShampine23 & )

delete

Stepper() [1/2]

void G4BogackiShampine23::Stepper ( const G4double yInput[], const G4double dydx[], G4double hstep, G4double yOutput[], G4double yError[] )

overridevirtual

The stepper for the Runge Kutta integration. The stepsize is fixed, with the step size given by 'hstep'. Integrates ODE starting values yInput[0 to 6]. Outputs yOutput[] and its estimated error yError[].

Parameters

[in]	yInput	Starting values array of integration variables.
[in]	dydx	Derivatives array.
[in]	hstep	The given step size.
[out]	yOutput	Integration output.
[out]	yError	The estimated error.

Implements G4MagIntegratorStepper.

Definition at line 116 of file G4BogackiShampine23.cc.

{
  copy(fyIn, yInput);
  copy(fdydx, dydx);
  fhstep = hstep;
 
  makeStep(fyIn, fdydx, fhstep, fyOut, fdydxOut, yError);
 
  copy(yOutput, fyOut);
}

Stepper() [2/2]

void G4BogackiShampine23::Stepper	(	const G4double	yInput[],
		const G4double	dydx[],
		G4double	hstep,
		G4double	yOutput[],
		G4double	yError[],
		G4double	dydxOutput[] )

Same as the Stepper() function above, with dydx also in ouput.

Parameters

[in]	yInput	Starting values array of integration variables.
[in]	dydx	Derivatives array.
[in]	hstep	The given step size.
[out]	yOutput	Integration output.
[out]	yError	The estimated error.
[out]	dydxOutput	dydx in output.

Definition at line 131 of file G4BogackiShampine23.cc.

{
  copy(fyIn, yInput);
  copy(fdydx, dydx);
  fhstep = hstep;
 
  makeStep(fyIn, fdydx, fhstep, fyOut, fdydxOut, yError);
 
  copy(yOutput, fyOut);
  copy(dydxOutput, fdydxOut);
}

StepperType()

G4StepperType G4BogackiShampine23::StepperType ( ) const

inlineoverridevirtual

Returns the stepper type-ID, "kBogackiShampine23".

Reimplemented from G4MagIntegratorStepper.

Definition at line 124 of file G4BogackiShampine23.hh.

{ return kBogackiShampine23; }

---

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

• G4BogackiShampine23.hh
• G4BogackiShampine23.cc