G4TExplicitEuler< T_Equation, N > Class Template Reference

G4TExplicitEuler is a templated version of G4ExplicitEuler stepper. More...

#include <G4TExplicitEuler.hh>

Inheritance diagram for G4TExplicitEuler< T_Equation, N >:

Public Member Functions
	G4TExplicitEuler (T_Equation *EqRhs, G4int numberOfVariables=N)
	~G4TExplicitEuler ()=default
void	DumbStepper (const G4double yIn[], const G4double dydx[], G4double h, G4double yOut[])
G4int	IntegratorOrder () const
Public Member Functions inherited from G4TMagErrorStepper< G4TExplicitEuler< T_Equation, N >, T_Equation, N >
	G4TMagErrorStepper (T_Equation *EqRhs, G4int numberOfVariables, G4int numStateVariables=12)
virtual	~G4TMagErrorStepper ()=default
G4TMagErrorStepper &	operator= (const G4TMagErrorStepper &)=delete
void	RightHandSide (G4double y[], G4double dydx[])
void	Stepper (const G4double yInput[], const G4double dydx[], G4double hstep, G4double yOutput[], G4double yError[]) override final
G4double	DistChord () const override final
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)

Static Public Attributes
static constexpr double	IntegratorCorrection = 1.

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

Detailed Description

template<class T_Equation, int N>
class G4TExplicitEuler< T_Equation, N >

G4TExplicitEuler is a templated version of G4ExplicitEuler stepper.

Definition at line 53 of file G4TExplicitEuler.hh.

Constructor & Destructor Documentation

G4TExplicitEuler()

template<class T_Equation, int N>

G4TExplicitEuler< T_Equation, N >::G4TExplicitEuler ( T_Equation * EqRhs, G4int numberOfVariables = N )

inline

Definition at line 60 of file G4TExplicitEuler.hh.

      : G4TMagErrorStepper<G4TExplicitEuler<T_Equation, N>, T_Equation, N>
                           (EqRhs, numberOfVariables), fEquation_Rhs(EqRhs)
    {
      if( numberOfVariables != N )
      {
        G4ExceptionDescription msg;
        msg << "Equation has an incompatible number of variables." ;
        msg << "   template N = " << N << " equation-Nvar= "
            << numberOfVariables;
        G4Exception("G4TExplicitEuler: constructor", "GeomField0003",
                    FatalErrorInArgument, msg );
      }
    }

Referenced by G4TExplicitEuler().

~G4TExplicitEuler()

template<class T_Equation, int N>

G4TExplicitEuler< T_Equation, N >::~G4TExplicitEuler ( )

default

Member Function Documentation

DumbStepper()

template<class T_Equation, int N>

void G4TExplicitEuler< T_Equation, N >::DumbStepper ( const G4double yIn[], const G4double dydx[], G4double h, G4double yOut[] )

inline

Definition at line 77 of file G4TExplicitEuler.hh.

    {
      // Initialise time to t0, needed when it is not updated by the integration.
      // yOut[7] = yIn[7];   //  Better to set it to NaN;  // TODO
 
      for(G4int i = 0; i < N; ++i)
      {
        yOut[i] = yIn[i] + h * dydx[i];  // 1st and only Step
      }
 
      return;
    }

IntegratorOrder()

template<class T_Equation, int N>

G4int G4TExplicitEuler< T_Equation, N >::IntegratorOrder ( ) const

inlinevirtual

Returns the order of the integrator, i.e. its error behaviour is of the order O(h^order).

Implements G4MagIntegratorStepper.

Definition at line 92 of file G4TExplicitEuler.hh.

{ return 1; }

Member Data Documentation

IntegratorCorrection

template<class T_Equation, int N>

double G4TExplicitEuler< T_Equation, N >::IntegratorCorrection = 1.

staticconstexpr

Definition at line 58 of file G4TExplicitEuler.hh.

---

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

• G4TExplicitEuler.hh