G4FieldParameters Class Reference

G4FieldParameters 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. More...

#include <G4FieldParameters.hh>

Public Member Functions
	G4FieldParameters (const G4String &volumeName="")
	~G4FieldParameters ()
	G4FieldParameters (const G4FieldParameters &right)=delete
G4FieldParameters &	operator= (const G4FieldParameters &right)=delete
void	PrintParameters () const
void	SetFieldType (G4FieldType field)
void	SetEquationType (G4EquationType equation)
void	SetStepperType (G4StepperType stepper)
void	SetUserEquationOfMotion (G4EquationOfMotion *equation)
void	SetUserStepper (G4MagIntegratorStepper *stepper)
void	SetMinimumStep (G4double value)
void	SetDeltaChord (G4double value)
void	SetDeltaOneStep (G4double value)
void	SetDeltaIntersection (G4double value)
void	SetMinimumEpsilonStep (G4double value)
void	SetMaximumEpsilonStep (G4double value)
void	SetConstDistance (G4double value)
const G4String &	GetVolumeName () const
const G4FieldType &	GetFieldType () const
const G4EquationType &	GetEquationType () const
const G4StepperType &	GetStepperType () const
G4EquationOfMotion *	GetUserEquationOfMotion () const
G4MagIntegratorStepper *	GetUserStepper () const
G4double	GetMinimumStep () const
G4double	GetDeltaChord () const
G4double	GetDeltaOneStep () const
G4double	GetDeltaIntersection () const
G4double	GetMinimumEpsilonStep () const
G4double	GetMaximumEpsilonStep () const
G4double	GetConstDistance () const

Static Public Member Functions
static G4String	FieldTypeName (G4FieldType field)
static G4String	EquationTypeName (G4EquationType equation)
static G4String	StepperTypeName (G4StepperType stepper)
static G4FieldType	GetFieldType (const G4String &name)
static G4EquationType	GetEquationType (const G4String &name)
static G4StepperType	GetStepperType (const G4String &name)

Detailed Description

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

Definition at line 167 of file G4FieldParameters.hh.

Constructor & Destructor Documentation

G4FieldParameters() [1/2]

G4FieldParameters::G4FieldParameters

(

const G4String &

volumeName = ""

)

Constructor for G4FieldParameters.

Parameters

[in]

volumeName

The volume name where field is applied.

Definition at line 255 of file G4FieldParameters.cc.

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

Referenced by G4FieldParameters(), and operator=().

~G4FieldParameters()

G4FieldParameters::~G4FieldParameters

(

)

Destructor.

Definition at line 264 of file G4FieldParameters.cc.

{
  // Destructor
 
  delete fMessenger;
}

G4FieldParameters() [2/2]

G4FieldParameters::G4FieldParameters ( const G4FieldParameters & right )

delete

Copy constructor and assignment operator not allowed.

Member Function Documentation

EquationTypeName()

G4String G4FieldParameters::EquationTypeName ( G4EquationType equation )

static

Returns the equation type as a string.

Definition at line 65 of file G4FieldParameters.cc.

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

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

FieldTypeName()

G4String G4FieldParameters::FieldTypeName ( G4FieldType field )

static

Returns the field type as a string.

Definition at line 42 of file G4FieldParameters.cc.

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

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

GetConstDistance()

G4double G4FieldParameters::GetConstDistance

(

)

const

Gets the distance within which the field is considered constant.

GetDeltaChord()

G4double G4FieldParameters::GetDeltaChord

(

)

const

Gets the delta chord in G4ChordFinder.

GetDeltaIntersection()

G4double G4FieldParameters::GetDeltaIntersection

(

)

const

Gets the delta intersection in global field manager.

GetDeltaOneStep()

G4double G4FieldParameters::GetDeltaOneStep

(

)

const

Gets the delta one step in global field manager.

GetEquationType() [1/2]

const G4EquationType & G4FieldParameters::GetEquationType

(

)

const

Gets the type of equation of motion of a particle in a field.

GetEquationType() [2/2]

G4EquationType G4FieldParameters::GetEquationType ( const G4String & name )

static

Returns the equation type for given equation type name.

Definition at line 189 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(kEqGravity)) { return kEqGravity; }
  if (name == EquationTypeName(kEqMonopole)) { return kEqMonopole; }
  if (name == EquationTypeName(kEqReplate)) {  return kEqReplate; }
  if (name == EquationTypeName(kUserEquation)) { return kUserEquation; }
 
  G4Exception(
    "G4FieldParameters::GetEquationType:", "GeomFieldParameters0001",
    FatalErrorInArgument, "Unknown equation name.");
  return kEqMagnetic;
}

GetFieldType() [1/2]

const G4FieldType & G4FieldParameters::GetFieldType

(

)

const

Gets the type of field.

GetFieldType() [2/2]

G4FieldType G4FieldParameters::GetFieldType ( const G4String & name )

static

Returns the field type for given field type name.

Definition at line 173 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; }
  if (name == FieldTypeName(kUserFieldType)) { return kUserFieldType; }
 
  G4Exception(
    "G4FieldParameters::GetFieldType:", "GeomFieldParameters0001",
    FatalErrorInArgument, "Unknown field name.");
  return kMagnetic;
}

GetMaximumEpsilonStep()

G4double G4FieldParameters::GetMaximumEpsilonStep

(

)

const

Gets the maximum epsilon step in global field manager.

GetMinimumEpsilonStep()

G4double G4FieldParameters::GetMinimumEpsilonStep

(

)

const

Gets the minimum epsilon step in global field manager.

GetMinimumStep()

G4double G4FieldParameters::GetMinimumStep

(

)

const

Gets the minimum step in G4ChordFinder.

GetStepperType() [1/2]

const G4StepperType & G4FieldParameters::GetStepperType

(

)

const

Gets the type of integrator of particle's equation of motion.

GetStepperType() [2/2]

G4StepperType G4FieldParameters::GetStepperType ( const G4String & name )

static

Returns the stepper type for given stepper type name.

Definition at line 210 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(kDoLoMcPriRK34)) { return kDoLoMcPriRK34; }
  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(kQSStepper)) { return kQSStepper; }
  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(kTCashKarpRKF45)) { return kTCashKarpRKF45; }
  if (name == StepperTypeName(kTDormandPrince45)) { return kTDormandPrince45; }
  if (name == StepperTypeName(kTMagErrorStepper)) { return kTMagErrorStepper; }
  if (name == StepperTypeName(kUserStepper)) { return kUserStepper; }
 
  G4Exception(
    "G4FieldParameters::GetStepperType:", "GeomFieldParameters0001",
    FatalErrorInArgument, "Unknown stepper name.");
  return kClassicalRK4;
}

GetUserEquationOfMotion()

G4EquationOfMotion * G4FieldParameters::GetUserEquationOfMotion

(

)

const

Gets the user defined equation of motion.

GetUserStepper()

G4MagIntegratorStepper * G4FieldParameters::GetUserStepper

(

)

const

Gets the user defined integrator of particle's equation of motion.

GetVolumeName()

const G4String & G4FieldParameters::GetVolumeName

(

)

const

Gets the name of associated volume, if local field.

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

operator=()

G4FieldParameters & G4FieldParameters::operator= ( const G4FieldParameters & right )

delete

PrintParameters()

void G4FieldParameters::PrintParameters

(

)

const

Prints all customisable accuracy parameters.

Definition at line 276 of file G4FieldParameters.cc.

{
  // Prints all customizable accuracy parameters
 
  G4cout << "Magnetic field parameters: " << G4endl;
  if (!fVolumeName.empty())
  {
    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

)

Sets the distance within which the field is considered constant.

SetDeltaChord()

void G4FieldParameters::SetDeltaChord

(

G4double

value

)

Sets the delta chord in G4ChordFinder.

SetDeltaIntersection()

void G4FieldParameters::SetDeltaIntersection

(

G4double

value

)

Sets the delta intersection in global field manager.

SetDeltaOneStep()

void G4FieldParameters::SetDeltaOneStep

(

G4double

value

)

Sets the delta one step in global field manager.

SetEquationType()

void G4FieldParameters::SetEquationType

(

G4EquationType

equation

)

Sets the type of equation of motion of a particle in a field.

SetFieldType()

void G4FieldParameters::SetFieldType

(

G4FieldType

field

)

Sets the type of field.

SetMaximumEpsilonStep()

void G4FieldParameters::SetMaximumEpsilonStep

(

G4double

value

)

Sets the maximum epsilon step in global field manager.

SetMinimumEpsilonStep()

void G4FieldParameters::SetMinimumEpsilonStep

(

G4double

value

)

Sets the minimum epsilon step in global field manager.

SetMinimumStep()

void G4FieldParameters::SetMinimumStep

(

G4double

value

)

Sets the minimum step in G4ChordFinder.

SetStepperType()

void G4FieldParameters::SetStepperType

(

G4StepperType

stepper

)

Sets the type of integrator of particle's equation of motion.

SetUserEquationOfMotion()

void G4FieldParameters::SetUserEquationOfMotion

(

G4EquationOfMotion *

equation

)

Sets the user defined equation of motion.

Definition at line 298 of file G4FieldParameters.cc.

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

Referenced by G4FieldBuilder::SetUserEquationOfMotion().

SetUserStepper()

void G4FieldParameters::SetUserStepper

(

G4MagIntegratorStepper *

stepper

)

Sets the user defined integrator of particle's equation of motion.

Definition at line 307 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

Returns the stepper type as a string.

Definition at line 98 of file G4FieldParameters.cc.

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

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