Geant4 11.4.0
Toolkit for the simulation of the passage of particles through matter
Loading...
Searching...
No Matches
G4HelixImplicitEuler Class Reference

G4HelixImplicitEuler implements a helix implicit Euler stepper for magnetic field with 2nd order solver. More...

#include <G4HelixImplicitEuler.hh>

Inheritance diagram for G4HelixImplicitEuler:

Public Member Functions

 G4HelixImplicitEuler (G4Mag_EqRhs *EqRhs)
 ~G4HelixImplicitEuler () 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
G4MagHelicalStepperoperator= (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
G4MagIntegratorStepperoperator= (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 ()
G4EquationOfMotionGetEquationOfMotion ()
const G4EquationOfMotionGetEquationOfMotion () 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

G4HelixImplicitEuler implements a helix implicit Euler stepper for magnetic field with 2nd order solver.

Definition at line 50 of file G4HelixImplicitEuler.hh.

Constructor & Destructor Documentation

◆ G4HelixImplicitEuler()

G4HelixImplicitEuler::G4HelixImplicitEuler ( G4Mag_EqRhs * EqRhs)

Constructor for G4HelixImplicitEuler.

Parameters
[in]EqRhsPointer to the provided equation of motion.

Definition at line 42 of file G4HelixImplicitEuler.cc.

43 : G4MagHelicalStepper(EqRhs)
44{
45}
G4MagHelicalStepper(G4Mag_EqRhs *EqRhs)

◆ ~G4HelixImplicitEuler()

G4HelixImplicitEuler::~G4HelixImplicitEuler ( )
overridedefault

Default Destructor.

Member Function Documentation

◆ DumbStepper()

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

The stepper function for the integration.

Parameters
[in]yStarting values array of integration variables.
[in]BfldDerivatives array.
[in]hThe given step size.
[out]youtIntegration output.

Implements G4MagHelicalStepper.

Definition at line 48 of file G4HelixImplicitEuler.cc.

52{
53 const G4int nvar = 6 ;
54 G4double yTemp[6], yTemp2[6];
55 G4ThreeVector Bfld_endpoint;
56
57 // Step forward like in the explicit euler case
58 //
59 AdvanceHelix( yIn, Bfld, h, yTemp);
60
61 // now obtain the new field value at the new point
62 //
63 MagFieldEvaluate(yTemp, Bfld_endpoint);
64
65 // and also advance along a helix for this field value
66 //
67 AdvanceHelix( yIn, Bfld_endpoint, h, yTemp2);
68
69 // we take the average
70 //
71 for( G4int i = 0; i < nvar; ++i )
72 {
73 yOut[i] = 0.5 * ( yTemp[i] + yTemp2[i] );
74 }
75
76 // NormaliseTangentVector( yOut );
77}
CLHEP::Hep3Vector G4ThreeVector
double G4double
Definition G4Types.hh:83
int G4int
Definition G4Types.hh:85
void MagFieldEvaluate(const G4double y[], G4ThreeVector &Bfield)
void AdvanceHelix(const G4double yIn[], const G4ThreeVector &Bfld, G4double h, G4double yHelix[], G4double yHelix2[]=nullptr)

◆ IntegratorOrder()

G4int G4HelixImplicitEuler::IntegratorOrder ( ) const
inlineoverridevirtual

Returns the order, 2, of integration.

Implements G4MagIntegratorStepper.

Definition at line 80 of file G4HelixImplicitEuler.hh.

80{ return 2; }

◆ StepperType()

G4StepperType G4HelixImplicitEuler::StepperType ( ) const
inlineoverridevirtual

Returns the stepper type-ID, "kHelixImplicitEuler".

Reimplemented from G4MagIntegratorStepper.

Definition at line 85 of file G4HelixImplicitEuler.hh.

85{ return kHelixImplicitEuler; }
@ kHelixImplicitEuler
G4HelixImplicitEuler.

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