#include <G4TSimpleHeum.hh>

Inheritance diagram for G4TSimpleHeum< T_Equation, N >:

Public Member Functions
G4double	DistChord () const override final

void	DumbStepper (const G4double yIn[], const G4double dydx[], G4double h, G4double yOut[])

	G4TSimpleHeum (T_Equation *EqRhs, unsigned int numberOfVariables=6)

G4EquationOfMotion *	GetEquationOfMotion ()

const G4EquationOfMotion *	GetEquationOfMotion () const

unsigned long	GetfNoRHSCalls ()

G4int	GetNumberOfStateVariables () const

G4int	GetNumberOfVariables () const

G4int	IntegrationOrder ()

G4int	IntegratorOrder () const

G4bool	IsFSAL () const

void	NormalisePolarizationVector (G4double vec[12])

void	NormaliseTangentVector (G4double vec[6])

void	ResetfNORHSCalls ()

void	RightHandSide (const G4double y[], G4double dydx[]) const

void	RightHandSide (const G4double y[], G4double dydx[], G4double field[]) const

void	RightHandSide (G4double y[], G4double dydx[])

void	SetEquationOfMotion (G4EquationOfMotion *newEquation)

void	Stepper (const G4double yInput[], const G4double dydx[], G4double hstep, G4double yOutput[], G4double yError[]) override final

	~G4TSimpleHeum ()

Static Public Attributes
static constexpr unsigned int	gIntegratorOrder = 3

static constexpr double	IntegratorCorrection

Protected Member Functions
void	SetFSAL (G4bool flag=true)

void	SetIntegrationOrder (G4int order)

Private Attributes
G4double	dydxMid [N< 8 ? 8 :N]

G4double	dydxTemp [N]

G4double	dydxTemp2 [N]

T_Equation *	fEquation_Rhs

G4ThreeVector	fFinalPoint

G4ThreeVector	fInitialPoint

G4int	fIntegrationOrder = -1

G4bool	fIsFSAL = false

G4ThreeVector	fMidPoint

const G4int	fNoIntegrationVariables = 0

unsigned long	fNoRHSCalls = 0UL

const G4int	fNoStateVariables = 0

G4int	fNumberOfVariables

G4double	yInitial [N< 8 ? 8 :N]

G4double	yMiddle [N< 8 ? 8 :N]

G4double	yOneStep [N< 8 ? 8 :N]

G4double	yTemp [N]

G4double	yTemp2 [N]

Detailed Description

template<class T_Equation, unsigned int N>
class G4TSimpleHeum< T_Equation, N >

Definition at line 55 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.");      
  }    
}

References FatalException, G4TSimpleHeum< T_Equation, N >::fNumberOfVariables, and G4Exception().

◆ ~G4TSimpleHeum()

template<class T_Equation , unsigned int N>

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

inline

Definition at line 65 of file G4TSimpleHeum.hh.

65{ ; }

Member Function Documentation

◆ DistChord()

G4double G4TMagErrorStepper< G4TSimpleHeum< T_Equation, N > , T_Equation, N >::DistChord

inlinefinaloverridevirtualinherited

Implements G4MagIntegratorStepper.

Definition at line 67 of file G4TMagErrorStepper.hh.

{
  // Estimate the maximum distance from the curve to the chord
  //
  //  We estimate this using the distance of the midpoint to
  //  chord (the line between
  //
  //  Method below is good only for angle deviations < 2 pi,
  //   This restriction should not a problem for the Runge cutta methods,
  //   which generally cannot integrate accurately for large angle deviations.
  G4double distLine, distChord;
 
  if(fInitialPoint != fFinalPoint)
  {
    distLine = G4LineSection::Distline(fMidPoint, fInitialPoint, fFinalPoint);
    // This is a class method that gives distance of Mid
    //  from the Chord between the Initial and Final points.
    
    distChord = distLine;
  }
  else
  {
     distChord = (fMidPoint - fInitialPoint).mag();
  }
  
  return distChord;
}

◆ 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);
  }
}

◆ GetEquationOfMotion() [1/2]

G4EquationOfMotion * G4MagIntegratorStepper::GetEquationOfMotion ( )

inlineinherited

Referenced by G4MagInt_Driver::GetEquationOfMotion(), G4OldMagIntDriver::GetEquationOfMotion(), G4NystromRK4::GetField(), G4DormandPrince745::GetSpecificEquation(), G4NystromRK4::SetDistanceForConstantField(), G4RKG3_Stepper::StepNoErr(), and G4RKG3_Stepper::Stepper().

◆ GetEquationOfMotion() [2/2]

const G4EquationOfMotion * G4MagIntegratorStepper::GetEquationOfMotion ( ) const

inlineinherited

◆ GetfNoRHSCalls()

unsigned long G4MagIntegratorStepper::GetfNoRHSCalls ( )

inlineinherited

◆ GetNumberOfStateVariables()

G4int G4MagIntegratorStepper::GetNumberOfStateVariables ( ) const

inlineinherited

Referenced by G4BogackiShampine45::G4BogackiShampine45(), G4CashKarpRKF45::G4CashKarpRKF45(), G4SimpleRunge::G4SimpleRunge(), G4TSimpleRunge< T_Equation, N >::G4TSimpleRunge(), G4TsitourasRK45::G4TsitourasRK45(), G4BogackiShampine23::makeStep(), G4RK547FEq1::makeStep(), G4RK547FEq2::makeStep(), G4RK547FEq3::makeStep(), G4ConstRK4::Stepper(), G4MagErrorStepper::Stepper(), and G4TMagErrorStepper< T_Stepper, T_Equation, N >::Stepper().

◆ GetNumberOfVariables()

G4int G4MagIntegratorStepper::GetNumberOfVariables ( ) const

inlineinherited

Referenced by G4ExplicitEuler::DumbStepper(), G4ImplicitEuler::DumbStepper(), G4ClassicalRK4::DumbStepper(), G4ChordFinder::G4ChordFinder(), G4BogackiShampine45::GetLastDydx(), G4DoLoMcPriRK34::Interpolate(), G4TsitourasRK45::Interpolate(), G4DormandPrince745::Interpolate4thOrder(), G4DormandPrince745::Interpolate5thOrder(), G4DormandPrinceRK56::Interpolate_high(), G4DormandPrinceRK56::Interpolate_low(), G4BogackiShampine45::InterpolateHigh(), G4BogackiShampine23::makeStep(), G4RK547FEq1::makeStep(), G4RK547FEq2::makeStep(), G4RK547FEq3::makeStep(), G4DormandPrinceRK56::SetupInterpolate_high(), G4DormandPrinceRK56::SetupInterpolate_low(), G4DormandPrince745::SetupInterpolation5thOrder(), G4BogackiShampine45::SetupInterpolationHigh(), G4BogackiShampine45::Stepper(), G4CashKarpRKF45::Stepper(), G4DoLoMcPriRK34::Stepper(), G4DormandPrinceRK56::Stepper(), G4DormandPrinceRK78::Stepper(), G4MagErrorStepper::Stepper(), G4TsitourasRK45::Stepper(), and G4DormandPrince745::Stepper().

◆ IntegrationOrder()

G4int G4MagIntegratorStepper::IntegrationOrder ( )

inlineinherited

◆ IntegratorOrder()

template<class T_Equation , unsigned int N>

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

inlinevirtual

Implements G4MagIntegratorStepper.

Definition at line 79 of file G4TSimpleHeum.hh.

79{ return gIntegratorOrder; }

G4TSimpleHeum::gIntegratorOrder

static constexpr unsigned int gIntegratorOrder

Definition: G4TSimpleHeum.hh:59

References G4TSimpleHeum< T_Equation, N >::gIntegratorOrder.

◆ IsFSAL()

G4bool G4MagIntegratorStepper::IsFSAL ( ) const

inlineinherited

◆ NormalisePolarizationVector()

void G4MagIntegratorStepper::NormalisePolarizationVector ( G4double vec[12] )

inlineinherited

Referenced by G4SimpleHeum::DumbStepper(), and G4ClassicalRK4::DumbStepper().

◆ NormaliseTangentVector()

void G4MagIntegratorStepper::NormaliseTangentVector ( G4double vec[6] )

inlineinherited

◆ ResetfNORHSCalls()

void G4MagIntegratorStepper::ResetfNORHSCalls ( )

inlineinherited

◆ RightHandSide() [1/3]

void G4MagIntegratorStepper::RightHandSide	(	const G4double	y[],
		G4double	dydx[]
	)		const

inlineinherited

◆ RightHandSide() [2/3]

void G4MagIntegratorStepper::RightHandSide	(	const G4double	y[],
		G4double	dydx[],
		G4double	field[]
	)		const

inlineinherited

◆ RightHandSide() [3/3]

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);
  }

References G4TSimpleHeum< T_Equation, N >::fEquation_Rhs.

◆ SetEquationOfMotion()

void G4MagIntegratorStepper::SetEquationOfMotion ( G4EquationOfMotion * newEquation )

inlineinherited

Referenced by G4MagInt_Driver::SetEquationOfMotion(), and G4OldMagIntDriver::SetEquationOfMotion().

◆ SetFSAL()

void G4MagIntegratorStepper::SetFSAL ( G4bool flag = true )

inlineprotectedinherited

Referenced by G4BogackiShampine23::G4BogackiShampine23().

◆ SetIntegrationOrder()

void G4MagIntegratorStepper::SetIntegrationOrder ( G4int order )

inlineprotectedinherited

Referenced by G4BogackiShampine23::G4BogackiShampine23().

◆ Stepper()

void G4TMagErrorStepper< G4TSimpleHeum< T_Equation, N > , T_Equation, N >::Stepper	(	const G4double	yInput[],
		const G4double	dydx[],
		G4double	hstep,
		G4double	yOutput[],
		G4double	yError[]
	)

inlinefinaloverridevirtualinherited

Implements G4MagIntegratorStepper.

Definition at line 64 of file G4TMagErrorStepper.hh.

{
  const unsigned int maxvar = GetNumberOfStateVariables();
  
  //  Saving yInput because yInput and yOutput can be aliases for same array
  for(unsigned int i = 0; i < N; ++i)
     yInitial[i] = yInput[i];
  yInitial[7] =
     yInput[7];  // Copy the time in case ... even if not really needed
  yMiddle[7]  = yInput[7];  // Copy the time from initial value
  yOneStep[7] = yInput[7];  // As it contributes to final value of yOutput ?
  // yOutput[7] = yInput[7];  // -> dumb stepper does it too for RK4
  for(unsigned int i = N; i < maxvar; ++i)
     yOutput[i] = yInput[i];
 
  G4double halfStep = hstep * 0.5;
  
  // Do two half steps
  
  static_cast<T_Stepper*>(this)->DumbStepper(yInitial, dydx, halfStep,
                                               yMiddle);
  this->RightHandSide(yMiddle, dydxMid);
  static_cast<T_Stepper*>(this)->DumbStepper(yMiddle, dydxMid, halfStep,
                                             yOutput);
  
  // Store midpoint, chord calculation
  
  fMidPoint = G4ThreeVector(yMiddle[0], yMiddle[1], yMiddle[2]);
  
  // Do a full Step
  static_cast<T_Stepper*>(this)->DumbStepper(yInitial, dydx, hstep, yOneStep);
  for(unsigned int i = 0; i < N; ++i)
  {
    yError[i] = yOutput[i] - yOneStep[i];
    yOutput[i] +=
       yError[i] *
       T_Stepper::IntegratorCorrection;  // Provides accuracy increased
    // by 1 order via the
    // Richardson Extrapolation
  }
 
  fInitialPoint = G4ThreeVector(yInitial[0], yInitial[1], yInitial[2]);
  fFinalPoint   = G4ThreeVector(yOutput[0], yOutput[1], yOutput[2]);
  
  return;
}

Field Documentation

◆ dydxMid

G4double G4TMagErrorStepper< G4TSimpleHeum< T_Equation, N > , T_Equation, N >::dydxMid[N< 8 ? 8 :N]

privateinherited

Definition at line 82 of file G4TMagErrorStepper.hh.

◆ dydxTemp

template<class T_Equation , unsigned int N>

G4double G4TSimpleHeum< T_Equation, N >::dydxTemp[N]

private

Definition at line 84 of file G4TSimpleHeum.hh.

◆ dydxTemp2

template<class T_Equation , unsigned int N>

G4double G4TSimpleHeum< T_Equation, N >::dydxTemp2[N]

private

Definition at line 85 of file G4TSimpleHeum.hh.

◆ fEquation_Rhs

template<class T_Equation , unsigned int N>

T_Equation* G4TSimpleHeum< T_Equation, N >::fEquation_Rhs

private

Definition at line 90 of file G4TSimpleHeum.hh.

Referenced by G4TSimpleHeum< T_Equation, N >::RightHandSide().

◆ fFinalPoint

G4ThreeVector G4TMagErrorStepper< G4TSimpleHeum< T_Equation, N > , T_Equation, N >::fFinalPoint

privateinherited

Definition at line 76 of file G4TMagErrorStepper.hh.

◆ fInitialPoint

G4ThreeVector G4TMagErrorStepper< G4TSimpleHeum< T_Equation, N > , T_Equation, N >::fInitialPoint

privateinherited

Definition at line 76 of file G4TMagErrorStepper.hh.

◆ fIntegrationOrder

G4int G4MagIntegratorStepper::fIntegrationOrder = -1

privateinherited

Definition at line 134 of file G4MagIntegratorStepper.hh.

◆ fIsFSAL

G4bool G4MagIntegratorStepper::fIsFSAL = false

privateinherited

Definition at line 136 of file G4MagIntegratorStepper.hh.

◆ fMidPoint

G4ThreeVector G4TMagErrorStepper< G4TSimpleHeum< T_Equation, N > , T_Equation, N >::fMidPoint

privateinherited

Definition at line 76 of file G4TMagErrorStepper.hh.

◆ fNoIntegrationVariables

const G4int G4MagIntegratorStepper::fNoIntegrationVariables = 0

privateinherited

Definition at line 125 of file G4MagIntegratorStepper.hh.

◆ fNoRHSCalls

unsigned long G4MagIntegratorStepper::fNoRHSCalls = 0UL

mutableprivateinherited

Definition at line 128 of file G4MagIntegratorStepper.hh.

◆ fNoStateVariables

const G4int G4MagIntegratorStepper::fNoStateVariables = 0

privateinherited

Definition at line 126 of file G4MagIntegratorStepper.hh.

◆ fNumberOfVariables

template<class T_Equation , unsigned int N>

G4int G4TSimpleHeum< T_Equation, N >::fNumberOfVariables

private

Definition at line 82 of file G4TSimpleHeum.hh.

Referenced by G4TSimpleHeum< T_Equation, N >::G4TSimpleHeum().

◆ gIntegratorOrder

template<class T_Equation , unsigned int N>

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

staticconstexpr

Definition at line 59 of file G4TSimpleHeum.hh.

Referenced by G4TSimpleHeum< T_Equation, N >::IntegratorOrder().

◆ IntegratorCorrection

template<class T_Equation , unsigned int N>

constexpr double G4TSimpleHeum< T_Equation, N >::IntegratorCorrection

staticconstexpr

Initial value:

= 1.0 /

((1<<gIntegratorOrder) - 1)

Definition at line 60 of file G4TSimpleHeum.hh.

◆ yInitial

G4double G4TMagErrorStepper< G4TSimpleHeum< T_Equation, N > , T_Equation, N >::yInitial[N< 8 ? 8 :N]

privateinherited

Definition at line 80 of file G4TMagErrorStepper.hh.

◆ yMiddle

G4double G4TMagErrorStepper< G4TSimpleHeum< T_Equation, N > , T_Equation, N >::yMiddle[N< 8 ? 8 :N]

privateinherited

Definition at line 81 of file G4TMagErrorStepper.hh.

◆ yOneStep

G4double G4TMagErrorStepper< G4TSimpleHeum< T_Equation, N > , T_Equation, N >::yOneStep[N< 8 ? 8 :N]

privateinherited

Definition at line 83 of file G4TMagErrorStepper.hh.

◆ yTemp

template<class T_Equation , unsigned int N>

G4double G4TSimpleHeum< T_Equation, N >::yTemp[N]

private

Definition at line 86 of file G4TSimpleHeum.hh.

◆ yTemp2

template<class T_Equation , unsigned int N>

G4double G4TSimpleHeum< T_Equation, N >::yTemp2[N]

private

Definition at line 87 of file G4TSimpleHeum.hh.

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

source/geometry/magneticfield/include/G4TSimpleHeum.hh

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4TSimpleHeum()

◆ ~G4TSimpleHeum()

Member Function Documentation

◆ DistChord()

◆ DumbStepper()

◆ GetEquationOfMotion() [1/2]

◆ GetEquationOfMotion() [2/2]

◆ GetfNoRHSCalls()

◆ GetNumberOfStateVariables()

◆ GetNumberOfVariables()

◆ IntegrationOrder()

◆ IntegratorOrder()

◆ IsFSAL()

◆ NormalisePolarizationVector()

◆ NormaliseTangentVector()

◆ ResetfNORHSCalls()

◆ RightHandSide() [1/3]

◆ RightHandSide() [2/3]

◆ RightHandSide() [3/3]

◆ SetEquationOfMotion()

◆ SetFSAL()

◆ SetIntegrationOrder()

◆ Stepper()

Field Documentation

◆ dydxMid

◆ dydxTemp

◆ dydxTemp2

◆ fEquation_Rhs

◆ fFinalPoint

◆ fInitialPoint

◆ fIntegrationOrder

◆ fIsFSAL

◆ fMidPoint

◆ fNoIntegrationVariables

◆ fNoRHSCalls

◆ fNoStateVariables

◆ fNumberOfVariables

◆ gIntegratorOrder

◆ IntegratorCorrection

◆ yInitial

◆ yMiddle

◆ yOneStep

◆ yTemp

◆ yTemp2