#include <G4FieldManager.hh>

Public Member Functions
void	ChangeDetectorField (G4Field *detectorField)

virtual G4FieldManager *	Clone () const

virtual void	ConfigureForTrack (const G4Track *)

void	CreateChordFinder (G4MagneticField *detectorMagField)

G4bool	DoesFieldChangeEnergy () const

G4bool	DoesFieldExist () const

	G4FieldManager (const G4FieldManager &)=delete

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

	G4FieldManager (G4MagneticField *detectorMagneticField)

G4ChordFinder *	GetChordFinder ()

const G4ChordFinder *	GetChordFinder () const

G4double	GetDeltaIntersection () const

G4double	GetDeltaOneStep () const

const G4Field *	GetDetectorField () const

G4double	GetMaximumEpsilonStep () const

G4double	GetMinimumEpsilonStep () const

G4FieldManager &	operator= (const G4FieldManager &)=delete

void	ProposeDetectorField (G4Field *detectorField)

void	SetAccuraciesWithDeltaOneStep (G4double valDeltaOneStep)

void	SetChordFinder (G4ChordFinder *aChordFinder)

void	SetDeltaIntersection (G4double valueDintersection)

void	SetDeltaOneStep (G4double valueD1step)

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

void	SetFieldChangesEnergy (G4bool value)

void	SetMaximumEpsilonStep (G4double newEpsMax)

void	SetMinimumEpsilonStep (G4double newEpsMin)

virtual	~G4FieldManager ()

Private Member Functions
void	InitialiseFieldChangesEnergy ()

Private Attributes
G4bool	fAllocatedChordFinder = false

G4ChordFinder *	fChordFinder = nullptr

G4double	fDelta_Intersection_Val

G4double	fDelta_One_Step_Value

G4Field *	fDetectorField = nullptr

G4double	fEpsilonMax

const G4double	fEpsilonMaxDefault = 1.0e-3

G4double	fEpsilonMin

const G4double	fEpsilonMinDefault = 5.0e-5

G4bool	fFieldChangesEnergy = false

Static Private Attributes
static G4double	fDefault_Delta_Intersection_Val = 0.001 * millimeter

static G4double	fDefault_Delta_One_Step_Value = 0.01 * millimeter

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);
}

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

Referenced by Clone().

◆ 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);
}

References fChordFinder, and G4FieldManagerStore::Register().

◆ ~G4FieldManager()

G4FieldManager::~G4FieldManager ( )

virtual

Definition at line 139 of file G4FieldManager.cc.

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

References G4FieldManagerStore::DeRegister(), fAllocatedChordFinder, and fChordFinder.

◆ 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;
}

References G4Field::Clone(), CreateChordFinder(), fAllocatedChordFinder, fChordFinder, fDelta_Intersection_Val, fDelta_One_Step_Value, fDetectorField, fEpsilonMax, fEpsilonMin, fFieldChangesEnergy, and G4FieldManager().

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(), G4ITTransportation::AlongStepGetPhysicalInteractionLength(), and export_G4FieldManager().

◆ 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;
   }
}

References fAllocatedChordFinder, and fChordFinder.

Referenced by Clone(), export_G4FieldManager(), G4GlobalMagFieldMessenger::SetField(), and ExN03DetectorConstruction::SetMagField().

◆ DoesFieldChangeEnergy()

G4bool G4FieldManager::DoesFieldChangeEnergy ( ) const

inline

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

◆ DoesFieldExist()

G4bool G4FieldManager::DoesFieldExist ( ) const

inline

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

◆ 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 export_G4FieldManager(), and G4PropagatorInField::RefreshIntersectionLocator().

◆ GetDeltaOneStep()

G4double G4FieldManager::GetDeltaOneStep ( ) const

inline

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

◆ GetDetectorField()

const G4Field * G4FieldManager::GetDetectorField ( ) const

inline

Referenced by G4CoupledTransportation::AlongStepGetPhysicalInteractionLength(), G4ITTransportation::AlongStepGetPhysicalInteractionLength(), G4DecayWithSpin::AtRestDoIt(), G4ErrorSurfaceTrajState::BuildErrorMatrix(), G4PathFinder::ComputeStep(), G4VFieldModel::DescribeYourselfTo(), export_G4FieldManager(), 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(), export_G4FieldManager(), and G4PropagatorInField::G4PropagatorInField().

◆ GetMinimumEpsilonStep()

G4double G4FieldManager::GetMinimumEpsilonStep ( ) const

inline

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

◆ InitialiseFieldChangesEnergy()

void G4FieldManager::InitialiseFieldChangesEnergy ( )

private

Definition at line 168 of file G4FieldManager.cc.

{
   if ( fDetectorField != nullptr )
   {
     fFieldChangesEnergy = fDetectorField->DoesFieldChangeEnergy();
   }
   else
   {
     fFieldChangesEnergy = false;   // No field, no change!
   }
}

References G4Field::DoesFieldChangeEnergy(), fDetectorField, and fFieldChangesEnergy.

Referenced by SetDetectorField().

◆ operator=()

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

delete

◆ ProposeDetectorField()

void G4FieldManager::ProposeDetectorField ( G4Field * detectorField )

inline

◆ SetAccuraciesWithDeltaOneStep()

void G4FieldManager::SetAccuraciesWithDeltaOneStep ( G4double valDeltaOneStep )

inline

Referenced by export_G4FieldManager().

◆ SetChordFinder()

void G4FieldManager::SetChordFinder ( G4ChordFinder * aChordFinder )

inline

Referenced by export_G4FieldManager(), and G4ErrorPropagatorManager::InitFieldForBackwards().

◆ SetDeltaIntersection()

void G4FieldManager::SetDeltaIntersection ( G4double valueDintersection )

inline

Referenced by export_G4FieldManager().

◆ SetDeltaOneStep()

void G4FieldManager::SetDeltaOneStep ( G4double valueD1step )

inline

Referenced by export_G4FieldManager().

◆ 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;
}

References FatalException, fChordFinder, fDetectorField, G4endl, G4Exception(), G4VIntegrationDriver::GetEquationOfMotion(), G4ChordFinder::GetIntegrationDriver(), InitialiseFieldChangesEnergy(), JustWarning, G4INCL::Math::max(), and G4EquationOfMotion::SetFieldObj().

Referenced by export_G4FieldManager(), G4GlobalMagFieldMessenger::SetField(), and ExN03DetectorConstruction::SetMagField().

◆ SetFieldChangesEnergy()

void G4FieldManager::SetFieldChangesEnergy ( G4bool value )

inline

Referenced by export_G4FieldManager().

◆ SetMaximumEpsilonStep()

void G4FieldManager::SetMaximumEpsilonStep ( G4double newEpsMax )

inline

Referenced by export_G4FieldManager().

◆ SetMinimumEpsilonStep()

void G4FieldManager::SetMinimumEpsilonStep ( G4double newEpsMin )

inline

Referenced by export_G4FieldManager().

Field Documentation

◆ fAllocatedChordFinder

G4bool G4FieldManager::fAllocatedChordFinder = false

private

Definition at line 188 of file G4FieldManager.hh.

Referenced by Clone(), CreateChordFinder(), and ~G4FieldManager().

◆ fChordFinder

G4ChordFinder* G4FieldManager::fChordFinder = nullptr

private

Definition at line 185 of file G4FieldManager.hh.

Referenced by Clone(), CreateChordFinder(), G4FieldManager(), SetDetectorField(), and ~G4FieldManager().

◆ fDefault_Delta_Intersection_Val

G4double G4FieldManager::fDefault_Delta_Intersection_Val = 0.001 * millimeter

staticprivate

Definition at line 198 of file G4FieldManager.hh.

◆ fDefault_Delta_One_Step_Value

G4double G4FieldManager::fDefault_Delta_One_Step_Value = 0.01 * millimeter

staticprivate

Definition at line 197 of file G4FieldManager.hh.

◆ fDelta_Intersection_Val

G4double G4FieldManager::fDelta_Intersection_Val

private

Definition at line 208 of file G4FieldManager.hh.

Referenced by Clone().

◆ fDelta_One_Step_Value

G4double G4FieldManager::fDelta_One_Step_Value

private

Definition at line 207 of file G4FieldManager.hh.

Referenced by Clone().

◆ fDetectorField

G4Field* G4FieldManager::fDetectorField = nullptr

private

Definition at line 184 of file G4FieldManager.hh.

Referenced by Clone(), InitialiseFieldChangesEnergy(), and SetDetectorField().

◆ fEpsilonMax

G4double G4FieldManager::fEpsilonMax

private

Definition at line 212 of file G4FieldManager.hh.

Referenced by Clone().

◆ fEpsilonMaxDefault

const G4double G4FieldManager::fEpsilonMaxDefault = 1.0e-3

private

Definition at line 195 of file G4FieldManager.hh.

◆ fEpsilonMin

G4double G4FieldManager::fEpsilonMin

private

Definition at line 211 of file G4FieldManager.hh.

Referenced by Clone().

◆ fEpsilonMinDefault

const G4double G4FieldManager::fEpsilonMinDefault = 5.0e-5

private

Definition at line 194 of file G4FieldManager.hh.

◆ fFieldChangesEnergy

G4bool G4FieldManager::fFieldChangesEnergy = false

private

Definition at line 203 of file G4FieldManager.hh.

Referenced by Clone(), G4FieldManager(), and InitialiseFieldChangesEnergy().

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

source/geometry/magneticfield/include/G4FieldManager.hh
source/geometry/magneticfield/src/G4FieldManager.cc

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4FieldManager() [1/3]

◆ G4FieldManager() [2/3]

◆ ~G4FieldManager()

◆ G4FieldManager() [3/3]

Member Function Documentation

◆ ChangeDetectorField()

◆ Clone()

◆ ConfigureForTrack()

◆ CreateChordFinder()

◆ DoesFieldChangeEnergy()

◆ DoesFieldExist()

◆ GetChordFinder() [1/2]

◆ GetChordFinder() [2/2]

◆ GetDeltaIntersection()

◆ GetDeltaOneStep()

◆ GetDetectorField()

◆ GetMaximumEpsilonStep()

◆ GetMinimumEpsilonStep()

◆ InitialiseFieldChangesEnergy()

◆ operator=()

◆ ProposeDetectorField()

◆ SetAccuraciesWithDeltaOneStep()

◆ SetChordFinder()

◆ SetDeltaIntersection()

◆ SetDeltaOneStep()

◆ SetDetectorField()

◆ SetFieldChangesEnergy()

◆ SetMaximumEpsilonStep()

◆ SetMinimumEpsilonStep()

Field Documentation

◆ fAllocatedChordFinder

◆ fChordFinder

◆ fDefault_Delta_Intersection_Val

◆ fDefault_Delta_One_Step_Value

◆ fDelta_Intersection_Val

◆ fDelta_One_Step_Value

◆ fDetectorField

◆ fEpsilonMax

◆ fEpsilonMaxDefault

◆ fEpsilonMin

◆ fEpsilonMinDefault

◆ fFieldChangesEnergy