G4ImplicitEuler Class Reference

G4ImplicitEuler implements a Euler stepper for magnetic field with 2nd order solver. More...

#include <G4ImplicitEuler.hh>

Inheritance diagram for G4ImplicitEuler:

Public Member Functions
	G4ImplicitEuler (G4EquationOfMotion *EqRhs, G4int numberOfVariables=6)
	~G4ImplicitEuler () override
void	DumbStepper (const G4double y[], const G4double dydx[], G4double h, G4double yout[]) override
G4int	IntegratorOrder () const override
G4StepperType	StepperType () const override
Public Member Functions inherited from G4MagErrorStepper
	G4MagErrorStepper (G4EquationOfMotion *EqRhs, G4int numberOfVariables, G4int numStateVariables=12)
	~G4MagErrorStepper () override
	G4MagErrorStepper (const G4MagErrorStepper &)=delete
G4MagErrorStepper &	operator= (const G4MagErrorStepper &)=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 G4MagIntegratorStepper
void	SetIntegrationOrder (G4int order)
void	SetFSAL (G4bool flag=true)

Detailed Description

G4ImplicitEuler implements a Euler stepper for magnetic field with 2nd order solver.

Definition at line 50 of file G4ImplicitEuler.hh.

Constructor & Destructor Documentation

G4ImplicitEuler()

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

Constructor for G4HelixSimpleRunge.

Parameters

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

Definition at line 47 of file G4ImplicitEuler.cc.

  : G4MagErrorStepper(EqRhs, numberOfVariables)
{
  unsigned int noVariables = std::max(numberOfVariables,8); // For Time .. 7+1
  dydxTemp = new G4double[noVariables] ;
  yTemp    = new G4double[noVariables] ;
}

~G4ImplicitEuler()

G4ImplicitEuler::~G4ImplicitEuler ( )

override

Destructor.

Definition at line 61 of file G4ImplicitEuler.cc.

{
  delete [] dydxTemp;
  delete [] yTemp;
}

Member Function Documentation

DumbStepper()

void G4ImplicitEuler::DumbStepper ( const G4double y[], const G4double dydx[], G4double h, G4double yout[] )

overridevirtual

The stepper function for the integration.

Parameters

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

Implements G4MagErrorStepper.

Definition at line 72 of file G4ImplicitEuler.cc.

{
  const G4int numberOfVariables = GetNumberOfVariables();
 
  // Initialise time to t0, needed when it is not updated by the integration.
  //
  yTemp[7] = yOut[7] = yIn[7];   //  Better to set it to NaN;  // TODO
 
  for( G4int i = 0; i < numberOfVariables; ++i ) 
  {
    yTemp[i] = yIn[i] + h*dydx[i] ;          
  }
  
  RightHandSide(yTemp,dydxTemp);
  
  for( G4int i = 0; i < numberOfVariables; ++i ) 
  {
    yOut[i] = yIn[i] + 0.5 * h * ( dydx[i] + dydxTemp[i] );
  }
 
  return;
}  

IntegratorOrder()

G4int G4ImplicitEuler::IntegratorOrder ( ) const

inlineoverridevirtual

Returns the order, 2, of integration.

Implements G4MagIntegratorStepper.

Definition at line 82 of file G4ImplicitEuler.hh.

{ return 2; }

StepperType()

G4StepperType G4ImplicitEuler::StepperType ( ) const

inlineoverridevirtual

Returns the stepper type-ID, "kImplicitEuler".

Reimplemented from G4MagIntegratorStepper.

Definition at line 86 of file G4ImplicitEuler.hh.

{ return kImplicitEuler; }

---

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

• G4ImplicitEuler.hh
• G4ImplicitEuler.cc