G4FieldParameters.hh File Reference

Definition of the G4FieldParameters class. More...

#include "G4MagneticField.hh"
#include "globals.hh"
#include <CLHEP/Units/SystemOfUnits.h>

Go to the source code of this file.

Classes
class	G4FieldParameters
	The magnetic field parameters. More...

Enumerations
enum	G4FieldType { kMagnetic , kElectroMagnetic , kGravity }
	The available fields in Geant4. More...
enum	G4EquationType {   kEqMagnetic , kEqMagneticWithSpin , kEqElectroMagnetic , kEqEMfieldWithSpin ,   kEqEMfieldWithEDM , kUserEquation }
enum	G4StepperType {   kCashKarpRKF45 , kClassicalRK4 , kBogackiShampine23 , kBogackiShampine45 ,   kDormandPrince745 , kDormandPrinceRK56 , kDormandPrinceRK78 , kExplicitEuler ,   kImplicitEuler , kSimpleHeum , kSimpleRunge , kTsitourasRK45 ,   kConstRK4 , kExactHelixStepper , kHelixExplicitEuler , kHelixHeum ,   kHelixImplicitEuler , kHelixMixedStepper , kHelixSimpleRunge , kNystromRK4 ,   kRKG3Stepper , kUserStepper , kRK547FEq1 , kRK547FEq2 ,   kRK547FEq3 }

Detailed Description

Definition of the G4FieldParameters class.

This code was initially developed in Geant4 VMC package (https://github.com/vmc-project) and adapted to Geant4.

Author

I. Hrivnacova; IJCLab, Orsay

Definition in file G4FieldParameters.hh.

Enumeration Type Documentation

G4EquationType

enum G4EquationType

The available equations of motion of a particle in a field in Geant4

Enumerator
kEqMagnetic	G4Mag_UsualEqRhs: the standard right-hand side for equation of motion.
kEqMagneticWithSpin	G4Mag_SpinEqRhs: the equation of motion for a particle with spin in a pure magnetic field
kEqElectroMagnetic	G4EqMagElectricField: Equation of motion in a combined electric and magnetic field
kEqEMfieldWithSpin	G4EqEMFieldWithSpin: Equation of motion for a particle with spin in a combined electric and magnetic field
kEqEMfieldWithEDM	G4EqEMFieldWithEDM: Equation of motion in a combined electric and magnetic field, with spin tracking for both MDM and EDM terms
kUserEquation	User defined equation of motion.

Definition at line 58 of file G4FieldParameters.hh.

{
  kEqMagnetic,        ///< G4Mag_UsualEqRhs: the standard right-hand side for
                      ///< equation of motion.
  kEqMagneticWithSpin,///< G4Mag_SpinEqRhs: the equation of motion for a particle
                      ///< with spin
                      ///< in a pure magnetic field
  kEqElectroMagnetic, ///< G4EqMagElectricField: Equation of motion in a combined
                      ///< electric and magnetic field
  kEqEMfieldWithSpin, ///< G4EqEMFieldWithSpin: Equation of motion for a
                      ///< particle with spin
                      ///< in a combined electric and magnetic field
  kEqEMfieldWithEDM,  ///< G4EqEMFieldWithEDM: Equation of motion in a combined
                      ///< electric and magnetic field, with spin tracking for
                      ///< both MDM and EDM terms
  kUserEquation       ///< User defined equation of motion
};

G4FieldType

enum G4FieldType

The available fields in Geant4.

Enumerator
kMagnetic	magnetic field
kElectroMagnetic	electromagnetic field
kGravity	gravity field

Definition at line 49 of file G4FieldParameters.hh.

{
  kMagnetic,        ///< magnetic field
  kElectroMagnetic, ///< electromagnetic field
  kGravity          ///< gravity field
};

G4StepperType

enum G4StepperType

The available integrator of particle's equation of motion in Geant4

Enumerator
kCashKarpRKF45	G4CashKarpRKF45.
kClassicalRK4	G4ClassicalRK4.
kBogackiShampine23	G4BogackiShampine23.
kBogackiShampine45	G4BogackiShampine45.
kDormandPrince745	G4DormandPrince745.
kDormandPrinceRK56	G4DormandPrinceRK56.
kDormandPrinceRK78	G4DormandPrinceRK78.
kExplicitEuler	G4ExplicitEuler.
kImplicitEuler	G4ImplicitEuler.
kSimpleHeum	G4SimpleHeum.
kSimpleRunge	G4SimpleRunge.
kTsitourasRK45	G4TsitourasRK45.
kConstRK4	G4ConstRK4.
kExactHelixStepper	G4ExactHelixStepper.
kHelixExplicitEuler	G4HelixExplicitEuler.
kHelixHeum	G4HelixHeum.
kHelixImplicitEuler	G4HelixImplicitEuler.
kHelixMixedStepper	G4HelixMixedStepper.
kHelixSimpleRunge	G4HelixSimpleRunge.
kNystromRK4	G4NystromRK4.
kRKG3Stepper	G4RKG3_Stepper.
kUserStepper	User defined stepper.
kRK547FEq1	G4RK547FEq1.
kRK547FEq2	G4RK547FEq2.
kRK547FEq3	G4RK547FEq3.

Definition at line 78 of file G4FieldParameters.hh.

{
  // steppers with equation of motion of generic type (G4EquationOfMotion)
  kCashKarpRKF45,     ///< G4CashKarpRKF45
  kClassicalRK4,      ///< G4ClassicalRK4
  kBogackiShampine23, ///< G4BogackiShampine23
  kBogackiShampine45, ///< G4BogackiShampine45
  kDormandPrince745,  ///< G4DormandPrince745
  kDormandPrinceRK56, ///< G4DormandPrinceRK56
  kDormandPrinceRK78, ///< G4DormandPrinceRK78
  kExplicitEuler,     ///< G4ExplicitEuler
  kImplicitEuler,     ///< G4ImplicitEuler
  kSimpleHeum,        ///< G4SimpleHeum
  kSimpleRunge,       ///< G4SimpleRunge
  kTsitourasRK45,     ///< G4TsitourasRK45
 
  // steppers with equation of motion of G4Mag_UsualEqRhs type
  kConstRK4,           ///< G4ConstRK4
  kExactHelixStepper,  ///< G4ExactHelixStepper
  kHelixExplicitEuler, ///< G4HelixExplicitEuler
  kHelixHeum,          ///< G4HelixHeum
  kHelixImplicitEuler, ///< G4HelixImplicitEuler
  kHelixMixedStepper,  ///< G4HelixMixedStepper
  kHelixSimpleRunge,   ///< G4HelixSimpleRunge
  kNystromRK4,         ///< G4NystromRK4
  kRKG3Stepper,        ///< G4RKG3_Stepper
  kUserStepper,        ///< User defined stepper
 
  // FSAL steppers
  kRK547FEq1, ///< G4RK547FEq1
  kRK547FEq2, ///< G4RK547FEq2
  kRK547FEq3  ///< G4RK547FEq3
};