G4SimpleRunge Class Reference

G4SimpleRunge implements a simple Runge stepper for magnetic field with 2nd order solver. More...

#include <G4SimpleRunge.hh>

Inheritance diagram for G4SimpleRunge:

Public Member Functions
	G4SimpleRunge (G4EquationOfMotion *EquationRhs, G4int numberOfVariables=6)
	~G4SimpleRunge () override
	G4SimpleRunge (const G4SimpleRunge &)=delete
G4SimpleRunge &	operator= (const G4SimpleRunge &)=delete
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

G4SimpleRunge implements a simple Runge stepper for magnetic field with 2nd order solver.

Definition at line 50 of file G4SimpleRunge.hh.

Constructor & Destructor Documentation

G4SimpleRunge() [1/2]

G4SimpleRunge::G4SimpleRunge	(	G4EquationOfMotion *	EquationRhs,
		G4int	numberOfVariables = 6 )

Constructor for G4SimpleRunge.

Parameters

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

Definition at line 38 of file G4SimpleRunge.cc.

  : G4MagErrorStepper(EqRhs, numberOfVariables),
    fNumberOfVariables(numberOfVariables)
{
   
   unsigned int noVariables= std::max(numberOfVariables,
                                      GetNumberOfStateVariables()); 
                                             // To deal with Time >= 7+1 
   dydxTemp = new G4double[noVariables] ;
   yTemp    = new G4double[noVariables] ;
}

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

~G4SimpleRunge()

G4SimpleRunge::~G4SimpleRunge ( )

override

Destructor.

Definition at line 54 of file G4SimpleRunge.cc.

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

G4SimpleRunge() [2/2]

G4SimpleRunge::G4SimpleRunge ( const G4SimpleRunge & )

delete

Copy constructor and assignment operator not allowed.

Member Function Documentation

DumbStepper()

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

overridevirtual

The stepper for the Runge Kutta integration, but performing a 'dump' step without error calculation.

Parameters

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

Implements G4MagErrorStepper.

Definition at line 65 of file G4SimpleRunge.cc.

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

IntegratorOrder()

G4int G4SimpleRunge::IntegratorOrder ( ) const

inlineoverridevirtual

Returns the order, 2, of integration.

Implements G4MagIntegratorStepper.

Definition at line 89 of file G4SimpleRunge.hh.

{ return 2; }

operator=()

G4SimpleRunge & G4SimpleRunge::operator= ( const G4SimpleRunge & )

delete

StepperType()

G4StepperType G4SimpleRunge::StepperType ( ) const

inlineoverridevirtual

Returns the stepper type-ID, "kSimpleRunge".

Reimplemented from G4MagIntegratorStepper.

Definition at line 94 of file G4SimpleRunge.hh.

{ return kSimpleRunge; }

---

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

• G4SimpleRunge.hh
• G4SimpleRunge.cc