G4FieldManager Class Reference

#include <G4FieldManager.hh>

Public Member Functions
	G4FieldManager (G4Field *detectorField=nullptr, G4ChordFinder *pChordFinder=nullptr, G4bool b=true)
	G4FieldManager (G4MagneticField *detectorMagneticField)
virtual	~G4FieldManager ()
	G4FieldManager (const G4FieldManager &)=delete
G4FieldManager &	operator= (const G4FieldManager &)=delete
G4bool	SetDetectorField (G4Field *detectorField, G4int failMode=0)
void	ProposeDetectorField (G4Field *detectorField)
void	ChangeDetectorField (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 84 of file G4FieldManager.hh.

Constructor & Destructor Documentation

G4FieldManager() [1/3]

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

Definition at line 41 of file G4FieldManager.cc.

   : fDetectorField(detectorField), 
     fChordFinder(pChordFinder), 
     fDelta_One_Step_Value( fDefault_Delta_One_Step_Value ), 
     fDelta_Intersection_Val( fDefault_Delta_Intersection_Val ),     
     fEpsilonMin( fEpsilonMinDefault ),
     fEpsilonMax( fEpsilonMaxDefault)
{ 
   if ( detectorField != nullptr )
   {
     fFieldChangesEnergy = detectorField->DoesFieldChangeEnergy();
   }
   else
   {
     fFieldChangesEnergy = fieldChangesEnergy;
   }
 
   // Add to store
   //
   G4FieldManagerStore::Register(this);
}

G4FieldManager() [2/3]

G4FieldManager::G4FieldManager

(

G4MagneticField *

detectorMagneticField

)

Definition at line 65 of file G4FieldManager.cc.

   : fDetectorField(detectorField), fAllocatedChordFinder(true),
     fDelta_One_Step_Value(   fDefault_Delta_One_Step_Value ), 
     fDelta_Intersection_Val( fDefault_Delta_Intersection_Val ),
     fEpsilonMin( fEpsilonMinDefault ),
     fEpsilonMax( fEpsilonMaxDefault )
{
   fChordFinder = new G4ChordFinder( detectorField );
 
   // Add to store
   //
   G4FieldManagerStore::Register(this);
}

~G4FieldManager()

G4FieldManager::~G4FieldManager ( )

virtual

Definition at line 139 of file G4FieldManager.cc.

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

G4FieldManager() [3/3]

G4FieldManager::G4FieldManager ( const G4FieldManager &  )

delete

Member Function Documentation

ChangeDetectorField()

void G4FieldManager::ChangeDetectorField ( G4Field *  detectorField )

inline

Clone()

G4FieldManager * G4FieldManager::Clone ( ) const

virtual

Definition at line 79 of file G4FieldManager.cc.

{
    G4Field* aField = nullptr;
    G4FieldManager* aFM = nullptr;
    G4ChordFinder* aCF = nullptr;
    try {
        if ( fDetectorField != nullptr )
        {
           aField = fDetectorField->Clone();
        }
 
        // Create a new field manager, note that we do not set
        // any chordfinder now
        //
        aFM = new G4FieldManager( aField , nullptr , fFieldChangesEnergy );
 
        // Check if originally we have the fAllocatedChordFinder variable
        // set, in case, call chord constructor
        //
        if ( 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 = fChordFinder; /*->Clone*/
            aFM->fChordFinder = aCF;
        }
 
        // Copy values of other variables
 
        aFM->fEpsilonMax = fEpsilonMax;
        aFM->fEpsilonMin = fEpsilonMin;
        aFM->fDelta_Intersection_Val = fDelta_Intersection_Val;
        aFM->fDelta_One_Step_Value = 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;
}

Referenced by G4VUserDetectorConstruction::CloneF().

ConfigureForTrack()

void G4FieldManager::ConfigureForTrack ( const G4Track *  )

virtual

Definition at line 134 of file G4FieldManager.cc.

{
   // Default is to do nothing!
}

Referenced by G4CoupledTransportation::AlongStepGetPhysicalInteractionLength(), and G4ITTransportation::AlongStepGetPhysicalInteractionLength().

CreateChordFinder()

void G4FieldManager::CreateChordFinder

(

G4MagneticField *

detectorMagField

)

Definition at line 149 of file G4FieldManager.cc.

{
   if ( fAllocatedChordFinder )
   { 
      delete fChordFinder;
   }
   fAllocatedChordFinder = false;
 
   if( detectorMagField != nullptr )
   {
      fChordFinder = new G4ChordFinder( detectorMagField );
      fAllocatedChordFinder = true;
   }
   else
   {
      fChordFinder = nullptr;
   }
}

Referenced by Clone().

DoesFieldChangeEnergy()

G4bool G4FieldManager::DoesFieldChangeEnergy ( ) const

inline

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

DoesFieldExist()

G4bool G4FieldManager::DoesFieldExist ( ) const

inline

Referenced by G4VFieldModel::DescribeYourselfTo(), and G4ITTransportation::DoesGlobalFieldExist().

GetChordFinder() [1/2]

G4ChordFinder * G4FieldManager::GetChordFinder ( )

inline

Referenced by G4ErrorPropagatorManager::InitFieldForBackwards().

GetChordFinder() [2/2]

const G4ChordFinder * G4FieldManager::GetChordFinder ( ) const

inline

GetDeltaIntersection()

G4double G4FieldManager::GetDeltaIntersection ( ) const

inline

Referenced by G4PropagatorInField::RefreshIntersectionLocator().

GetDeltaOneStep()

G4double G4FieldManager::GetDeltaOneStep ( ) const

inline

Referenced by G4PropagatorInField::ComputeStep().

GetDetectorField()

const G4Field * G4FieldManager::GetDetectorField ( ) const

inline

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

GetMaximumEpsilonStep()

G4double G4FieldManager::GetMaximumEpsilonStep ( ) const

inline

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

GetMinimumEpsilonStep()

G4double G4FieldManager::GetMinimumEpsilonStep ( ) const

inline

Referenced by G4PropagatorInField::ComputeStep().

operator=()

G4FieldManager & G4FieldManager::operator= ( const G4FieldManager &  )

delete

ProposeDetectorField()

void G4FieldManager::ProposeDetectorField ( G4Field *  detectorField )

inline

SetAccuraciesWithDeltaOneStep()

void G4FieldManager::SetAccuraciesWithDeltaOneStep ( G4double  valDeltaOneStep )

inline

SetChordFinder()

void G4FieldManager::SetChordFinder ( G4ChordFinder *  aChordFinder )

inline

Referenced by G4ErrorPropagatorManager::InitFieldForBackwards().

SetDeltaIntersection()

void G4FieldManager::SetDeltaIntersection ( G4double  valueDintersection )

inline

SetDeltaOneStep()

void G4FieldManager::SetDeltaOneStep ( G4double  valueD1step )

inline

SetDetectorField()

G4bool G4FieldManager::SetDetectorField	(	G4Field *	detectorField,
		G4int	failMode = 0
	)

Definition at line 180 of file G4FieldManager.cc.

{
   G4VIntegrationDriver* driver = nullptr;
   G4EquationOfMotion* equation = nullptr;
   // G4bool  compatibleField = false;
   G4bool ableToSet = false;
 
   fDetectorField = pDetectorField;
   InitialiseFieldChangesEnergy();
   
   // Must 'propagate' the field to the dependent classes
   //
   if( fChordFinder != nullptr )
   {
     failMode= std::max( failMode, 1) ;
       // If a chord finder exists, warn in case of error!
      
     driver = fChordFinder->GetIntegrationDriver();
     if( driver != nullptr )
     {
       equation = driver->GetEquationOfMotion();
 
       // Should check the compatibility between the
       // field and the equation HERE
 
       if( equation != nullptr )
       {
          equation->SetFieldObj(pDetectorField);
          ableToSet = true;
       }
     }
   }
   
   if( !ableToSet && (failMode > 0) )
   {
     // If this fails, report the issue !
 
     G4ExceptionDescription msg;
     msg << "Unable to set the field in the dependent objects of G4FieldManager"
         << G4endl;
     msg << "All the dependent classes must be fully initialised,"
         << "before it is possible to call this method." << G4endl;
     msg << "The problem encountered was the following: " << G4endl;
     if( fChordFinder == nullptr ) { msg << "  No ChordFinder. " ; }
     else if( driver == nullptr )  { msg << "  No Integration Driver set. ";}
     else if( equation == nullptr ) { msg << "  No Equation found. " ; }
     // else if( !compatibleField ) { msg << "  Field not compatible. ";}
     else { msg << "  Can NOT find reason for failure. ";}
     msg << G4endl;
     G4ExceptionSeverity severity = (failMode != 1)
                                  ? FatalException : JustWarning ;
     G4Exception("G4FieldManager::SetDetectorField", "Geometry001",
                 severity, msg);
   }
   return ableToSet;
}

SetFieldChangesEnergy()

void G4FieldManager::SetFieldChangesEnergy ( G4bool  value )

inline

SetMaximumEpsilonStep()

void G4FieldManager::SetMaximumEpsilonStep ( G4double  newEpsMax )

inline

SetMinimumEpsilonStep()

void G4FieldManager::SetMinimumEpsilonStep ( G4double  newEpsMin )

inline

---

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

• G4FieldManager.hh
• G4FieldManager.cc