G4HelixHeum Class Reference

G4HelixHeum implements a simple Heum stepper for magnetic field with 3rd order solver. More...

#include <G4HelixHeum.hh>

Inheritance diagram for G4HelixHeum:

Public Member Functions
	G4HelixHeum (G4Mag_EqRhs *EqRhs)
	~G4HelixHeum () override=default
void	DumbStepper (const G4double y[], G4ThreeVector Bfld, G4double h, G4double yout[]) override
G4int	IntegratorOrder () const override
G4StepperType	StepperType () const override
Public Member Functions inherited from G4MagHelicalStepper
	G4MagHelicalStepper (G4Mag_EqRhs *EqRhs)
	~G4MagHelicalStepper () override=default
	G4MagHelicalStepper (const G4MagHelicalStepper &)=delete
G4MagHelicalStepper &	operator= (const G4MagHelicalStepper &)=delete
void	Stepper (const G4double y[], const G4double dydx[], G4double h, G4double yout[], G4double yerr[]) override
G4double	DistChord () 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 G4MagHelicalStepper
void	LinearStep (const G4double yIn[], G4double h, G4double yHelix[]) const
void	AdvanceHelix (const G4double yIn[], const G4ThreeVector &Bfld, G4double h, G4double yHelix[], G4double yHelix2[]=nullptr)
void	MagFieldEvaluate (const G4double y[], G4ThreeVector &Bfield)
G4double	GetInverseCurve (const G4double Momentum, const G4double Bmag)
void	SetAngCurve (const G4double Ang)
G4double	GetAngCurve () const
void	SetCurve (const G4double Curve)
G4double	GetCurve () const
void	SetRadHelix (const G4double Rad)
G4double	GetRadHelix () const
Protected Member Functions inherited from G4MagIntegratorStepper
void	SetIntegrationOrder (G4int order)
void	SetFSAL (G4bool flag=true)

Detailed Description

G4HelixHeum implements a simple Heum stepper for magnetic field with 3rd order solver.

Definition at line 48 of file G4HelixHeum.hh.

Constructor & Destructor Documentation

G4HelixHeum()

G4HelixHeum::G4HelixHeum

(

G4Mag_EqRhs *

EqRhs

)

Constructor for G4HelixHeum.

Parameters

[in]

EqRhs

Pointer to the provided equation of motion.

Definition at line 41 of file G4HelixHeum.cc.

  : G4MagHelicalStepper(EqRhs)
{
}

~G4HelixHeum()

G4HelixHeum::~G4HelixHeum ( )

overridedefault

Default Destructor.

Member Function Documentation

DumbStepper()

void G4HelixHeum::DumbStepper ( const G4double y[], G4ThreeVector Bfld, G4double h, G4double yout[] )

overridevirtual

The stepper function for the integration.

Parameters

[in]	y	Starting values array of integration variables.
[in]	Bfld	The field vector.
[in]	h	The given step size.
[out]	yout	Integration output.

Implements G4MagHelicalStepper.

Definition at line 47 of file G4HelixHeum.cc.

{
  const G4int nvar = 6 ;
 
  G4ThreeVector Bfield_Temp, Bfield_Temp2;
  G4double yTemp[6], yAdd1[6], yAdd2[6] , yTemp2[6];
 
  AdvanceHelix( yIn, Bfld, h, yAdd1 );
  
  AdvanceHelix( yIn, Bfld, h/3.0, yTemp );
  MagFieldEvaluate(yTemp,Bfield_Temp);
 
  AdvanceHelix( yIn, Bfield_Temp, (2.0 / 3.0) * h, yTemp2 );
  
  MagFieldEvaluate(yTemp2,Bfield_Temp2);
 
  AdvanceHelix( yIn, Bfield_Temp2, h, yAdd2 );
 
  for( G4int i = 0; i < nvar; ++i )
  {
    yOut[i] = ( 0.25 * yAdd1[i] + 0.75 * yAdd2[i]);
  }
 
  // NormaliseTangentVector( yOut );           
}  

IntegratorOrder()

G4int G4HelixHeum::IntegratorOrder ( ) const

inlineoverridevirtual

Returns the order, 2, of integration.

Implements G4MagIntegratorStepper.

Definition at line 78 of file G4HelixHeum.hh.

{ return 2; }

StepperType()

G4StepperType G4HelixHeum::StepperType ( ) const

inlineoverridevirtual

Returns the stepper type-ID, "kHelixHeum".

Reimplemented from G4MagIntegratorStepper.

Definition at line 83 of file G4HelixHeum.hh.

{ return kHelixHeum; }

---

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

• G4HelixHeum.hh
• G4HelixHeum.cc