F02ElectricFieldSetup Class Reference

A class for control of the Electric Field of the detector. More...

#include <Doxymodules_field.h>

Public Member Functions
	F02ElectricFieldSetup (G4ThreeVector)
	F02ElectricFieldSetup ()
virtual	~F02ElectricFieldSetup ()
void	SetStepperType (G4int i)
void	SetMinStep (G4double s)
void	SetFieldValue (G4ThreeVector fieldVector)
void	SetFieldZValue (G4double fieldValue)
G4ThreeVector	GetConstantFieldValue ()
void	UpdateIntegrator ()

Protected Member Functions
G4FieldManager *	GetGlobalFieldManager ()
void	CreateStepper ()

Private Attributes
G4double	fMinStep = 0.010 * CLHEP::mm
G4FieldManager *	fFieldManager = nullptr
G4ChordFinder *	fChordFinder = nullptr
G4EqMagElectricField *	fEquation = nullptr
G4ElectricField *	fEMfield = nullptr
G4ThreeVector	fElFieldValue
G4MagIntegratorStepper *	fStepper = nullptr
G4MagInt_Driver *	fIntgrDriver = nullptr
G4int	fStepperType = 4
F02FieldMessenger *	fFieldMessenger = nullptr

Detailed Description

A class for control of the Electric Field of the detector.

The field for this case is uniform.

The field for this case is uniform. It is simply a 'setup' class that creates the field and necessary other parts

Definition at line 59 of file Doxymodules_field.h.

Constructor & Destructor Documentation

F02ElectricFieldSetup() [1/2]

F02ElectricFieldSetup::F02ElectricFieldSetup

(

G4ThreeVector

fieldVector

)

Definition at line 84 of file F02ElectricFieldSetup.cc.

{
  fEMfield = new G4UniformElectricField(fieldVector);
  fEquation = new G4EqMagElectricField(fEMfield);
 
  fFieldManager = GetGlobalFieldManager();
  UpdateIntegrator();
 
  fFieldMessenger = new F02FieldMessenger(this);
}

F02ElectricFieldSetup() [2/2]

F02ElectricFieldSetup::F02ElectricFieldSetup

(

)

Definition at line 70 of file F02ElectricFieldSetup.cc.

{
  fEMfield = new G4UniformElectricField(
                   G4ThreeVector(0.0,100000.0*kilovolt/cm,0.0));
  fEquation = new G4EqMagElectricField(fEMfield);
 
  fFieldManager = GetGlobalFieldManager();
 
  UpdateIntegrator();
  fFieldMessenger = new F02FieldMessenger(this);
}

~F02ElectricFieldSetup()

F02ElectricFieldSetup::~F02ElectricFieldSetup ( )

virtual

Definition at line 97 of file F02ElectricFieldSetup.cc.

{
  // G4cout << " F02ElectricFieldSetup - dtor called. " << G4endl;
 
  delete fFieldMessenger; fFieldMessenger= nullptr;
   // Delete the messenger first, to avoid messages to deleted classes!
 
  delete fChordFinder;  fChordFinder= nullptr;
  delete fStepper;      fStepper = nullptr;
  delete fEquation;     fEquation = nullptr;
  delete fEMfield;      fEMfield = nullptr;
}

Member Function Documentation

SetStepperType()

void F02ElectricFieldSetup::SetStepperType ( G4int  i )

inline

Definition at line 68 of file F02ElectricFieldSetup.hh.

{ fStepperType = i ; CreateStepper(); }

SetMinStep()

void F02ElectricFieldSetup::SetMinStep ( G4double  s )

inline

Definition at line 70 of file F02ElectricFieldSetup.hh.

{ fMinStep = s ; }

SetFieldValue()

void F02ElectricFieldSetup::SetFieldValue

(

G4ThreeVector

fieldVector

)

Definition at line 243 of file F02ElectricFieldSetup.cc.

{
  delete fEMfield;
 
  // Set the value of the Global Field value to fieldVector
 
  // Find the Field Manager for the global field
  G4FieldManager* fieldMgr= GetGlobalFieldManager();
 
  if (fieldVector != G4ThreeVector(0.,0.,0.))
  {
    fEMfield = new G4UniformElectricField(fieldVector);
  }
  else
  {
    // If the new field's value is Zero, then it is best to
    //  insure that it is not used for propagation.
    fEMfield = nullptr;
  }
  fieldMgr->SetDetectorField(fEMfield);
  fEquation->SetFieldObj(fEMfield);  // must now point to the new field
}

SetFieldZValue()

void F02ElectricFieldSetup::SetFieldZValue

(

G4double

fieldValue

)

Definition at line 232 of file F02ElectricFieldSetup.cc.

{
  // Set the value of the Global Field to fieldValue along Z
 
  G4ThreeVector fieldVector( 0.0, 0.0, fieldValue );
 
  SetFieldValue( fieldVector );
}

GetConstantFieldValue()

G4ThreeVector F02ElectricFieldSetup::GetConstantFieldValue

(

)

UpdateIntegrator()

void F02ElectricFieldSetup::UpdateIntegrator

(

)

Definition at line 112 of file F02ElectricFieldSetup.cc.

{
  // Register this field to 'global' Field Manager and
  // Create Stepper and Chord Finder with predefined type, minstep (resp.)
 
  // It must be possible to call 'again' after an alternative stepper
  //   has been chosen, or other changes have been made
  assert(fEquation!=nullptr);
 
  G4cout<< " F02ElectricFieldSetup: The minimal step is equal to "
        << fMinStep/mm << " mm" << G4endl;
 
  if (fChordFinder) {
     delete fChordFinder;
     fChordFinder= nullptr;
     // The chord-finder's destructor deletes the driver
     fIntgrDriver= nullptr;
  }
 
  // Currently driver does not 'own' stepper      ( 17.05.2017 J.A. )
  //   -- so this stepper is still a valid object after this
 
  if( fStepper ) {
     delete fStepper;
     fStepper = nullptr;
  }
 
  // Create the new objects, in turn for all relevant classes
  //  -- Careful to call this after all old objects are destroyed, and
  //      pointers nullified.
  CreateStepper();  // Note that this method deleted the existing Stepper!
  // G4cout << "F02ElectricFieldSetup::UpdateIntegrator> "
  //        << "New value of stepper ptr= " << fStepper << G4endl;
  assert(fStepper != nullptr);
 
  if( fStepper ) {
     fIntgrDriver = new G4MagInt_Driver(fMinStep,
                                        fStepper,
                                        fStepper->GetNumberOfVariables());
     if( fIntgrDriver ){
        fChordFinder = new G4ChordFinder(fIntgrDriver);
     }
  }
 
  fFieldManager->SetChordFinder(fChordFinder);
  fFieldManager->SetDetectorField(fEMfield);
}

GetGlobalFieldManager()

G4FieldManager * F02ElectricFieldSetup::GetGlobalFieldManager ( )

protected

Definition at line 268 of file F02ElectricFieldSetup.cc.

{
//  Utility method
 
  return G4TransportationManager::GetTransportationManager()
           ->GetFieldManager();
}

CreateStepper()

void F02ElectricFieldSetup::CreateStepper ( )

protected

Definition at line 162 of file F02ElectricFieldSetup.cc.

{
  // Deletes the existing stepper
  //   and creates a new stepper object of the chosen stepper type
 
  const G4int nvar = 8;
 
  auto oldStepper= fStepper;
 
  switch ( fStepperType )
  {
    case 0:
      fStepper = new G4ExplicitEuler( fEquation, nvar );
      G4cout<<"G4ExplicitEuler is calledS"<<G4endl;
      break;
    case 1:
      fStepper = new G4ImplicitEuler( fEquation, nvar );
      G4cout<<"G4ImplicitEuler is called"<<G4endl;
      break;
    case 2:
      fStepper = new G4SimpleRunge( fEquation, nvar );
      G4cout<<"G4SimpleRunge is called"<<G4endl;
      break;
    case 3:
      fStepper = new G4SimpleHeum( fEquation, nvar );
      G4cout<<"G4SimpleHeum is called"<<G4endl;
      break;
    case 4:
      fStepper = new G4ClassicalRK4( fEquation, nvar );
      G4cout<<"G4ClassicalRK4 is called"<<G4endl;
      break;
    case 5:
      fStepper = new G4CashKarpRKF45( fEquation, nvar );
      G4cout<<"G4CashKarpRKF45 is called"<<G4endl;
      break;
    case 6:
      fStepper = nullptr; // new G4RKG3_Stepper( fEquation, nvar );
      G4cout<<"G4RKG3_Stepper is not currently working for Electric Field"
            <<G4endl;
      break;
    case 7:
      fStepper = nullptr; // new G4HelixExplicitEuler( fEquation );
      G4cout<<"G4HelixExplicitEuler is not valid for Electric Field"<<G4endl;
      break;
    case 8:
      fStepper = nullptr; // new G4HelixImplicitEuler( fEquation );
      G4cout<<"G4HelixImplicitEuler is not valid for Electric Field"<<G4endl;
      break;
    case 9:
      fStepper = nullptr; // new G4HelixSimpleRunge( fEquation );
      G4cout<<"G4HelixSimpleRunge is not valid for Electric Field"<<G4endl;
      break;
    default:  /* fStepper = 0; // Older code */
      fStepper = new G4ClassicalRK4( fEquation, nvar );
      G4cout<<"G4ClassicalRK4 (default) is called"<<G4endl;
      break;
  }
 
  delete oldStepper;
  // Now must make sure it is 'stripped' from the dependent object(s)
  //  ... but the next line does this anyway - by informing
  //      the driver (if it exists) about the new stepper.
 
  // Always inform the (existing) driver about the new stepper
  if( fIntgrDriver )
      fIntgrDriver->RenewStepperAndAdjust( fStepper );
}

Member Data Documentation

fMinStep

G4double F02ElectricFieldSetup::fMinStep = 0.010 * CLHEP::mm

private

Definition at line 92 of file F02ElectricFieldSetup.hh.

fFieldManager

G4FieldManager* F02ElectricFieldSetup::fFieldManager = nullptr

private

Definition at line 94 of file F02ElectricFieldSetup.hh.

fChordFinder

G4ChordFinder* F02ElectricFieldSetup::fChordFinder = nullptr

private

Definition at line 95 of file F02ElectricFieldSetup.hh.

fEquation

G4EqMagElectricField* F02ElectricFieldSetup::fEquation = nullptr

private

Definition at line 96 of file F02ElectricFieldSetup.hh.

fEMfield

G4ElectricField* F02ElectricFieldSetup::fEMfield = nullptr

private

Definition at line 97 of file F02ElectricFieldSetup.hh.

fElFieldValue

G4ThreeVector F02ElectricFieldSetup::fElFieldValue

private

Definition at line 99 of file F02ElectricFieldSetup.hh.

fStepper

G4MagIntegratorStepper* F02ElectricFieldSetup::fStepper = nullptr

private

Definition at line 101 of file F02ElectricFieldSetup.hh.

fIntgrDriver

G4MagInt_Driver* F02ElectricFieldSetup::fIntgrDriver = nullptr

private

Definition at line 102 of file F02ElectricFieldSetup.hh.

fStepperType

G4int F02ElectricFieldSetup::fStepperType = 4

private

Definition at line 104 of file F02ElectricFieldSetup.hh.

fFieldMessenger

F02FieldMessenger* F02ElectricFieldSetup::fFieldMessenger = nullptr

private

Definition at line 106 of file F02ElectricFieldSetup.hh.

---

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

• .doxygen/Doxymodules_field.h
• extended/field/field02/include/F02ElectricFieldSetup.hh
• extended/field/field02/src/F02ElectricFieldSetup.cc