F03FieldSetup Class Reference

#include <F03FieldSetup.hh>

Public Member Functions
	F03FieldSetup ()
virtual	~F03FieldSetup ()
void	SetStepperType (G4int i)
void	SetStepper ()
void	SetMinStep (G4double s)
void	SetFieldValue (G4ThreeVector fieldVector)
void	SetFieldValue (G4double fieldValue)
G4ThreeVector	GetConstantFieldValue ()
void	UpdateField ()
G4FieldManager *	GetLocalFieldManager ()

Protected Member Functions
G4FieldManager *	GetGlobalFieldManager ()

Protected Attributes
G4FieldManager *	fFieldManager
G4FieldManager *	fLocalFieldManager
G4ChordFinder *	fChordFinder
G4ChordFinder *	fLocalChordFinder
G4Mag_UsualEqRhs *	fEquation
G4Mag_UsualEqRhs *	fLocalEquation
G4MagneticField *	fMagneticField
G4MagneticField *	fLocalMagneticField
G4MagIntegratorStepper *	fStepper
G4MagIntegratorStepper *	fLocalStepper
G4int	fStepperType
G4double	fMinStep
F03FieldMessenger *	fFieldMessenger

Detailed Description

A class for setting up the Magnetic Field

It also creates the necessary classes to control accuracy of propagation. In this example

• There is a global field for most of the setup;
• A local field overides it for some volume(s) and it assumed to be uniform.

Definition at line 56 of file F03FieldSetup.hh.

Constructor & Destructor Documentation

F03FieldSetup::F03FieldSetup

(

)

Definition at line 66 of file F03FieldSetup.cc.

References fEquation, fFieldManager, fFieldMessenger, fLocalEquation, fLocalFieldManager, fLocalMagneticField, fMagneticField, fMinStep, fStepperType, GetGlobalFieldManager(), python.hepunit::mm, python.hepunit::tesla, and UpdateField().

 : fFieldManager(0),
   fLocalFieldManager(0),
   fChordFinder(0),
   fLocalChordFinder(0),
   fEquation(0),
   fLocalEquation(0),
   fMagneticField(0),
   fLocalMagneticField(0),
   fStepper(0),
   fLocalStepper(0),
   fFieldMessenger(0)
{
  fMagneticField = new G4UniformMagField(G4ThreeVector(3.3*tesla,
                                                       0.0, // 0.5*tesla,
                                                       0.0));
  fLocalMagneticField = new G4UniformMagField(G4ThreeVector(3.3*tesla,
                                                            0.0, // 0.5*tesla,
                                                            0.0));

  fFieldMessenger = new F03FieldMessenger(this);
 
  fEquation = new G4Mag_UsualEqRhs(fMagneticField);
  fLocalEquation = new G4Mag_UsualEqRhs(fLocalMagneticField);
 
  fMinStep     = 0.25*mm ; // minimal step of 1 mm is default
  fStepperType = 4 ;       // ClassicalRK4 is default stepper

  fFieldManager = GetGlobalFieldManager();
  fLocalFieldManager = new G4FieldManager();

  UpdateField();
}

F03FieldSetup::~F03FieldSetup ( )

virtual

Definition at line 102 of file F03FieldSetup.cc.

References fChordFinder, fFieldMessenger, fMagneticField, and fStepper.

{
  delete fMagneticField;
  delete fChordFinder;
  delete fStepper;
  delete fFieldMessenger;
}

Member Function Documentation

G4ThreeVector F03FieldSetup::GetConstantFieldValue

(

)

Definition at line 239 of file F03FieldSetup.cc.

References fMagneticField, and G4MagneticField::GetFieldValue().

Referenced by F03FieldMessenger::SetNewValue().

{
  static G4double fieldValue[6],  position[4];
  position[0] = position[1] = position[2] = position[3] = 0.0;

  fMagneticField->GetFieldValue( position, fieldValue);
  G4ThreeVector fieldVec(fieldValue[0], fieldValue[1], fieldValue[2]);

  return fieldVec;
}

G4FieldManager * F03FieldSetup::GetGlobalFieldManager ( )

protected

Definition at line 231 of file F03FieldSetup.cc.

References G4TransportationManager::GetFieldManager(), and G4TransportationManager::GetTransportationManager().

Referenced by F03FieldSetup(), and SetFieldValue().

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

G4FieldManager* F03FieldSetup::GetLocalFieldManager ( )

inline

Definition at line 74 of file F03FieldSetup.hh.

References fLocalFieldManager.

Referenced by F03DetectorConstruction::ConstructSDandField().

{ return fLocalFieldManager;}

void F03FieldSetup::SetFieldValue

(

G4ThreeVector

fieldVector

)

Definition at line 203 of file F03FieldSetup.cc.

References fEquation, fMagneticField, GetGlobalFieldManager(), G4FieldManager::SetDetectorField(), and G4EquationOfMotion::SetFieldObj().

Referenced by SetFieldValue(), and F03FieldMessenger::SetNewValue().

{
  if(fMagneticField) delete fMagneticField;

  if(fieldVector != G4ThreeVector(0.,0.,0.))
  {
    fMagneticField = new  G4UniformMagField(fieldVector);
  }
  else
  {
    // If the new field's value is Zero, then
    // setting the pointer to zero ensures
    // that it is not used for propagation.
    fMagneticField = 0;
  }

  // Either
  //   - UpdateField() to reset all (ChordFinder, Equation);
  // UpdateField();
  //     or simply update the field manager & equation of motion
  //     with pointer to new field
  GetGlobalFieldManager()->SetDetectorField(fMagneticField);
  fEquation->SetFieldObj( fMagneticField );

}

void F03FieldSetup::SetFieldValue

(

G4double

fieldValue

)

Definition at line 195 of file F03FieldSetup.cc.

References SetFieldValue().

{
  G4ThreeVector fieldSetVec(0.0, 0.0, fieldStrength);
  SetFieldValue( fieldSetVec );
}

void F03FieldSetup::SetMinStep ( G4double  s )

inline

Definition at line 66 of file F03FieldSetup.hh.

References fMinStep.

Referenced by F03FieldMessenger::SetNewValue().

{ fMinStep = s; }

void F03FieldSetup::SetStepper

(

)

Definition at line 133 of file F03FieldSetup.cc.

References fEquation, fLocalEquation, fLocalStepper, fStepper, fStepperType, G4cout, and G4endl.

Referenced by UpdateField().

{
  if (fStepper) delete fStepper;

  switch ( fStepperType )
  {
    case 0:
      fStepper = new G4ExplicitEuler( fEquation );
      fLocalStepper = new G4ExplicitEuler( fLocalEquation );
      G4cout<<"G4ExplicitEuler is called"<<G4endl;
      break;
    case 1:
      fStepper = new G4ImplicitEuler( fEquation );
      fLocalStepper = new G4ImplicitEuler( fLocalEquation );
      G4cout<<"G4ImplicitEuler is called"<<G4endl;
      break;
    case 2:
      fStepper = new G4SimpleRunge( fEquation );
      fLocalStepper = new G4SimpleRunge( fLocalEquation );
      G4cout<<"G4SimpleRunge is called"<<G4endl;
      break;
    case 3:
      fStepper = new G4SimpleHeum( fEquation );
      fLocalStepper = new G4SimpleHeum( fLocalEquation );
      G4cout<<"G4SimpleHeum is called"<<G4endl;
      break;
    case 4:
      fStepper = new G4ClassicalRK4( fEquation );
      fLocalStepper = new G4ClassicalRK4( fLocalEquation );
      G4cout<<"G4ClassicalRK4 (default) is called"<<G4endl;
      break;
    case 5:
      fStepper = new G4HelixExplicitEuler( fEquation );
      fLocalStepper = new G4HelixExplicitEuler( fLocalEquation );
      G4cout<<"G4HelixExplicitEuler is called"<<G4endl;
      break;
    case 6:
      fStepper = new G4HelixImplicitEuler( fEquation );
      fLocalStepper = new G4HelixImplicitEuler( fLocalEquation );
      G4cout<<"G4HelixImplicitEuler is called"<<G4endl;
      break;
    case 7:
      fStepper = new G4HelixSimpleRunge( fEquation );
      fLocalStepper = new G4HelixSimpleRunge( fLocalEquation );
      G4cout<<"G4HelixSimpleRunge is called"<<G4endl;
      break;
    case 8:
      fStepper = new G4CashKarpRKF45( fEquation );
      fLocalStepper = new G4CashKarpRKF45( fLocalEquation );
      G4cout<<"G4CashKarpRKF45 is called"<<G4endl;
      break;
    case 9:
      fStepper = new G4RKG3_Stepper( fEquation );
      fLocalStepper = new G4RKG3_Stepper( fLocalEquation );
      G4cout<<"G4RKG3_Stepper is called"<<G4endl;
      break;
    default: fStepper = 0;
  }
}

void F03FieldSetup::SetStepperType ( G4int  i )

inline

Definition at line 62 of file F03FieldSetup.hh.

References fStepperType.

Referenced by F03FieldMessenger::SetNewValue().

{ fStepperType = i; }

void F03FieldSetup::UpdateField

(

)

Definition at line 112 of file F03FieldSetup.cc.

References fChordFinder, fFieldManager, fLocalChordFinder, fLocalFieldManager, fLocalMagneticField, fLocalStepper, fMagneticField, fMinStep, fStepper, G4cout, G4endl, python.hepunit::mm, G4FieldManager::SetChordFinder(), G4FieldManager::SetDetectorField(), and SetStepper().

Referenced by F03FieldSetup(), and F03FieldMessenger::SetNewValue().

{
  SetStepper();
  G4cout<<"The minimal step is equal to "<<fMinStep/mm<<" mm"<<G4endl;

  fFieldManager->SetDetectorField(fMagneticField);
  fLocalFieldManager->SetDetectorField(fLocalMagneticField);

  if (fChordFinder) delete fChordFinder;
  if (fLocalChordFinder) delete fLocalChordFinder;

  fChordFinder = new G4ChordFinder(fMagneticField, fMinStep, fStepper);
  fLocalChordFinder = new G4ChordFinder(fLocalMagneticField,
                                        fMinStep,fLocalStepper);

  fFieldManager->SetChordFinder(fChordFinder);
  fLocalFieldManager->SetChordFinder(fLocalChordFinder);
}

Field Documentation

G4ChordFinder* F03FieldSetup::fChordFinder

protected

Definition at line 84 of file F03FieldSetup.hh.

Referenced by UpdateField(), and ~F03FieldSetup().

G4Mag_UsualEqRhs* F03FieldSetup::fEquation

protected

Definition at line 86 of file F03FieldSetup.hh.

Referenced by F03FieldSetup(), SetFieldValue(), and SetStepper().

G4FieldManager* F03FieldSetup::fFieldManager

protected

Definition at line 82 of file F03FieldSetup.hh.

Referenced by F03FieldSetup(), and UpdateField().

F03FieldMessenger* F03FieldSetup::fFieldMessenger

protected

Definition at line 97 of file F03FieldSetup.hh.

Referenced by F03FieldSetup(), and ~F03FieldSetup().

G4ChordFinder* F03FieldSetup::fLocalChordFinder

protected

Definition at line 85 of file F03FieldSetup.hh.

Referenced by UpdateField().

G4Mag_UsualEqRhs* F03FieldSetup::fLocalEquation

protected

Definition at line 87 of file F03FieldSetup.hh.

Referenced by F03FieldSetup(), and SetStepper().

G4FieldManager* F03FieldSetup::fLocalFieldManager

protected

Definition at line 83 of file F03FieldSetup.hh.

Referenced by F03FieldSetup(), GetLocalFieldManager(), and UpdateField().

G4MagneticField* F03FieldSetup::fLocalMagneticField

protected

Definition at line 89 of file F03FieldSetup.hh.

Referenced by F03FieldSetup(), and UpdateField().

G4MagIntegratorStepper* F03FieldSetup::fLocalStepper

protected

Definition at line 92 of file F03FieldSetup.hh.

Referenced by SetStepper(), and UpdateField().

G4MagneticField* F03FieldSetup::fMagneticField

protected

Definition at line 88 of file F03FieldSetup.hh.

Referenced by F03FieldSetup(), GetConstantFieldValue(), SetFieldValue(), UpdateField(), and ~F03FieldSetup().

G4double F03FieldSetup::fMinStep

protected

Definition at line 95 of file F03FieldSetup.hh.

Referenced by F03FieldSetup(), SetMinStep(), and UpdateField().

G4MagIntegratorStepper* F03FieldSetup::fStepper

protected

Definition at line 91 of file F03FieldSetup.hh.

Referenced by SetStepper(), UpdateField(), and ~F03FieldSetup().

G4int F03FieldSetup::fStepperType

protected

Definition at line 93 of file F03FieldSetup.hh.

Referenced by F03FieldSetup(), SetStepper(), and SetStepperType().

---

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

• F03FieldSetup.hh
• F03FieldSetup.cc