G4FieldParameters Class Reference

The magnetic field parameters. More...

#include <G4FieldParameters.hh>

Public Member Functions
	G4FieldParameters (const G4String &volumeName="")
	Standard and default constructor.
	~G4FieldParameters ()
	Destructor.
void	PrintParameters () const
	Prints all customizable accuracy parameters.
void	SetFieldType (G4FieldType field)
	Set type of field.
void	SetEquationType (G4EquationType equation)
	Set Type of equation of motion of a particle in a field.
void	SetStepperType (G4StepperType stepper)
	Type of integrator of particle's equation of motion.
void	SetUserEquationOfMotion (G4EquationOfMotion *equation)
	Set user defined equation of motion.
void	SetUserStepper (G4MagIntegratorStepper *stepper)
	Set user defined integrator of particle's equation of motion.
void	SetMinimumStep (G4double value)
	Set minimum step in G4ChordFinder.
void	SetDeltaChord (G4double value)
	Set delta chord in G4ChordFinder.
void	SetDeltaOneStep (G4double value)
	Set delta one step in global field manager.
void	SetDeltaIntersection (G4double value)
	Set delta intersection in global field manager.
void	SetMinimumEpsilonStep (G4double value)
	Set minimum epsilon step in global field manager.
void	SetMaximumEpsilonStep (G4double value)
	Set maximum epsilon step in global field manager.
void	SetConstDistance (G4double value)
	Set the distance within which the field is considered constant.
G4String	GetVolumeName () const
G4FieldType	GetFieldType () const
	Get type of field.
G4EquationType	GetEquationType () const
	Get type of equation of motion of a particle in a field.
G4StepperType	GetStepperType () const
	Get rype of integrator of particle's equation of motion.
G4EquationOfMotion *	GetUserEquationOfMotion () const
	Get user defined equation of motion.
G4MagIntegratorStepper *	GetUserStepper () const
	Get user defined integrator of particle's equation of motion.
G4double	GetMinimumStep () const
	Get minimum step in G4ChordFinder.
G4double	GetDeltaChord () const
	Get delta chord in G4ChordFinder.
G4double	GetDeltaOneStep () const
	Get delta one step in global field manager.
G4double	GetDeltaIntersection () const
	Get delta intersection in global field manager.
G4double	GetMinimumEpsilonStep () const
	Get minimum epsilon step in global field manager.
G4double	GetMaximumEpsilonStep () const
	Get maximum epsilon step in global field manager.
G4double	GetConstDistance () const
	Get the distance within which the field is considered constant.

Static Public Member Functions
static G4String	FieldTypeName (G4FieldType field)
	Return the field type as a string.
static G4String	EquationTypeName (G4EquationType equation)
	Return the equation type as a string.
static G4String	StepperTypeName (G4StepperType stepper)
	Return the stepper type as a string.
static G4FieldType	GetFieldType (const G4String &name)
	Return the field type for given field type name.
static G4EquationType	GetEquationType (const G4String &name)
	Return the equation type for given equation type name.
static G4StepperType	GetStepperType (const G4String &name)
	Return the stepper type for given stepper type name.

Detailed Description

The magnetic field parameters.

The class defines the type of equation of motion of a particle in a field and the integration method, as well as other accuracy parameters.

The default values correspond to the defaults set in Geant4 (taken from Geant4 9.3 release.) As Geant4 classes to not provide access methods for these defaults, the defaults have to be checked with each new Geant4 release.

Author

I. Hrivnacova; IJCLab, Orsay

Definition at line 125 of file G4FieldParameters.hh.

Constructor & Destructor Documentation

G4FieldParameters()

G4FieldParameters::G4FieldParameters

(

const G4String &

volumeName = ""

)

Standard and default constructor.

Definition at line 230 of file G4FieldParameters.cc.

  : fVolumeName(volumeName)
{
  // Standard constructor
 
  fMessenger = new G4FieldParametersMessenger(this);
}

~G4FieldParameters()

G4FieldParameters::~G4FieldParameters

(

)

Destructor.

Definition at line 239 of file G4FieldParameters.cc.

{
  // Destructor
 
  delete fMessenger;
}

Member Function Documentation

EquationTypeName()

G4String G4FieldParameters::EquationTypeName ( G4EquationType equation )

static

Return the equation type as a string.

Definition at line 67 of file G4FieldParameters.cc.

{
  // Return the equation type as a string
 
  switch (equation) {
    case kEqMagnetic:
      return G4String("EqMagnetic");
    case kEqMagneticWithSpin:
      return G4String("EqMagneticWithSpin");
    case kEqElectroMagnetic:
      return G4String("EqElectroMagnetic");
    case kEqEMfieldWithSpin:
      return G4String("EqEMfieldWithSpin");
    case kEqEMfieldWithEDM:
      return G4String("EqEMfieldWithEDM");
    case kUserEquation:
      return G4String("UserDefinedEq");
  }
 
  G4Exception(
    "G4FieldParameters::EquationTypeName:", "GeomFieldParameters0001",
    FatalErrorInArgument, "Unknown equation value.");
  return G4String();
}

Referenced by G4FieldParametersMessenger::G4FieldParametersMessenger(), GetEquationType(), PrintParameters(), and G4FieldParametersMessenger::SetNewValue().

FieldTypeName()

G4String G4FieldParameters::FieldTypeName ( G4FieldType field )

static

Return the field type as a string.

Definition at line 47 of file G4FieldParameters.cc.

{
  // Return the field type as a string
 
  switch (field) {
    case kMagnetic:
      return G4String("Magnetic");
    case kElectroMagnetic:
      return G4String("ElectroMagnetic");
    case kGravity:
      return G4String("Gravity");
  }
 
  G4Exception(
    "G4FieldParameters::FieldTypeName:", "GeomFieldParameters0001",
    FatalErrorInArgument, "Unknown field value.");
  return G4String();
}

Referenced by G4FieldParametersMessenger::G4FieldParametersMessenger(), GetFieldType(), G4FieldSetup::PrintInfo(), PrintParameters(), and G4FieldParametersMessenger::SetNewValue().

GetConstDistance()

G4double G4FieldParameters::GetConstDistance ( ) const

inline

Get the distance within which the field is considered constant.

Definition at line 408 of file G4FieldParameters.hh.

{
  return fConstDistance;
}

GetDeltaChord()

G4double G4FieldParameters::GetDeltaChord ( ) const

inline

Get delta chord in G4ChordFinder.

Definition at line 378 of file G4FieldParameters.hh.

{
  return fDeltaChord;
}

GetDeltaIntersection()

G4double G4FieldParameters::GetDeltaIntersection ( ) const

inline

Get delta intersection in global field manager.

Definition at line 390 of file G4FieldParameters.hh.

{
  return fDeltaIntersection;
}

GetDeltaOneStep()

G4double G4FieldParameters::GetDeltaOneStep ( ) const

inline

Get delta one step in global field manager.

Definition at line 384 of file G4FieldParameters.hh.

{
  return fDeltaOneStep;
}

GetEquationType() [1/2]

G4EquationType G4FieldParameters::GetEquationType ( ) const

inline

Get type of equation of motion of a particle in a field.

Definition at line 348 of file G4FieldParameters.hh.

{
  return fEquation;
}

GetEquationType() [2/2]

G4EquationType G4FieldParameters::GetEquationType ( const G4String & name )

static

Return the equation type for given equation type name.

Definition at line 172 of file G4FieldParameters.cc.

{
  // Return the equation type for given equation type name
 
  if (name == EquationTypeName(kEqMagnetic)) return kEqMagnetic;
  if (name == EquationTypeName(kEqMagneticWithSpin)) return kEqMagneticWithSpin;
  if (name == EquationTypeName(kEqElectroMagnetic)) return kEqElectroMagnetic;
  if (name == EquationTypeName(kEqEMfieldWithSpin)) return kEqEMfieldWithSpin;
  if (name == EquationTypeName(kEqEMfieldWithEDM)) return kEqEMfieldWithEDM;
  if (name == EquationTypeName(kUserEquation)) return kUserEquation;
 
  G4Exception(
    "G4FieldParameters::GetEquationType:", "GeomFieldParameters0001",
    FatalErrorInArgument, "Unknown equation name.");
  return kEqMagnetic;
}

GetFieldType() [1/2]

G4FieldType G4FieldParameters::GetFieldType ( ) const

inline

Get type of field.

Definition at line 345 of file G4FieldParameters.hh.

{ return fField; }

GetFieldType() [2/2]

G4FieldType G4FieldParameters::GetFieldType ( const G4String & name )

static

Return the field type for given field type name.

Definition at line 157 of file G4FieldParameters.cc.

{
  // Return the field type for given field type name
 
  if (name == FieldTypeName(kMagnetic)) return kMagnetic;
  if (name == FieldTypeName(kElectroMagnetic)) return kElectroMagnetic;
  if (name == FieldTypeName(kGravity)) return kGravity;
 
  G4Exception(
    "G4FieldParameters::GetFieldType:", "GeomFieldParameters0001",
    FatalErrorInArgument, "Unknown field name.");
  return kMagnetic;
}

GetMaximumEpsilonStep()

G4double G4FieldParameters::GetMaximumEpsilonStep ( ) const

inline

Get maximum epsilon step in global field manager.

Definition at line 402 of file G4FieldParameters.hh.

{
  return fMaximumEpsilonStep;
}

GetMinimumEpsilonStep()

G4double G4FieldParameters::GetMinimumEpsilonStep ( ) const

inline

Get minimum epsilon step in global field manager.

Definition at line 396 of file G4FieldParameters.hh.

{
  return fMinimumEpsilonStep;
}

GetMinimumStep()

G4double G4FieldParameters::GetMinimumStep ( ) const

inline

Get minimum step in G4ChordFinder.

Definition at line 372 of file G4FieldParameters.hh.

{
  return fMinimumStep;
}

GetStepperType() [1/2]

G4StepperType G4FieldParameters::GetStepperType ( ) const

inline

Get rype of integrator of particle's equation of motion.

Definition at line 354 of file G4FieldParameters.hh.

{
  return fStepper;
}

GetStepperType() [2/2]

G4StepperType G4FieldParameters::GetStepperType ( const G4String & name )

static

Return the stepper type for given stepper type name.

Definition at line 190 of file G4FieldParameters.cc.

{
  // Return the stepper type for given stepper type name
  if (name == StepperTypeName(kBogackiShampine23)) return kBogackiShampine23;
  if (name == StepperTypeName(kBogackiShampine45)) return kBogackiShampine45;
  if (name == StepperTypeName(kCashKarpRKF45)) return kCashKarpRKF45;
  if (name == StepperTypeName(kClassicalRK4)) return kClassicalRK4;
  if (name == StepperTypeName(kDormandPrince745)) return kDormandPrince745;
  if (name == StepperTypeName(kDormandPrinceRK56)) return kDormandPrinceRK56;
  if (name == StepperTypeName(kDormandPrinceRK78)) return kDormandPrinceRK78;
  if (name == StepperTypeName(kExplicitEuler)) return kExplicitEuler;
  if (name == StepperTypeName(kImplicitEuler)) return kImplicitEuler;
  if (name == StepperTypeName(kSimpleHeum)) return kSimpleHeum;
  if (name == StepperTypeName(kSimpleRunge)) return kSimpleRunge;
  if (name == StepperTypeName(kConstRK4)) return kConstRK4;
  if (name == StepperTypeName(kExactHelixStepper)) return kExactHelixStepper;
  if (name == StepperTypeName(kHelixExplicitEuler)) return kHelixExplicitEuler;
  if (name == StepperTypeName(kHelixHeum)) return kHelixHeum;
  if (name == StepperTypeName(kHelixImplicitEuler)) return kHelixImplicitEuler;
  if (name == StepperTypeName(kHelixMixedStepper)) return kHelixMixedStepper;
  if (name == StepperTypeName(kHelixSimpleRunge)) return kHelixSimpleRunge;
  if (name == StepperTypeName(kNystromRK4)) return kNystromRK4;
  if (name == StepperTypeName(kRKG3Stepper)) return kRKG3Stepper;
  if (name == StepperTypeName(kRK547FEq1)) return kRK547FEq1;
  if (name == StepperTypeName(kRK547FEq2)) return kRK547FEq2;
  if (name == StepperTypeName(kRK547FEq3)) return kRK547FEq3;
  if (name == StepperTypeName(kTsitourasRK45)) return kTsitourasRK45;
  if (name == StepperTypeName(kUserStepper)) return kUserStepper;
 
  G4Exception(
    "G4FieldParameters::GetStepperType:", "GeomFieldParameters0001",
    FatalErrorInArgument, "Unknown stepper name.");
  return kClassicalRK4;
}

GetUserEquationOfMotion()

G4EquationOfMotion * G4FieldParameters::GetUserEquationOfMotion ( ) const

inline

Get user defined equation of motion.

Definition at line 360 of file G4FieldParameters.hh.

{
  return fUserEquation;
}

GetUserStepper()

G4MagIntegratorStepper * G4FieldParameters::GetUserStepper ( ) const

inline

Get user defined integrator of particle's equation of motion.

Definition at line 366 of file G4FieldParameters.hh.

{
  return fUserStepper;
}

GetVolumeName()

G4String G4FieldParameters::GetVolumeName ( ) const

inline

Definition at line 339 of file G4FieldParameters.hh.

{
  return fVolumeName;
}

Referenced by G4FieldParametersMessenger::G4FieldParametersMessenger(), and G4FieldBuilder::GetFieldParameters().

PrintParameters()

void G4FieldParameters::PrintParameters

(

)

const

Prints all customizable accuracy parameters.

Definition at line 251 of file G4FieldParameters.cc.

{
  // Prints all customizable accuracy parameters
 
  G4cout << "Magnetic field parameters: " << G4endl;
  if (fVolumeName.size()) {
    G4cout << "  volume name = " << fVolumeName << G4endl;
  }
  G4cout << "  field type = " << FieldTypeName(fField) << G4endl
         << "  equation type = " << EquationTypeName(fEquation) << G4endl
         << "  stepper type = " << StepperTypeName(fStepper) << G4endl
         << "  minStep = " << fMinimumStep << " mm" << G4endl
         << "  constDistance = " << fConstDistance << " mm" << G4endl
         << "  deltaChord = " << fDeltaChord << " mm" << G4endl
         << "  deltaOneStep = " << fDeltaOneStep << " mm" << G4endl
         << "  deltaIntersection = " << fDeltaIntersection << " mm" << G4endl
         << "  epsMin = " << fMinimumEpsilonStep << G4endl
         << "  epsMax=  " << fMaximumEpsilonStep << G4endl;
}

SetConstDistance()

void G4FieldParameters::SetConstDistance ( G4double value )

inline

Set the distance within which the field is considered constant.

Definition at line 333 of file G4FieldParameters.hh.

{
  fConstDistance = value;
}

SetDeltaChord()

void G4FieldParameters::SetDeltaChord ( G4double value )

inline

Set delta chord in G4ChordFinder.

Definition at line 303 of file G4FieldParameters.hh.

{
  fDeltaChord = value;
}

SetDeltaIntersection()

void G4FieldParameters::SetDeltaIntersection ( G4double value )

inline

Set delta intersection in global field manager.

Definition at line 315 of file G4FieldParameters.hh.

{
  fDeltaIntersection = value;
}

SetDeltaOneStep()

void G4FieldParameters::SetDeltaOneStep ( G4double value )

inline

Set delta one step in global field manager.

Definition at line 309 of file G4FieldParameters.hh.

{
  fDeltaOneStep = value;
}

SetEquationType()

void G4FieldParameters::SetEquationType ( G4EquationType equation )

inline

Set Type of equation of motion of a particle in a field.

Definition at line 285 of file G4FieldParameters.hh.

{
  fEquation = equation;
}

SetFieldType()

void G4FieldParameters::SetFieldType ( G4FieldType field )

inline

Set type of field.

Definition at line 279 of file G4FieldParameters.hh.

{
  fField = field;
}

SetMaximumEpsilonStep()

void G4FieldParameters::SetMaximumEpsilonStep ( G4double value )

inline

Set maximum epsilon step in global field manager.

Definition at line 327 of file G4FieldParameters.hh.

{
  fMaximumEpsilonStep = value;
}

SetMinimumEpsilonStep()

void G4FieldParameters::SetMinimumEpsilonStep ( G4double value )

inline

Set minimum epsilon step in global field manager.

Definition at line 321 of file G4FieldParameters.hh.

{
  fMinimumEpsilonStep = value;
}

SetMinimumStep()

void G4FieldParameters::SetMinimumStep ( G4double value )

inline

Set minimum step in G4ChordFinder.

Definition at line 297 of file G4FieldParameters.hh.

{
  fMinimumStep = value;
}

SetStepperType()

void G4FieldParameters::SetStepperType ( G4StepperType stepper )

inline

Type of integrator of particle's equation of motion.

Definition at line 291 of file G4FieldParameters.hh.

{
  fStepper = stepper;
}

SetUserEquationOfMotion()

void G4FieldParameters::SetUserEquationOfMotion

(

G4EquationOfMotion *

equation

)

Set user defined equation of motion.

Definition at line 272 of file G4FieldParameters.cc.

{
  // Set user defined equation of motion
 
  fUserEquation = equation;
  fEquation = kUserEquation;
}

Referenced by G4FieldBuilder::SetUserEquationOfMotion().

SetUserStepper()

void G4FieldParameters::SetUserStepper

(

G4MagIntegratorStepper *

stepper

)

Set user defined integrator of particle's equation of motion.

Definition at line 281 of file G4FieldParameters.cc.

{
  // Set user defined integrator of particle's equation of motion
 
  fUserStepper = stepper;
  fStepper = kUserStepper;
}

Referenced by G4FieldBuilder::SetUserStepper().

StepperTypeName()

G4String G4FieldParameters::StepperTypeName ( G4StepperType stepper )

static

Return the stepper type as a string.

Definition at line 93 of file G4FieldParameters.cc.

{
  // Return the stepper type as a string
 
  switch (stepper) {
    case kBogackiShampine23:
      return G4String("BogackiShampine23");
    case kBogackiShampine45:
      return G4String("BogackiShampine45");
    case kCashKarpRKF45:
      return G4String("CashKarpRKF45");
    case kClassicalRK4:
      return G4String("ClassicalRK4");
    case kDormandPrince745:
      return G4String("DormandPrince745");
    case kDormandPrinceRK56:
      return G4String("DormandPrinceRK56");
    case kDormandPrinceRK78:
      return G4String("DormandPrinceRK78");
    case kExplicitEuler:
      return G4String("ExplicitEuler");
    case kImplicitEuler:
      return G4String("ImplicitEuler");
    case kSimpleHeum:
      return G4String("SimpleHeum");
    case kSimpleRunge:
      return G4String("SimpleRunge");
    case kConstRK4:
      return G4String("ConstRK4");
    case kExactHelixStepper:
      return G4String("ExactHelixStepper");
    case kHelixExplicitEuler:
      return G4String("HelixExplicitEuler");
    case kHelixHeum:
      return G4String("HelixHeum");
    case kHelixImplicitEuler:
      return G4String("HelixImplicitEuler");
    case kHelixMixedStepper:
      return G4String("HelixMixedStepper");
    case kHelixSimpleRunge:
      return G4String("HelixSimpleRunge");
    case kNystromRK4:
      return G4String("NystromRK4");
    case kRKG3Stepper:
      return G4String("RKG3_Stepper");
    case kTsitourasRK45:
      return G4String("TsitourasRK45");
    case kUserStepper:
      return G4String("UserDefinedStepper");
    case kRK547FEq1:
      return G4String("RK547FEq1");
    case kRK547FEq2:
      return G4String("RK547FEq2");
    case kRK547FEq3:
      return G4String("RK547FEq3");
  }
 
  G4Exception(
    "G4FieldParameters::StepperTypeName:", "GeomFieldParameters0001",
    FatalErrorInArgument, "Unknown stepper value.");
  return G4String();
}

Referenced by G4FieldParametersMessenger::G4FieldParametersMessenger(), GetStepperType(), G4FieldSetup::PrintInfo(), PrintParameters(), and G4FieldParametersMessenger::SetNewValue().

---

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

• G4FieldParameters.hh
• G4FieldParameters.cc