G4FieldSetup Class Reference

G4FieldSetup is a 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 are set according to the selection in G4FieldParameters, as well as other accuracy parameters. More...

#include <G4FieldSetup.hh>

Public Member Functions
	G4FieldSetup (const G4FieldParameters &parameters, G4Field *field, G4LogicalVolume *lv=nullptr)
	~G4FieldSetup ()
	G4FieldSetup ()=delete
	G4FieldSetup (const G4FieldSetup &right)=delete
G4FieldSetup &	operator= (const G4FieldSetup &right)=delete
void	Clear ()
void	Update ()
void	PrintInfo (G4int verboseLevel, const G4String &about="created")
void	SetG4Field (G4Field *field)
G4Field *	GetG4Field () const
G4LogicalVolume *	GetLogicalVolume () const
G4EquationOfMotion *	GetEquation () const
G4MagIntegratorStepper *	GetStepper () const

Detailed Description

G4FieldSetup is a 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 are set according to the selection in G4FieldParameters, as well as other accuracy parameters.

Definition at line 66 of file G4FieldSetup.hh.

Constructor & Destructor Documentation

G4FieldSetup() [1/3]

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

Standard constructor for G4FieldSetup.

Parameters

[in]	parameters	The field parameters.
[in]	field	Pointer to the field object.
[in]	lv	Optional logical volume where field applies; if null, global field applies.

Definition at line 82 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 operator=().

~G4FieldSetup()

G4FieldSetup::~G4FieldSetup

(

)

Default Destructor.

Definition at line 107 of file G4FieldSetup.cc.

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

G4FieldSetup() [2/3]

G4FieldSetup::G4FieldSetup ( )

delete

Default constructor, copy constructor and assignment operator not allowed.

G4FieldSetup() [3/3]

G4FieldSetup::G4FieldSetup ( const G4FieldSetup & right )

delete

Member Function Documentation

Clear()

void G4FieldSetup::Clear

(

)

Clears previously created setup.

Definition at line 480 of file G4FieldSetup.cc.

{
  // First clean up previous state.
  delete fChordFinder;
  fChordFinder = nullptr;
 
  if (fG4Field == nullptr)
  {
    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

Definition at line 121 of file G4FieldSetup.hh.

{ return fEquation; }

GetG4Field()

G4Field * G4FieldSetup::GetG4Field ( ) const

inline

Accessors.

Definition at line 119 of file G4FieldSetup.hh.

{ return fG4Field; }

GetLogicalVolume()

G4LogicalVolume * G4FieldSetup::GetLogicalVolume ( ) const

inline

Definition at line 120 of file G4FieldSetup.hh.

{ return fLogicalVolume; }

GetStepper()

G4MagIntegratorStepper * G4FieldSetup::GetStepper ( ) const

inline

Definition at line 122 of file G4FieldSetup.hh.

{ return fStepper; }

operator=()

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

delete

PrintInfo()

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

Prints information.

Parameters

[in]	verboseLevel	Verbosity level; if greater than 1, parameters are also printed out to standard output.
[in]	about	Optional string.

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

Setter for the field object.

Definition at line 114 of file G4FieldSetup.hh.

{ fG4Field = field; }

Update()

void G4FieldSetup::Update

(

)

Updates the field setup with new field parameters.

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