#include <G4CashKarpRKF45.hh>

Inheritance diagram for G4CashKarpRKF45:

Public Member Functions
G4double	DistChord () const

	G4CashKarpRKF45 (G4EquationOfMotion *EqRhs, G4int numberOfVariables=6, G4bool primary=true)

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	SetEquationOfMotion (G4EquationOfMotion *newEquation)

void	Stepper (const G4double y[], const G4double dydx[], G4double h, G4double yout[], G4double yerr[])

	~G4CashKarpRKF45 ()

Protected Member Functions
void	SetFSAL (G4bool flag=true)

void	SetIntegrationOrder (G4int order)

Private Member Functions
	G4CashKarpRKF45 (const G4CashKarpRKF45 &)

G4CashKarpRKF45 &	operator= (const G4CashKarpRKF45 &)

void	StepWithEst (const G4double yIn[], const G4double dydx[], G4double Step, G4double yOut[], G4double &alpha2, G4double &beta2, const G4double B1[], G4double B2[])

Private Attributes
G4double *	ak2

G4double *	ak3

G4double *	ak4

G4double *	ak5

G4double *	ak6

G4CashKarpRKF45 *	fAuxStepper = nullptr

G4EquationOfMotion *	fEquation_Rhs = nullptr

G4int	fIntegrationOrder = -1

G4bool	fIsFSAL = false

G4double *	fLastDyDx

G4double *	fLastFinalVector

G4double *	fLastInitialVector

G4double	fLastStepLength = 0.0

G4double *	fMidError

G4double *	fMidVector

const G4int	fNoIntegrationVariables = 0

unsigned long	fNoRHSCalls = 0UL

const G4int	fNoStateVariables = 0

G4double *	yIn

G4double *	yTemp

Detailed Description

Definition at line 44 of file G4CashKarpRKF45.hh.

Constructor & Destructor Documentation

◆ G4CashKarpRKF45() [1/2]

G4CashKarpRKF45::G4CashKarpRKF45	(	G4EquationOfMotion *	EqRhs,
		G4int	numberOfVariables = `6`,
		G4bool	primary = `true`
	)

Definition at line 47 of file G4CashKarpRKF45.cc.

  : G4MagIntegratorStepper(EqRhs, noIntegrationVariables)
{
  const G4int numberOfVariables =
      std::max( noIntegrationVariables,
               ( ( (noIntegrationVariables-1)/4 + 1 ) * 4 ) );
  // For better alignment with cache-line
  
  ak2 = new G4double[numberOfVariables] ;
  ak3 = new G4double[numberOfVariables] ;
  ak4 = new G4double[numberOfVariables] ;
  ak5 = new G4double[numberOfVariables] ;
  ak6 = new G4double[numberOfVariables] ;
  // ak7 = 0;
 
  // Must ensure space extra 'state' variables exists - i.e. yIn[7]
  const G4int numStateMax  = std::max(GetNumberOfStateVariables(), 8);  
  const G4int numStateVars = std::max(noIntegrationVariables,
                                      numStateMax );
                                   // GetNumberOfStateVariables() ); 
                                      
  yTemp = new G4double[numStateVars] ;
  yIn = new G4double[numStateVars] ;
 
  fLastInitialVector = new G4double[numStateVars] ;
  fLastFinalVector = new G4double[numStateVars] ;
  fLastDyDx = new G4double[numberOfVariables];
 
  fMidVector = new G4double[numStateVars];
  fMidError =  new G4double[numStateVars];
  if( primary )
  { 
    fAuxStepper = new G4CashKarpRKF45(EqRhs, numberOfVariables, !primary);
  }
}

References ak2, ak3, ak4, ak5, ak6, fAuxStepper, fLastDyDx, fLastFinalVector, fLastInitialVector, fMidError, fMidVector, G4CashKarpRKF45(), G4MagIntegratorStepper::GetNumberOfStateVariables(), G4INCL::Math::max(), yIn, and yTemp.

Referenced by G4CashKarpRKF45().

◆ ~G4CashKarpRKF45()

G4CashKarpRKF45::~G4CashKarpRKF45 ( )

Definition at line 89 of file G4CashKarpRKF45.cc.

{
  delete [] ak2;
  delete [] ak3;
  delete [] ak4;
  delete [] ak5;
  delete [] ak6;
  // delete [] ak7;
  delete [] yTemp;
  delete [] yIn;
 
  delete [] fLastInitialVector;
  delete [] fLastFinalVector;
  delete [] fLastDyDx;
  delete [] fMidVector;
  delete [] fMidError; 
 
  delete fAuxStepper;
}

References ak2, ak3, ak4, ak5, ak6, fAuxStepper, fLastDyDx, fLastFinalVector, fLastInitialVector, fMidError, fMidVector, yIn, and yTemp.

◆ G4CashKarpRKF45() [2/2]

G4CashKarpRKF45::G4CashKarpRKF45 ( const G4CashKarpRKF45 & )

private

Member Function Documentation

◆ DistChord()

G4double G4CashKarpRKF45::DistChord ( ) const

virtual

Implements G4MagIntegratorStepper.

Definition at line 238 of file G4CashKarpRKF45.cc.

{
  G4double distLine, distChord; 
  G4ThreeVector initialPoint, finalPoint, midPoint;
 
  // Store last initial and final points
  // (they will be overwritten in self-Stepper call!)
  //
  initialPoint = G4ThreeVector( fLastInitialVector[0], 
                                fLastInitialVector[1], fLastInitialVector[2]); 
  finalPoint   = G4ThreeVector( fLastFinalVector[0],  
                                fLastFinalVector[1],  fLastFinalVector[2]); 
 
  // Do half a step using StepNoErr
  //
  fAuxStepper->Stepper( fLastInitialVector, fLastDyDx,
                        0.5 * fLastStepLength, fMidVector, fMidError );
 
  midPoint = G4ThreeVector( fMidVector[0], fMidVector[1], fMidVector[2]);       
 
  // Use stored values of Initial and Endpoint + new Midpoint to evaluate
  // distance of Chord
  //
  if (initialPoint != finalPoint) 
  {
     distLine  = G4LineSection::Distline( midPoint, initialPoint, finalPoint );
     distChord = distLine;
  }
  else
  {
     distChord = (midPoint-initialPoint).mag();
  }
  return distChord;
}

References G4LineSection::Distline(), fAuxStepper, fLastDyDx, fLastFinalVector, fLastInitialVector, fLastStepLength, fMidError, fMidVector, and Stepper().

◆ 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(), 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(), Stepper(), G4DoLoMcPriRK34::Stepper(), G4DormandPrinceRK56::Stepper(), G4DormandPrinceRK78::Stepper(), G4MagErrorStepper::Stepper(), G4TsitourasRK45::Stepper(), and G4DormandPrince745::Stepper().

◆ IntegrationOrder()

G4int G4MagIntegratorStepper::IntegrationOrder ( )

inlineinherited

◆ IntegratorOrder()

G4int G4CashKarpRKF45::IntegratorOrder ( ) const

inlinevirtual

Implements G4MagIntegratorStepper.

Definition at line 63 of file G4CashKarpRKF45.hh.

63{ return 4; }

◆ 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

◆ operator=()

G4CashKarpRKF45 & G4CashKarpRKF45::operator= ( const G4CashKarpRKF45 & )

private

◆ ResetfNORHSCalls()

void G4MagIntegratorStepper::ResetfNORHSCalls ( )

inlineinherited

◆ RightHandSide() [1/2]

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

inlineinherited

◆ RightHandSide() [2/2]

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

inlineinherited

◆ 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 G4CashKarpRKF45::Stepper	(	const G4double	y[],
		const G4double	dydx[],
		G4double	h,
		G4double	yout[],
		G4double	yerr[]
	)

virtual

Implements G4MagIntegratorStepper.

Definition at line 120 of file G4CashKarpRKF45.cc.

{
  // const G4int nvar = 6 ;
  // const G4double a2 = 0.2 , a3 = 0.3 , a4 = 0.6 , a5 = 1.0 , a6 = 0.875;
  G4int i;
 
  const G4double  b21 = 0.2 ,
                  b31 = 3.0/40.0 , b32 = 9.0/40.0 ,
                  b41 = 0.3 , b42 = -0.9 , b43 = 1.2 ,
 
                  b51 = -11.0/54.0 , b52 = 2.5 , b53 = -70.0/27.0 ,
                  b54 = 35.0/27.0 ,
 
                  b61 = 1631.0/55296.0 , b62 =   175.0/512.0 ,
                  b63 =  575.0/13824.0 , b64 = 44275.0/110592.0 ,
                  b65 =  253.0/4096.0 ,
 
                  c1 = 37.0/378.0 , c3 = 250.0/621.0 , c4 = 125.0/594.0 ,
                  c6 = 512.0/1771.0 , dc5 = -277.0/14336.0 ;
 
  const G4double dc1 = c1 - 2825.0/27648.0 ,  dc3 = c3 - 18575.0/48384.0 ,
                 dc4 = c4 - 13525.0/55296.0 , dc6 = c6 - 0.25 ;
 
  // Initialise time to t0, needed when it is not updated by the integration.
  //        [ Note: Only for time dependent fields (usually electric) 
  //                  is it neccessary to integrate the time.] 
  yOut[7] = yTemp[7] = yIn[7] = yInput[7]; 
 
  const G4int numberOfVariables= this->GetNumberOfVariables(); 
    // The number of variables to be integrated over
 
  //  Saving yInput because yInput and yOut can be aliases for same array
 
  for(i=0; i<numberOfVariables; ++i) 
  {
    yIn[i]=yInput[i];
  }
  // RightHandSide(yIn, dydx) ;            // 1st Step
 
  for(i=0; i<numberOfVariables; ++i) 
  {
    yTemp[i] = yIn[i] + b21*Step*dydx[i] ;
  }
  RightHandSide(yTemp, ak2) ;              // 2nd Step
 
  for(i=0; i<numberOfVariables; ++i)
  {
    yTemp[i] = yIn[i] + Step*(b31*dydx[i] + b32*ak2[i]) ;
  }
  RightHandSide(yTemp, ak3) ;              // 3rd Step
 
  for(i=0; i<numberOfVariables; ++i)
  {
    yTemp[i] = yIn[i] + Step*(b41*dydx[i] + b42*ak2[i] + b43*ak3[i]) ;
  }
  RightHandSide(yTemp, ak4) ;              // 4th Step
 
  for(i=0; i<numberOfVariables; ++i)
  {
    yTemp[i] = yIn[i] + Step*(b51*dydx[i]
                      + b52*ak2[i] + b53*ak3[i] + b54*ak4[i]) ;
  }
  RightHandSide(yTemp, ak5) ;              // 5th Step
 
  for(i=0; i<numberOfVariables; ++i)
  {
    yTemp[i] = yIn[i] + Step*(b61*dydx[i]
                      + b62*ak2[i] + b63*ak3[i] + b64*ak4[i] + b65*ak5[i]) ;
  }
  RightHandSide(yTemp, ak6) ;              // 6th Step
 
  for(i=0; i<numberOfVariables; ++i)
  {
    // Accumulate increments with proper weights
    //
    yOut[i] = yIn[i] + Step*(c1*dydx[i] + c3*ak3[i] + c4*ak4[i] + c6*ak6[i]) ;
 
    // Estimate error as difference between 4th and 5th order methods
    //
    yErr[i] = Step*(dc1*dydx[i]
            + dc3*ak3[i] + dc4*ak4[i] + dc5*ak5[i] + dc6*ak6[i]) ;
 
    // Store Input and Final values, for possible use in calculating chord
    //
    fLastInitialVector[i] = yIn[i] ;
    fLastFinalVector[i]   = yOut[i];
    fLastDyDx[i]          = dydx[i];
  }
  // NormaliseTangentVector( yOut ); // Not wanted
 
  fLastStepLength = Step;
 
  return;
} 

References ak2, ak3, ak4, ak5, ak6, fLastDyDx, fLastFinalVector, fLastInitialVector, fLastStepLength, G4MagIntegratorStepper::GetNumberOfVariables(), G4MagIntegratorStepper::RightHandSide(), yIn, and yTemp.

Referenced by DistChord().

◆ StepWithEst()

void G4CashKarpRKF45::StepWithEst	(	const G4double	yIn[],
		const G4double	dydx[],
		G4double	Step,
		G4double	yOut[],
		G4double &	alpha2,
		G4double &	beta2,
		const G4double	B1[],
		G4double	B2[]
	)

private

Definition at line 222 of file G4CashKarpRKF45.cc.

{
  G4Exception("G4CashKarpRKF45::StepWithEst()", "GeomField0001",
              FatalException, "Method no longer used.");
  return ;
}

References FatalException, and G4Exception().

Field Documentation

◆ ak2

G4double* G4CashKarpRKF45::ak2

private

Definition at line 83 of file G4CashKarpRKF45.hh.

Referenced by G4CashKarpRKF45(), Stepper(), and ~G4CashKarpRKF45().

◆ ak3

G4double * G4CashKarpRKF45::ak3

private

Definition at line 83 of file G4CashKarpRKF45.hh.

Referenced by G4CashKarpRKF45(), Stepper(), and ~G4CashKarpRKF45().

◆ ak4

G4double * G4CashKarpRKF45::ak4

private

Definition at line 83 of file G4CashKarpRKF45.hh.

Referenced by G4CashKarpRKF45(), Stepper(), and ~G4CashKarpRKF45().

◆ ak5

G4double * G4CashKarpRKF45::ak5

private

Definition at line 83 of file G4CashKarpRKF45.hh.

Referenced by G4CashKarpRKF45(), Stepper(), and ~G4CashKarpRKF45().

◆ ak6

G4double * G4CashKarpRKF45::ak6

private

Definition at line 83 of file G4CashKarpRKF45.hh.

Referenced by G4CashKarpRKF45(), Stepper(), and ~G4CashKarpRKF45().

◆ fAuxStepper

G4CashKarpRKF45* G4CashKarpRKF45::fAuxStepper = nullptr

private

Definition at line 91 of file G4CashKarpRKF45.hh.

Referenced by DistChord(), G4CashKarpRKF45(), and ~G4CashKarpRKF45().

◆ fEquation_Rhs

G4EquationOfMotion* G4MagIntegratorStepper::fEquation_Rhs = nullptr

privateinherited

Definition at line 124 of file G4MagIntegratorStepper.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.

◆ fLastDyDx

G4double * G4CashKarpRKF45::fLastDyDx

private

Definition at line 88 of file G4CashKarpRKF45.hh.

Referenced by DistChord(), G4CashKarpRKF45(), Stepper(), and ~G4CashKarpRKF45().

◆ fLastFinalVector

G4double * G4CashKarpRKF45::fLastFinalVector

private

Definition at line 87 of file G4CashKarpRKF45.hh.

Referenced by DistChord(), G4CashKarpRKF45(), Stepper(), and ~G4CashKarpRKF45().

◆ fLastInitialVector

G4double* G4CashKarpRKF45::fLastInitialVector

private

Definition at line 87 of file G4CashKarpRKF45.hh.

Referenced by DistChord(), G4CashKarpRKF45(), Stepper(), and ~G4CashKarpRKF45().

◆ fLastStepLength

G4double G4CashKarpRKF45::fLastStepLength = 0.0

private

Definition at line 86 of file G4CashKarpRKF45.hh.

Referenced by DistChord(), and Stepper().

◆ fMidError

G4double * G4CashKarpRKF45::fMidError

private

Definition at line 88 of file G4CashKarpRKF45.hh.

Referenced by DistChord(), G4CashKarpRKF45(), and ~G4CashKarpRKF45().

◆ fMidVector

G4double * G4CashKarpRKF45::fMidVector

private

Definition at line 88 of file G4CashKarpRKF45.hh.

Referenced by DistChord(), G4CashKarpRKF45(), and ~G4CashKarpRKF45().

◆ 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.

◆ yIn

G4double * G4CashKarpRKF45::yIn

private

Definition at line 83 of file G4CashKarpRKF45.hh.

Referenced by G4CashKarpRKF45(), Stepper(), and ~G4CashKarpRKF45().

◆ yTemp

G4double * G4CashKarpRKF45::yTemp

private

Definition at line 83 of file G4CashKarpRKF45.hh.

Referenced by G4CashKarpRKF45(), Stepper(), and ~G4CashKarpRKF45().

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

source/geometry/magneticfield/include/G4CashKarpRKF45.hh
source/geometry/magneticfield/src/G4CashKarpRKF45.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4CashKarpRKF45() [1/2]

◆ ~G4CashKarpRKF45()

◆ G4CashKarpRKF45() [2/2]

Member Function Documentation

◆ DistChord()

◆ GetEquationOfMotion() [1/2]

◆ GetEquationOfMotion() [2/2]

◆ GetfNoRHSCalls()

◆ GetNumberOfStateVariables()

◆ GetNumberOfVariables()

◆ IntegrationOrder()

◆ IntegratorOrder()

◆ IsFSAL()

◆ NormalisePolarizationVector()

◆ NormaliseTangentVector()

◆ operator=()

◆ ResetfNORHSCalls()

◆ RightHandSide() [1/2]

◆ RightHandSide() [2/2]

◆ SetEquationOfMotion()

◆ SetFSAL()

◆ SetIntegrationOrder()

◆ Stepper()

◆ StepWithEst()

Field Documentation

◆ ak2

◆ ak3

◆ ak4

◆ ak5

◆ ak6

◆ fAuxStepper

◆ fEquation_Rhs

◆ fIntegrationOrder

◆ fIsFSAL

◆ fLastDyDx

◆ fLastFinalVector

◆ fLastInitialVector

◆ fLastStepLength

◆ fMidError

◆ fMidVector

◆ fNoIntegrationVariables

◆ fNoRHSCalls

◆ fNoStateVariables

◆ yIn

◆ yTemp