Geant4-11
G4DormandPrince745.hh
Go to the documentation of this file.
1//
2// ********************************************************************
3// * License and Disclaimer *
4// * *
5// * The Geant4 software is copyright of the Copyright Holders of *
6// * the Geant4 Collaboration. It is provided under the terms and *
7// * conditions of the Geant4 Software License, included in the file *
8// * LICENSE and available at http://cern.ch/geant4/license . These *
9// * include a list of copyright holders. *
10// * *
11// * Neither the authors of this software system, nor their employing *
12// * institutes,nor the agencies providing financial support for this *
13// * work make any representation or warranty, express or implied, *
14// * regarding this software system or assume any liability for its *
15// * use. Please see the license in the file LICENSE and URL above *
16// * for the full disclaimer and the limitation of liability. *
17// * *
18// * This code implementation is the result of the scientific and *
19// * technical work of the GEANT4 collaboration. *
20// * By using, copying, modifying or distributing the software (or *
21// * any work based on the software) you agree to acknowledge its *
22// * use in resulting scientific publications, and indicate your *
23// * acceptance of all terms of the Geant4 Software license. *
24// ********************************************************************
25//
26// G4DormandPrince745
27//
28// Class desription:
29//
30// An implementation of the 5th order embedded RK method from the paper:
31// J. R. Dormand and P. J. Prince, "A family of embedded Runge-Kutta formulae"
32// Journal of computational and applied Math., vol.6, no.1, pp.19-26, 1980.
33//
34// DormandPrince7 - 5(4) embedded RK method
35//
36
37// Created: Somnath Banerjee, Google Summer of Code 2015, 25 May 2015
38// Supervision: John Apostolakis, CERN
39// --------------------------------------------------------------------
40#ifndef G4DORMAND_PRINCE_745_HH
41#define G4DORMAND_PRINCE_745_HH
42
44#include "G4FieldUtils.hh"
45
47{
48 public:
49
51 G4int numberOfVariables = 6);
52
53 virtual void Stepper(const G4double yInput[],
54 const G4double dydx[],
55 G4double hstep,
56 G4double yOutput[],
57 G4double yError[]) override;
58
59 void Stepper(const G4double yInput[],
60 const G4double dydx[],
61 G4double hstep,
62 G4double yOutput[],
63 G4double yError[],
64 G4double dydxOutput[]);
65
66 inline void SetupInterpolation() {}
67
68 inline void Interpolate(G4double tau, G4double yOut[]) const
69 {
70 Interpolate4thOrder(yOut, tau);
71 }
72 // For calculating the output at the tau fraction of Step
73
74 virtual G4double DistChord() const override;
75
76 virtual G4int IntegratorOrder() const override { return 4; }
77
78 const G4String& StepperType() const { return gStepperType; }
80
81 const field_utils::State& GetYOut() const { return fyOut; }
82
83 void Interpolate4thOrder(G4double yOut[], G4double tau) const;
84
86 void Interpolate5thOrder(G4double yOut[], G4double tau) const;
87
89
90 private:
91 // Name and description of this steppers - plus details of its implementation
92 static const G4String gStepperType;
94 // const unsigned int fIntegratorOrder = 4; // Should it not be 5 ?
95
98
100};
101#endif
double G4double
Definition: G4Types.hh:83
int G4int
Definition: G4Types.hh:85
virtual void Stepper(const G4double yInput[], const G4double dydx[], G4double hstep, G4double yOutput[], G4double yError[]) override
field_utils::State ak3
field_utils::State fyOut
field_utils::State fdydxIn
G4DormandPrince745(G4EquationOfMotion *equation, G4int numberOfVariables=6)
void Interpolate4thOrder(G4double yOut[], G4double tau) const
field_utils::State ak5
virtual G4double DistChord() const override
field_utils::State fyIn
field_utils::State ak8
field_utils::State ak7
field_utils::State ak6
static const G4String gStepperDescription
const G4String & StepperDescription() const
const G4String & StepperType() const
field_utils::State ak9
const field_utils::State & GetYOut() const
field_utils::State ak4
static const G4String gStepperType
void Interpolate(G4double tau, G4double yOut[]) const
virtual G4int IntegratorOrder() const override
field_utils::State ak2
void Interpolate5thOrder(G4double yOut[], G4double tau) const
G4EquationOfMotion * GetSpecificEquation()
G4EquationOfMotion * GetEquationOfMotion()
G4double[G4FieldTrack::ncompSVEC] State
Definition: G4FieldUtils.hh:45