G4TSimpleHeum< T_Equation, N > Class Template Reference

G4TSimpleHeum is a templated version of G4SimpleHeum. More...

#include <G4TSimpleHeum.hh>

Inheritance diagram for G4TSimpleHeum< T_Equation, N >:

Public Member Functions
	G4TSimpleHeum (T_Equation *EqRhs, unsigned int numberOfVariables=6)
	~G4TSimpleHeum ()=default
void	RightHandSide (G4double y[], G4double dydx[])
void	DumbStepper (const G4double yIn[], const G4double dydx[], G4double h, G4double yOut[])
G4int	IntegratorOrder () const
Public Member Functions inherited from G4TMagErrorStepper< G4TSimpleHeum< 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 unsigned int	gIntegratorOrder = 3
static constexpr double	IntegratorCorrection = 1.0 / ((1<<gIntegratorOrder) - 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, unsigned int N>
class G4TSimpleHeum< T_Equation, N >

G4TSimpleHeum is a templated version of G4SimpleHeum.

Definition at line 56 of file G4TSimpleHeum.hh.

Constructor & Destructor Documentation

G4TSimpleHeum()

template<class T_Equation, unsigned int N>

G4TSimpleHeum< T_Equation, N >::G4TSimpleHeum	(	T_Equation *	EqRhs,
		unsigned int	numberOfVariables = 6 )

Definition at line 94 of file G4TSimpleHeum.hh.

    : G4TMagErrorStepper<G4TSimpleHeum<T_Equation, N>, T_Equation, N>(
        EqRhs, numberOfVariables)
    , fNumberOfVariables(numberOfVariables)
    , fEquation_Rhs(EqRhs)
{
  assert(fNumberOfVariables == N);
  if( dynamic_cast<G4EquationOfMotion*>(EqRhs) == nullptr )
  {
    G4Exception("G4TSimpleHeum: constructor", "GeomField0001",
                FatalException, "Equation is not an G4EquationOfMotion.");      
  }    
}

Referenced by G4TSimpleHeum().

~G4TSimpleHeum()

template<class T_Equation, unsigned int N>

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

default

Member Function Documentation

DumbStepper()

template<class T_Equation, unsigned int N>

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

inline

Definition at line 111 of file G4TSimpleHeum.hh.

{
  for(unsigned int i = 0; i < N; ++i)
  {
     yTemp[i] = yIn[i] + (1.0 / 3.0) * h * dydx[i];
  }
  
  this->RightHandSide(yTemp, dydxTemp);
  
  for(unsigned int i = 0; i < N; ++i)
  {
     yTemp2[i] = yIn[i] + (2.0 / 3.0) * h * dydxTemp[i];
  }
  
  this->RightHandSide(yTemp2, dydxTemp2);
  
  for(unsigned int i = 0; i < N; ++i)
  {
     yOut[i] = yIn[i] + h * (0.25 * dydx[i] + 0.75 * dydxTemp2[i]);
  }
  
  if(fNumberOfVariables == 12)
  {
     this->NormalisePolarizationVector(yOut);
  }
}

IntegratorOrder()

template<class T_Equation, unsigned int N>

G4int G4TSimpleHeum< 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 78 of file G4TSimpleHeum.hh.

{ return gIntegratorOrder; }

RightHandSide()

template<class T_Equation, unsigned int N>

void G4TSimpleHeum< T_Equation, N >::RightHandSide ( G4double y[], G4double dydx[] )

inline

Definition at line 68 of file G4TSimpleHeum.hh.

    {
      fEquation_Rhs->T_Equation::RightHandSide(y, dydx);
    }

Referenced by DumbStepper().

Member Data Documentation

gIntegratorOrder

template<class T_Equation, unsigned int N>

unsigned int G4TSimpleHeum< T_Equation, N >::gIntegratorOrder = 3

staticconstexpr

Definition at line 61 of file G4TSimpleHeum.hh.

Referenced by IntegratorOrder().

IntegratorCorrection

template<class T_Equation, unsigned int N>

double G4TSimpleHeum< T_Equation, N >::IntegratorCorrection = 1.0 / ((1<<gIntegratorOrder) - 1)

staticconstexpr

Definition at line 62 of file G4TSimpleHeum.hh.

---

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

• G4TSimpleHeum.hh