G4FieldManager Class Reference

#include <G4FieldManager.hh>

Public Member Functions
	G4FieldManager (G4Field *detectorField=0, G4ChordFinder *pChordFinder=0, G4bool b=true)
	G4FieldManager (G4MagneticField *detectorMagneticField)
virtual	~G4FieldManager ()
G4bool	SetDetectorField (G4Field *detectorField)
const G4Field *	GetDetectorField () const
G4bool	DoesFieldExist () const
void	CreateChordFinder (G4MagneticField *detectorMagField)
void	SetChordFinder (G4ChordFinder *aChordFinder)
G4ChordFinder *	GetChordFinder ()
const G4ChordFinder *	GetChordFinder () const
virtual void	ConfigureForTrack (const G4Track *)
G4double	GetDeltaIntersection () const
G4double	GetDeltaOneStep () const
void	SetAccuraciesWithDeltaOneStep (G4double valDeltaOneStep)
void	SetDeltaOneStep (G4double valueD1step)
void	SetDeltaIntersection (G4double valueDintersection)
G4double	GetMinimumEpsilonStep () const
void	SetMinimumEpsilonStep (G4double newEpsMin)
G4double	GetMaximumEpsilonStep () const
void	SetMaximumEpsilonStep (G4double newEpsMax)
G4bool	DoesFieldChangeEnergy () const
void	SetFieldChangesEnergy (G4bool value)
virtual G4FieldManager *	Clone () const

Detailed Description

Definition at line 83 of file G4FieldManager.hh.

Constructor & Destructor Documentation

G4FieldManager::G4FieldManager	(	G4Field *	detectorField = 0,
		G4ChordFinder *	pChordFinder = 0,
		G4bool	b = true
	)

Definition at line 37 of file G4FieldManager.cc.

References G4Field::DoesFieldChangeEnergy(), and G4FieldManagerStore::Register().

Referenced by Clone().

   : fDetectorField(detectorField), 
     fChordFinder(pChordFinder), 
     fAllocatedChordFinder(false),
     fEpsilonMinDefault(5.0e-5), 
     fEpsilonMaxDefault(0.001),
     fDefault_Delta_One_Step_Value(0.01),    // mm
     fDefault_Delta_Intersection_Val(0.001), // mm
     fEpsilonMin( fEpsilonMinDefault ),
     fEpsilonMax( fEpsilonMaxDefault)
{ 
   fDelta_One_Step_Value= fDefault_Delta_One_Step_Value;
   fDelta_Intersection_Val= fDefault_Delta_Intersection_Val;
   if ( detectorField )
     fFieldChangesEnergy= detectorField->DoesFieldChangeEnergy();
   else
     fFieldChangesEnergy= fieldChangesEnergy;

   // Add to store
   G4FieldManagerStore::Register(this);
}

G4FieldManager::G4FieldManager

(

G4MagneticField *

detectorMagneticField

)

Definition at line 62 of file G4FieldManager.cc.

References G4FieldManagerStore::Register().

   : fDetectorField(detectorField), fAllocatedChordFinder(true),
     fEpsilonMinDefault(5.0e-5), 
     fEpsilonMaxDefault(0.001),
     fFieldChangesEnergy(false), 
     fDefault_Delta_One_Step_Value(0.01),    // mm
     fDefault_Delta_Intersection_Val(0.001), // mm
     fEpsilonMin( fEpsilonMinDefault ),
     fEpsilonMax( fEpsilonMaxDefault)
{
   fChordFinder= new G4ChordFinder( detectorField );
   fDelta_One_Step_Value= fDefault_Delta_One_Step_Value;
   fDelta_Intersection_Val= fDefault_Delta_Intersection_Val;
   // Add to store
   G4FieldManagerStore::Register(this);
}

G4FieldManager::~G4FieldManager ( )

virtual

Definition at line 132 of file G4FieldManager.cc.

References G4FieldManagerStore::DeRegister().

{
   if( fAllocatedChordFinder ){
      delete fChordFinder;
   }
   G4FieldManagerStore::DeRegister(this);
}

Member Function Documentation

G4FieldManager * G4FieldManager::Clone ( ) const

virtual

Definition at line 79 of file G4FieldManager.cc.

References G4Field::Clone(), CreateChordFinder(), and G4FieldManager().

Referenced by G4VUserDetectorConstruction::CloneF().

{
    G4Field* aField = 0;
    G4FieldManager* aFM = 0;
    G4ChordFinder* aCF = 0;
    try {
        if ( this->fDetectorField )
            aField = this->fDetectorField->Clone();

        //Create a new field manager, note that we do not set any chordfinder now.
        aFM = new G4FieldManager( aField , 0 , this->fFieldChangesEnergy );

        //Check if orignally we have the fAllocatedChordFinder variable set, in case, call chord
        //constructor
        if ( this->fAllocatedChordFinder )
        {
            aFM->CreateChordFinder( dynamic_cast<G4MagneticField*>(aField) );
        }
        else
        {
            //Chord was specified by user, should we clone?
            //TODO: For the moment copy pointer, to be understood if cloning of ChordFinder is needed
            aCF = this->fChordFinder;/*->Clone*/
            aFM->fChordFinder = aCF;
        }
        //Copy values of other variables
        aFM->fEpsilonMax = this->fEpsilonMax;
        aFM->fEpsilonMin = this->fEpsilonMin;
        aFM->fDefault_Delta_Intersection_Val = this->fDefault_Delta_Intersection_Val;
        aFM->fDefault_Delta_One_Step_Value = this->fDefault_Delta_One_Step_Value;
        aFM->fDelta_Intersection_Val = this->fDelta_Intersection_Val;
        aFM->fDelta_One_Step_Value = this->fDelta_One_Step_Value;
        //TODO: Should we really add to the store the cloned FM? Who will use this?
    }
    catch ( ... )
    {
        //Failed creating clone: probably user did not implement Clone method
        //in derived classes?
        //Perform clean-up after ourselves...
        delete aField;
        delete aFM;
        delete aCF;
        throw;
    }
    return aFM;
}

void G4FieldManager::ConfigureForTrack ( const G4Track *  )

virtual

Definition at line 126 of file G4FieldManager.cc.

Referenced by G4Transportation::AlongStepGetPhysicalInteractionLength(), G4CoupledTransportation::AlongStepGetPhysicalInteractionLength(), G4MonopoleTransportation::AlongStepGetPhysicalInteractionLength(), G4ITTransportation::AlongStepGetPhysicalInteractionLength(), and export_G4FieldManager().

{
   // Default is to do nothing!
   ;
}

void G4FieldManager::CreateChordFinder

(

G4MagneticField *

detectorMagField

)

Definition at line 141 of file G4FieldManager.cc.

Referenced by Clone(), RE05DetectorConstruction::ConstructSDandField(), B5DetectorConstruction::ConstructSDandField(), ExErrorMagneticField::ExErrorMagneticField(), ExN02MagneticField::ExN02MagneticField(), ExP01MagneticField::ExP01MagneticField(), export_G4FieldManager(), DetectorConstruction::SetMagField(), ExN03DetectorConstruction::SetMagField(), and GammaRayTelDetectorConstruction::SetMagField().

{
   if ( fAllocatedChordFinder )
      delete fChordFinder;
   fChordFinder= new G4ChordFinder( detectorMagField );
   fAllocatedChordFinder= true;
}

G4bool G4FieldManager::DoesFieldChangeEnergy ( ) const

inline

Referenced by G4Transportation::AlongStepGetPhysicalInteractionLength(), G4CoupledTransportation::AlongStepGetPhysicalInteractionLength(), and export_G4FieldManager().

G4bool G4FieldManager::DoesFieldExist ( ) const

inline

Referenced by G4MagneticFieldModel::DescribeYourselfTo(), G4ITTransportation::DoesGlobalFieldExist(), and export_G4FieldManager().

G4ChordFinder* G4FieldManager::GetChordFinder ( )

inline

Referenced by DetectorConstruction::ConstructSDandField(), and G4ErrorPropagatorManager::InitFieldForBackwards().

const G4ChordFinder * G4FieldManager::GetChordFinder ( ) const

inline

Definition at line 47 of file pyG4FieldManager.cc.

{
  return fChordFinder;
}

G4double G4FieldManager::GetDeltaIntersection ( ) const

inline

Referenced by export_G4FieldManager(), and G4PropagatorInField::RefreshIntersectionLocator().

G4double G4FieldManager::GetDeltaOneStep ( ) const

inline

Referenced by G4PropagatorInField::ComputeStep(), and export_G4FieldManager().

const G4Field* G4FieldManager::GetDetectorField ( ) const

inline

Referenced by G4Transportation::AlongStepGetPhysicalInteractionLength(), G4CoupledTransportation::AlongStepGetPhysicalInteractionLength(), G4MonopoleTransportation::AlongStepGetPhysicalInteractionLength(), G4ITTransportation::AlongStepGetPhysicalInteractionLength(), G4ErrorSurfaceTrajState::BuildErrorMatrix(), G4PathFinder::ComputeStep(), G4DecayWithSpin::DecayIt(), G4MagneticFieldModel::DescribeYourselfTo(), export_G4FieldManager(), G4CoupledTransportation::G4CoupledTransportation(), G4ErrorFreeTrajState::G4ErrorFreeTrajState(), G4SynchrotronRadiation::GetMeanFreePath(), G4SynchrotronRadiationInMat::GetMeanFreePath(), G4SynchrotronRadiationInMat::GetPhotonEnergy(), G4ErrorPropagatorManager::InitFieldForBackwards(), G4SynchrotronRadiation::PostStepDoIt(), G4SynchrotronRadiationInMat::PostStepDoIt(), G4ErrorMagFieldLimitProcess::PostStepGetPhysicalInteractionLength(), and G4ErrorFreeTrajState::PropagateError().

G4double G4FieldManager::GetMaximumEpsilonStep ( ) const

inline

Referenced by G4PropagatorInField::ComputeStep(), export_G4FieldManager(), and G4PropagatorInField::G4PropagatorInField().

G4double G4FieldManager::GetMinimumEpsilonStep ( ) const

inline

Referenced by G4PropagatorInField::ComputeStep(), and export_G4FieldManager().

void G4FieldManager::SetAccuraciesWithDeltaOneStep ( G4double  valDeltaOneStep )

inline

Referenced by F04GlobalField::ConstructField(), F05DetectorConstruction::ConstructSDandField(), F06DetectorConstruction::ConstructSDandField(), and export_G4FieldManager().

void G4FieldManager::SetChordFinder ( G4ChordFinder *  aChordFinder )

inline

Referenced by CCalDetectorConstruction::Construct(), F04GlobalField::ConstructField(), F05DetectorConstruction::ConstructSDandField(), F06DetectorConstruction::ConstructSDandField(), DetectorConstruction::ConstructSDandField(), F01FieldSetup::CreateStepperAndChordFinder(), export_G4FieldManager(), G4ErrorPropagatorManager::InitFieldForBackwards(), G4MonopoleFieldSetup::SetStepperAndChordFinder(), F02ElectricFieldSetup::UpdateField(), and F03FieldSetup::UpdateField().

void G4FieldManager::SetDeltaIntersection ( G4double  valueDintersection )

inline

Referenced by CCalDetectorConstruction::Construct(), F04GlobalField::ConstructField(), F05DetectorConstruction::ConstructSDandField(), F06DetectorConstruction::ConstructSDandField(), DetectorConstruction::ConstructSDandField(), and export_G4FieldManager().

void G4FieldManager::SetDeltaOneStep ( G4double  valueD1step )

inline

Referenced by CCalDetectorConstruction::Construct(), DetectorConstruction::ConstructSDandField(), and export_G4FieldManager().

G4bool G4FieldManager::SetDetectorField

(

G4Field *

detectorField

)

Definition at line 149 of file G4FieldManager.cc.

References G4Field::DoesFieldChangeEnergy().

Referenced by CCalDetectorConstruction::Construct(), F04GlobalField::ConstructField(), RE05DetectorConstruction::ConstructSDandField(), B5DetectorConstruction::ConstructSDandField(), F05DetectorConstruction::ConstructSDandField(), F06DetectorConstruction::ConstructSDandField(), DetectorConstruction::ConstructSDandField(), F01FieldSetup::CreateStepperAndChordFinder(), ExErrorMagneticField::ExErrorMagneticField(), ExN02MagneticField::ExN02MagneticField(), ExP01MagneticField::ExP01MagneticField(), export_G4FieldManager(), ExErrorMagneticField::SetFieldValue(), ExP01MagneticField::SetFieldValue(), F03FieldSetup::SetFieldValue(), F02ElectricFieldSetup::SetFieldValue(), F01FieldSetup::SetFieldValue(), DetectorConstruction::SetMagField(), ExN03DetectorConstruction::SetMagField(), G4MonopoleFieldSetup::SetMagField(), GammaRayTelDetectorConstruction::SetMagField(), ExN02MagneticField::SetMagFieldValue(), G4MonopoleFieldSetup::SetStepperAndChordFinder(), F02ElectricFieldSetup::UpdateField(), and F03FieldSetup::UpdateField().

{
   fDetectorField= pDetectorField;

   if ( pDetectorField )
     fFieldChangesEnergy= pDetectorField->DoesFieldChangeEnergy();
   else
     fFieldChangesEnergy= false;   //  No field 

   return false;
}

void G4FieldManager::SetFieldChangesEnergy ( G4bool  value )

inline

Referenced by F04GlobalField::ConstructField(), and export_G4FieldManager().

void G4FieldManager::SetMaximumEpsilonStep ( G4double  newEpsMax )

inline

Referenced by export_G4FieldManager().

void G4FieldManager::SetMinimumEpsilonStep ( G4double  newEpsMin )

inline

Referenced by export_G4FieldManager().

---

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

• G4FieldManager.hh
• pyG4FieldManager.cc
• G4FieldManager.cc