F04GlobalField Class Reference

#include <Doxymodules_field.h>

Inheritance diagram for F04GlobalField:

Public Member Functions
	~F04GlobalField () override
void	GetFieldValue (const G4double *point, G4double *field) const override
	GetFieldValue() returns the field value at a given point[].
G4bool	DoesFieldChangeEnergy () const override
	DoesFieldChangeEnergy() returns true.
void	AddElementField (F04ElementField *f)
	AddElementField() adds the ElementField object for a single element to the global field.
void	Clear ()
	Clear() removes all ElementField-s from the global object, and destroys them.
void	ConstructField ()
	constructs all field tracking objects
void	SetStepperType (G4int i)
	Set the Stepper types.
void	SetStepper ()
	Set the Stepper.
void	SetMinStep (G4double stp)
	Set the minimum step length.
void	SetDeltaChord (G4double dcr)
	Set the delta chord length.
void	SetDeltaOneStep (G4double stp)
	Set the delta one step length.
void	SetDeltaIntersection (G4double its)
	Set the delta intersection length.
void	SetEpsMin (G4double eps)
	Set the minimum eps length.
void	SetEpsMax (G4double eps)
	Set the maximum eps length.
FieldList *	GetFields ()
	Return the list of Element Fields.

Static Public Member Functions
static F04GlobalField *	GetObject (F04DetectorConstruction *const)
	GetObject() returns the single F04GlobalField object.
static F04GlobalField *	GetObject ()

Protected Member Functions
G4FieldManager *	GetGlobalFieldManager ()
	Get the global field manager.

Private Member Functions
	F04GlobalField (F04DetectorConstruction *const)
	F04GlobalField (const F04GlobalField &)
F04GlobalField &	operator= (const F04GlobalField &)
void	SetupArray ()

Private Attributes
G4int	fNfp = 0
G4bool	fFirst = true
FieldList *	fFields = nullptr
const F04ElementField **	fFp = nullptr
G4int	fStepperType = 4
G4double	fMinStep = 0.01 * CLHEP::mm
G4double	fDeltaChord = 3.0 * CLHEP::mm
G4double	fDeltaOneStep = 0.01 * CLHEP::mm
G4double	fDeltaIntersection = 0.1 * CLHEP::mm
G4double	fEpsMin = 2.5e-7
G4double	fEpsMax = 0.001
G4EqEMFieldWithSpin *	fEquation = nullptr
G4FieldManager *	fFieldManager = nullptr
G4PropagatorInField *	fFieldPropagator = nullptr
G4MagIntegratorStepper *	fStepper = nullptr
G4ChordFinder *	fChordFinder = nullptr
F04FieldMessenger *	fFieldMessenger
F04DetectorConstruction *	fDetectorConstruction = nullptr

Static Private Attributes
static G4ThreadLocal F04GlobalField *	fObject = nullptr

Detailed Description

Definition at line 107 of file Doxymodules_field.h.

Constructor & Destructor Documentation

F04GlobalField() [1/2]

F04GlobalField::F04GlobalField ( F04DetectorConstruction * const  det )

private

Definition at line 54 of file F04GlobalField.cc.

  : fDetectorConstruction(det)
{
  fFieldMessenger = new F04FieldMessenger(this,det);
 
  fFields = new FieldList();
 
  //  set object
  fObject = this;
 
  ConstructField();
}

F04GlobalField() [2/2]

F04GlobalField::F04GlobalField ( const F04GlobalField &  )

private

~F04GlobalField()

F04GlobalField::~F04GlobalField ( )

override

Definition at line 69 of file F04GlobalField.cc.

{
  Clear();
 
  delete fFields;
 
  delete fFieldMessenger;
 
  delete fEquation;
  delete fStepper;
  delete fChordFinder;
}

Member Function Documentation

operator=()

F04GlobalField & F04GlobalField::operator= ( const F04GlobalField &  )

private

SetupArray()

void F04GlobalField::SetupArray ( )

private

Definition at line 288 of file F04GlobalField.cc.

{
  fFirst = false;
  fNfp = fFields->size();
  fFp = new const F04ElementField* [fNfp+1]; // add 1 so it's never 0
  for (int i=0; i<fNfp; ++i) fFp[i] = (*fFields)[i];
}

GetObject() [1/2]

F04GlobalField * F04GlobalField::GetObject ( F04DetectorConstruction * const  det )

static

GetObject() returns the single F04GlobalField object.

It is constructed, if necessary.

Definition at line 179 of file F04GlobalField.cc.

{
  if (!fObject) new F04GlobalField(det);
  return fObject;
}

GetObject() [2/2]

F04GlobalField * F04GlobalField::GetObject ( )

static

Definition at line 187 of file F04GlobalField.cc.

{
  if (fObject) return fObject;
  return nullptr;
}

GetFieldValue()

void F04GlobalField::GetFieldValue ( const G4double *  point, G4double *  field  ) const

override

GetFieldValue() returns the field value at a given point[].

field is really field[6]: Bx,By,Bz,Ex,Ey,Ez. point[] is in global coordinates: x,y,z,t.

Definition at line 245 of file F04GlobalField.cc.

{
  // NOTE: this routine dominates the CPU time for tracking.
  // Using the simple array fFp[] instead of fields[]
  // directly sped it up
 
  field[0] = field[1] = field[2] = field[3] = field[4] = field[5] = 0.0;
 
  // protect against Geant4 bug that calls us with point[] NaN.
  if(point[0] != point[0]) return;
 
  // (can't use fNfp or fFp, as they may change)
  if (fFirst) ((F04GlobalField*)this)->SetupArray();   // (cast away const)
 
  for (int i=0; i<fNfp; ++i) {
      const F04ElementField* p = fFp[i];
      if (p->IsInBoundingBox(point)) {
         p->AddFieldValue(point,field);
      }
  }
 
}

DoesFieldChangeEnergy()

G4bool F04GlobalField::DoesFieldChangeEnergy ( ) const

inlineoverride

DoesFieldChangeEnergy() returns true.

Definition at line 94 of file F04GlobalField.hh.

{ return true; }

AddElementField()

void F04GlobalField::AddElementField ( F04ElementField *  f )

inline

AddElementField() adds the ElementField object for a single element to the global field.

Definition at line 98 of file F04GlobalField.hh.

  {
    if (fFields) fFields->push_back(f);
  }

Clear()

void F04GlobalField::Clear

(

)

Clear() removes all ElementField-s from the global object, and destroys them.

Used before the geometry is completely re-created.

Definition at line 270 of file F04GlobalField.cc.

{
  if (fFields) {
     if (fFields->size()>0) {
        FieldList::iterator i;
        for (i=fFields->begin(); i!=fFields->end(); ++i) delete *i;
        fFields->clear();
     }
  }
 
  delete [] fFp;
  fFirst = true;
  fNfp = 0;
  fFp = nullptr;
}

ConstructField()

void F04GlobalField::ConstructField

(

)

constructs all field tracking objects

Definition at line 84 of file F04GlobalField.cc.

{
  Clear();
 
  //  Construct equ. of motion of particles through B fields
//  fEquation = new G4Mag_EqRhs(this);
  //  Construct equ. of motion of particles through e.m. fields
//  fEquation = new G4EqMagElectricField(this);
  //  Construct equ. of motion of particles including spin through B fields
//  fEquation = new G4Mag_SpinEqRhs(this);
  //  Construct equ. of motion of particles including spin through e.m. fields
  fEquation = new G4EqEMFieldWithSpin(this);
 
  //  Get transportation, field, and propagator managers
  G4TransportationManager* transportManager =
         G4TransportationManager::GetTransportationManager();
 
  fFieldManager = GetGlobalFieldManager();
 
  fFieldPropagator = transportManager->GetPropagatorInField();
 
  //  Need to SetFieldChangesEnergy to account for a time varying electric
  //  field (r.f. fields)
  fFieldManager->SetFieldChangesEnergy(true);
 
  //  Set the field
  fFieldManager->SetDetectorField(this);
 
  //  Choose a stepper for integration of the equation of motion
  SetStepper();
 
  //  Create a cord finder providing the (global field, min step length,
  //  a pointer to the stepper)
  fChordFinder = new G4ChordFinder((G4MagneticField*)this,fMinStep,fStepper);
 
  // Set accuracy parameters
  fChordFinder->SetDeltaChord( fDeltaChord );
 
  fFieldManager->SetAccuraciesWithDeltaOneStep(fDeltaOneStep);
 
  fFieldManager->SetDeltaIntersection(fDeltaIntersection);
 
  fFieldPropagator->SetMinimumEpsilonStep(fEpsMin);
  fFieldPropagator->SetMaximumEpsilonStep(fEpsMax);
 
  G4cout << "Accuracy Parameters:" <<
            " MinStep=" << fMinStep <<
            " DeltaChord=" << fDeltaChord <<
            " DeltaOneStep=" << fDeltaOneStep << G4endl;
  G4cout << "                    " <<
            " DeltaIntersection=" << fDeltaIntersection <<
            " EpsMin=" << fEpsMin <<
            " EpsMax=" << fEpsMax <<  G4endl;
 
  fFieldManager->SetChordFinder(fChordFinder);
 
  G4double l = 0.0;
  G4double B1 = fDetectorConstruction->GetCaptureMgntB1();
  G4double B2 = fDetectorConstruction->GetCaptureMgntB2();
 
  G4LogicalVolume* logicCaptureMgnt = fDetectorConstruction->GetCaptureMgnt();
  G4ThreeVector captureMgntCenter =
                                 fDetectorConstruction->GetCaptureMgntCenter();
 
  auto  focusSolenoid =
           new F04FocusSolenoid(B1, B2, l, logicCaptureMgnt,captureMgntCenter);
  focusSolenoid -> SetHalf(true);
 
  G4double B = fDetectorConstruction->GetTransferMgntB();
 
  G4LogicalVolume* logicTransferMgnt =
                                      fDetectorConstruction->GetTransferMgnt();
  G4ThreeVector transferMgntCenter =
                                fDetectorConstruction->GetTransferMgntCenter();
 
  auto  simpleSolenoid =
             new F04SimpleSolenoid(B, l, logicTransferMgnt,transferMgntCenter);
 
  simpleSolenoid->SetColor("1,0,1");
  simpleSolenoid->SetColor("0,1,1");
  simpleSolenoid->SetMaxStep(1.5*mm);
  simpleSolenoid->SetMaxStep(2.5*mm);
 
  if (fFields) {
     if (fFields->size()>0) {
        FieldList::iterator i;
        for (i=fFields->begin(); i!=fFields->end(); ++i){
            (*i)->Construct();
        }
     }
  }
}

SetStepperType()

void F04GlobalField::SetStepperType ( G4int  i )

inline

Set the Stepper types.

Definition at line 112 of file F04GlobalField.hh.

{ fStepperType = i; }

SetStepper()

void F04GlobalField::SetStepper

(

)

Set the Stepper.

Definition at line 195 of file F04GlobalField.cc.

{
  delete fStepper;
 
  switch ( fStepperType )
  {
    case 0:
//      fStepper = new G4ExplicitEuler( fEquation, 8 ); // no spin tracking
      fStepper = new G4ExplicitEuler( fEquation, 12 ); // with spin tracking
      G4cout << "G4ExplicitEuler is called" << G4endl;
      break;
    case 1:
//      fStepper = new G4ImplicitEuler( fEquation, 8 ); // no spin tracking
      fStepper = new G4ImplicitEuler( fEquation, 12 ); // with spin tracking
      G4cout << "G4ImplicitEuler is called" << G4endl;
      break;
    case 2:
//      fStepper = new G4SimpleRunge( fEquation, 8 ); // no spin tracking
      fStepper = new G4SimpleRunge( fEquation, 12 ); // with spin tracking
      G4cout << "G4SimpleRunge is called" << G4endl;
      break;
    case 3:
//      fStepper = new G4SimpleHeum( fEquation, 8 ); // no spin tracking
      fStepper = new G4SimpleHeum( fEquation, 12 ); // with spin tracking
      G4cout << "G4SimpleHeum is called" << G4endl;
      break;
    case 4:
//      fStepper = new G4ClassicalRK4( fEquation, 8 ); // no spin tracking
      fStepper = new G4ClassicalRK4( fEquation, 12 ); // with spin tracking
      G4cout << "G4ClassicalRK4 (default) is called" << G4endl;
      break;
    case 5:
//      fStepper = new G4CashKarpRKF45( fEquation, 8 ); // no spin tracking
      fStepper = new G4CashKarpRKF45( fEquation, 12 ); // with spin tracking
      G4cout << "G4CashKarpRKF45 is called" << G4endl;
      break;
    default: fStepper = nullptr;
  }
}

SetMinStep()

void F04GlobalField::SetMinStep ( G4double  stp )

inline

Set the minimum step length.

Definition at line 118 of file F04GlobalField.hh.

{ fMinStep = stp; }

SetDeltaChord()

void F04GlobalField::SetDeltaChord ( G4double  dcr )

inline

Set the delta chord length.

Definition at line 121 of file F04GlobalField.hh.

{ fDeltaChord = dcr; }

SetDeltaOneStep()

void F04GlobalField::SetDeltaOneStep ( G4double  stp )

inline

Set the delta one step length.

Definition at line 124 of file F04GlobalField.hh.

{ fDeltaOneStep = stp; }

SetDeltaIntersection()

void F04GlobalField::SetDeltaIntersection ( G4double  its )

inline

Set the delta intersection length.

Definition at line 127 of file F04GlobalField.hh.

{ fDeltaIntersection = its; }

SetEpsMin()

void F04GlobalField::SetEpsMin ( G4double  eps )

inline

Set the minimum eps length.

Definition at line 130 of file F04GlobalField.hh.

{ fEpsMin = eps; }

SetEpsMax()

void F04GlobalField::SetEpsMax ( G4double  eps )

inline

Set the maximum eps length.

Definition at line 133 of file F04GlobalField.hh.

{ fEpsMax = eps; }

GetFields()

FieldList * F04GlobalField::GetFields ( )

inline

Return the list of Element Fields.

Definition at line 136 of file F04GlobalField.hh.

{ return fFields; }

GetGlobalFieldManager()

G4FieldManager * F04GlobalField::GetGlobalFieldManager ( )

protected

Get the global field manager.

Definition at line 237 of file F04GlobalField.cc.

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

Member Data Documentation

fObject

G4ThreadLocal F04GlobalField * F04GlobalField::fObject = nullptr

staticprivate

Definition at line 145 of file F04GlobalField.hh.

fNfp

G4int F04GlobalField::fNfp = 0

private

Definition at line 147 of file F04GlobalField.hh.

fFirst

G4bool F04GlobalField::fFirst = true

private

Definition at line 148 of file F04GlobalField.hh.

fFields

FieldList* F04GlobalField::fFields = nullptr

private

Definition at line 150 of file F04GlobalField.hh.

fFp

const F04ElementField** F04GlobalField::fFp = nullptr

private

Definition at line 152 of file F04GlobalField.hh.

fStepperType

G4int F04GlobalField::fStepperType = 4

private

Definition at line 159 of file F04GlobalField.hh.

fMinStep

G4double F04GlobalField::fMinStep = 0.01 * CLHEP::mm

private

Definition at line 163 of file F04GlobalField.hh.

fDeltaChord

G4double F04GlobalField::fDeltaChord = 3.0 * CLHEP::mm

private

Definition at line 164 of file F04GlobalField.hh.

fDeltaOneStep

G4double F04GlobalField::fDeltaOneStep = 0.01 * CLHEP::mm

private

Definition at line 165 of file F04GlobalField.hh.

fDeltaIntersection

G4double F04GlobalField::fDeltaIntersection = 0.1 * CLHEP::mm

private

Definition at line 166 of file F04GlobalField.hh.

fEpsMin

G4double F04GlobalField::fEpsMin = 2.5e-7

private

Definition at line 168 of file F04GlobalField.hh.

fEpsMax

G4double F04GlobalField::fEpsMax = 0.001

private

Definition at line 169 of file F04GlobalField.hh.

fEquation

G4EqEMFieldWithSpin* F04GlobalField::fEquation = nullptr

private

Definition at line 177 of file F04GlobalField.hh.

fFieldManager

G4FieldManager* F04GlobalField::fFieldManager = nullptr

private

Definition at line 179 of file F04GlobalField.hh.

fFieldPropagator

G4PropagatorInField* F04GlobalField::fFieldPropagator = nullptr

private

Definition at line 180 of file F04GlobalField.hh.

fStepper

G4MagIntegratorStepper* F04GlobalField::fStepper = nullptr

private

Definition at line 181 of file F04GlobalField.hh.

fChordFinder

G4ChordFinder* F04GlobalField::fChordFinder = nullptr

private

Definition at line 182 of file F04GlobalField.hh.

fFieldMessenger

F04FieldMessenger* F04GlobalField::fFieldMessenger

private

Definition at line 185 of file F04GlobalField.hh.

fDetectorConstruction

F04DetectorConstruction* F04GlobalField::fDetectorConstruction = nullptr

private

Definition at line 186 of file F04GlobalField.hh.

---

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

• .doxygen/Doxymodules_field.h
• extended/field/field04/include/F04GlobalField.hh
• extended/field/field04/src/F04GlobalField.cc