G4FieldSetup Class Reference

The class for constructing magnetic, electromagnetic and gravity fields which strength is defined via G4Field. More...

#include <G4FieldSetup.hh>

Public Member Functions
	G4FieldSetup (const G4FieldParameters &parameters, G4Field *field, G4LogicalVolume *lv=nullptr)
	Standard constructor.
	~G4FieldSetup ()
	Destructor.
void	Clear ()
	Clear previously created setup.
void	Update ()
	Update field setup with new field parameters.
void	PrintInfo (G4int verboseLevel, const G4String about="created")
	Print information.
void	SetG4Field (G4Field *field)
	Set G4 field.
G4Field *	GetG4Field () const
	Return the instantiated field.
G4LogicalVolume *	GetLogicalVolume () const
	Return the logical vol;ume.
G4EquationOfMotion *	GetEquation () const
	Return the equation of motion.
G4MagIntegratorStepper *	GetStepper () const
	Return the magnetic integrator stepper.
G4VIntegrationDriver *	GetIntegrationDriver () const
	Return the magnetic integrator driver.

Detailed Description

The class for constructing magnetic, electromagnetic and gravity fields which strength is defined via G4Field.

The equation of motion of a particle in a field and the integration method is set according to the selection in G4FieldParameters, as well as other accuracy parameters. The default values in G4FieldParameters correspond to 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. TO DO: unify defaults in G4 classes and G4 parameters

Author

I. Hrivnacova; IJClab, Orsay

Definition at line 69 of file G4FieldSetup.hh.

Constructor & Destructor Documentation

G4FieldSetup()

G4FieldSetup::G4FieldSetup	(	const G4FieldParameters &	parameters,
		G4Field *	field,
		G4LogicalVolume *	lv = nullptr )

Standard constructor.

Definition at line 85 of file G4FieldSetup.cc.

  : fParameters(parameters), fG4Field(field), fLogicalVolume(lv)
{
  // Standard constructor
 
  fMessenger = new G4FieldSetupMessenger(this);
 
  // Get or create field manager
  if (fLogicalVolume == nullptr) {
    // global field
    fFieldManager = G4FieldManager::GetGlobalFieldManager();
  }
  else {
    // local field
    fFieldManager = new G4FieldManager();
    G4bool overwriteDaughtersField = true;
      // TO DO: this parameter should be made optional for users
    fLogicalVolume->SetFieldManager(fFieldManager, overwriteDaughtersField);
  }
}

Referenced by G4FieldSetup(), and GetIntegrationDriver().

~G4FieldSetup()

G4FieldSetup::~G4FieldSetup

(

)

Destructor.

Definition at line 108 of file G4FieldSetup.cc.

{
  // Destructor
  delete fG4Field;
  delete fChordFinder;
  delete fStepper;
}

Member Function Documentation

Clear()

void G4FieldSetup::Clear

(

)

Clear previously created setup.

Definition at line 450 of file G4FieldSetup.cc.

{
  // First clean up previous state.
  delete fChordFinder;
  fChordFinder = nullptr;
 
  if (fG4Field == nullptr) {
    // G4cout << "fG4Field == nullptr: go to clean-up " << G4endl;
    delete fEquation;
    delete fDriver;
    delete fStepper;
    delete fChordFinder;
    fEquation = nullptr;
    fDriver = nullptr;
    fStepper = nullptr;
    fChordFinder = nullptr;
    fFieldManager->SetChordFinder(fChordFinder);
    fFieldManager->SetDetectorField(fG4Field);
  }
}

Referenced by Update().

GetEquation()

G4EquationOfMotion * G4FieldSetup::GetEquation ( ) const

inline

Return the equation of motion.

Definition at line 184 of file G4FieldSetup.hh.

{
  // Return the equation of motion
  return fEquation;
}

GetG4Field()

G4Field * G4FieldSetup::GetG4Field ( ) const

inline

Return the instantiated field.

Definition at line 172 of file G4FieldSetup.hh.

{
  // Return the instantiated field
  return fG4Field;
}

GetIntegrationDriver()

G4VIntegrationDriver * G4FieldSetup::GetIntegrationDriver

(

)

const

Return the magnetic integrator driver.

GetLogicalVolume()

G4LogicalVolume * G4FieldSetup::GetLogicalVolume ( ) const

inline

Return the logical vol;ume.

Definition at line 178 of file G4FieldSetup.hh.

{
  // Return the logical vol;ume
  return fLogicalVolume;
}

GetStepper()

G4MagIntegratorStepper * G4FieldSetup::GetStepper ( ) const

inline

Return the magnetic integrator stepper.

Definition at line 190 of file G4FieldSetup.hh.

{
  // Return the magnetic integrator stepper
  return fStepper;
}

PrintInfo()

void G4FieldSetup::PrintInfo	(	G4int	verboseLevel,
		const G4String	about = "created" )

Print information.

Definition at line 489 of file G4FieldSetup.cc.

{
  if (verboseLevel == 0) return; 
 
  auto fieldType = G4FieldParameters::FieldTypeName(fParameters.GetFieldType());
  auto isCachedMagneticField = (fParameters.GetConstDistance() > 0.);
  if (fLogicalVolume == nullptr) {
    fieldType = "Global";
  }
  else {
    fieldType = "Local (in ";
    fieldType.append(fLogicalVolume->GetName());
    fieldType.append(")");
  }
  if (isCachedMagneticField) {
    fieldType.append(" cached");
  }
 
  G4cout << fieldType << " field " << about << " with stepper ";
  G4cout << G4FieldParameters::StepperTypeName(
              fParameters.GetStepperType())
         << G4endl;
 
  if (verboseLevel > 1) {
    fParameters.PrintParameters();
  }
}

SetG4Field()

void G4FieldSetup::SetG4Field ( G4Field * field )

inline

Set G4 field.

Definition at line 166 of file G4FieldSetup.hh.

{
  // Set G4 field
  fG4Field = field;
}

Update()

void G4FieldSetup::Update

(

)

Update field setup with new field parameters.

Definition at line 472 of file G4FieldSetup.cc.

{
  // Update field with new field parameters
 
  Clear();
  if (fG4Field == nullptr) {
    // No further update needed
    return;
  }
 
  CreateCachedField();
  CreateStepper();
  CreateChordFinder();
  UpdateFieldManager();
}

---

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

• G4FieldSetup.hh
• G4FieldSetup.cc