G4TCachedMagneticField< T_Field > Class Template Reference

G4TCachedMagneticField is a templated implementation for a specialisation of G4MagneticField used to cache the Magnetic Field value. More...

#include <G4TCachedMagneticField.hh>

Inheritance diagram for G4TCachedMagneticField< T_Field >:

Public Member Functions
	G4TCachedMagneticField (T_Field *pTField, G4double distance)
virtual	~G4TCachedMagneticField ()=default
	G4TCachedMagneticField (const G4TCachedMagneticField< T_Field > &rightCMF)
G4TCachedMagneticField &	operator= (const G4TCachedMagneticField &right)
G4TCachedMagneticField *	Clone () const
void	ReportStatistics ()
virtual void	GetFieldValue (const G4double Point[4], G4double *Bfield) const
G4double	GetConstDistance () const
void	SetConstDistance (G4double dist)
G4int	GetCountCalls () const
G4int	GetCountEvaluations () const
void	ClearCounts ()
Public Member Functions inherited from G4MagneticField
	G4MagneticField ()
	~G4MagneticField () override=default
	G4MagneticField (const G4MagneticField &r)
G4MagneticField &	operator= (const G4MagneticField &p)
G4bool	DoesFieldChangeEnergy () const override
G4FieldType	GetFieldType () const override
Public Member Functions inherited from G4Field
	G4Field (G4bool gravityOn=false)
virtual	~G4Field ()=default
	G4Field (const G4Field &p)=default
G4Field &	operator= (const G4Field &p)
G4bool	IsGravityActive () const
void	SetGravityActive (G4bool OnOffFlag)

Protected Attributes
G4int	fCountCalls
G4int	fCountEvaluations

Additional Inherited Members
Static Public Attributes inherited from G4Field
static constexpr G4int	MAX_NUMBER_OF_COMPONENTS = 24

Detailed Description

template<class T_Field>
class G4TCachedMagneticField< T_Field >

G4TCachedMagneticField is a templated implementation for a specialisation of G4MagneticField used to cache the Magnetic Field value.

Definition at line 44 of file G4TCachedMagneticField.hh.

Constructor & Destructor Documentation

G4TCachedMagneticField() [1/2]

template<class T_Field>

G4TCachedMagneticField< T_Field >::G4TCachedMagneticField ( T_Field * pTField, G4double distance )

inline

Definition at line 48 of file G4TCachedMagneticField.hh.

      : G4MagneticField()
      , fLastLocation(DBL_MAX, DBL_MAX, DBL_MAX)
      , fLastValue(DBL_MAX, DBL_MAX, DBL_MAX)
      , fCountCalls(0)
      , fCountEvaluations(0)
    {
      fpMagneticField = pTField;
      fDistanceConst  = distance;
 
      this->ClearCounts();
    }

Referenced by Clone(), G4TCachedMagneticField(), and operator=().

~G4TCachedMagneticField()

template<class T_Field>

virtual G4TCachedMagneticField< T_Field >::~G4TCachedMagneticField ( )

virtualdefault

G4TCachedMagneticField() [2/2]

template<class T_Field>

G4TCachedMagneticField< T_Field >::G4TCachedMagneticField ( const G4TCachedMagneticField< T_Field > & rightCMF )

inline

Definition at line 63 of file G4TCachedMagneticField.hh.

    {
      fpMagneticField = rightCMF.fpMagneticField;
      fDistanceConst  = rightCMF.fDistanceConst;
      fLastLocation   = rightCMF.fLastLocation;
      fLastValue      = rightCMF.fLastValue;
      this->ClearCounts();
    }

Member Function Documentation

ClearCounts()

template<class T_Field>

void G4TCachedMagneticField< T_Field >::ClearCounts ( )

inline

Definition at line 132 of file G4TCachedMagneticField.hh.

    {
      fCountCalls       = 0;
      fCountEvaluations = 0;
    }

Referenced by G4TCachedMagneticField(), and G4TCachedMagneticField().

Clone()

template<class T_Field>

G4TCachedMagneticField * G4TCachedMagneticField< T_Field >::Clone ( ) const

inlinevirtual

Interface method to implement cloning, needed by multi-threading. Here issuing a fatal exception, as expecting this to be implemented concretely in derived classes.

Reimplemented from G4Field.

Definition at line 88 of file G4TCachedMagneticField.hh.

    {
      G4cout << "Clone is called" << G4endl;
      // Cannot use copy constructor: I need to clone associated magnetic field
      T_Field* aF = this->fpMagneticField->T_Field::Clone();
      G4TCachedMagneticField* cloned = new G4TCachedMagneticField(aF, this->fDistanceConst);
      cloned->fLastLocation = this->fLastLocation;
      cloned->fLastValue    = this->fLastValue;
      return cloned;
    }

GetConstDistance()

template<class T_Field>

G4double G4TCachedMagneticField< T_Field >::GetConstDistance ( ) const

inline

Definition at line 127 of file G4TCachedMagneticField.hh.

{ return fDistanceConst; }

GetCountCalls()

template<class T_Field>

G4int G4TCachedMagneticField< T_Field >::GetCountCalls ( ) const

inline

Definition at line 130 of file G4TCachedMagneticField.hh.

{ return fCountCalls; }

GetCountEvaluations()

template<class T_Field>

G4int G4TCachedMagneticField< T_Field >::GetCountEvaluations ( ) const

inline

Definition at line 131 of file G4TCachedMagneticField.hh.

{ return fCountEvaluations; }

GetFieldValue()

template<class T_Field>

virtual void G4TCachedMagneticField< T_Field >::GetFieldValue ( const G4double Point[4], G4double * Bfield ) const

inlinevirtual

Given the position time vector 'Point', returns the value of the field in the array 'Bfield'.

Parameters

[in]	Point	The position time vector.
[out]	Bfield	The field array in output.

Implements G4MagneticField.

Definition at line 106 of file G4TCachedMagneticField.hh.

    {
      G4ThreeVector newLocation(Point[0], Point[1], Point[2]);
 
      G4double distSq = (newLocation - fLastLocation).mag2();
      fCountCalls++;
      if(distSq < fDistanceConst * fDistanceConst)
      {
        Bfield[0] = fLastValue.x();
        Bfield[1] = fLastValue.y();
        Bfield[2] = fLastValue.z();
      }
      else
      {
        fpMagneticField->T_Field::GetFieldValue(Point, Bfield);
        fCountEvaluations++;
        fLastLocation = G4ThreeVector(Point[0], Point[1], Point[2]);
        fLastValue = G4ThreeVector(Bfield[0], Bfield[1], Bfield[2]);
      }
    }

operator=()

template<class T_Field>

G4TCachedMagneticField & G4TCachedMagneticField< T_Field >::operator= ( const G4TCachedMagneticField< T_Field > & right )

inline

Definition at line 72 of file G4TCachedMagneticField.hh.

    {
      if(&right == this) { return *this; }
 
      fpMagneticField = right.fpMagneticField;
 
      fDistanceConst= right.fDistanceConst;
      fLastLocation = right.fLastLocation;
      fLastValue = right.fLastValue;
 
      fCountCalls = 0;
      fCountEvaluations = 0;
    
      return *this;
    }

ReportStatistics()

template<class T_Field>

void G4TCachedMagneticField< T_Field >::ReportStatistics ( )

inline

Definition at line 99 of file G4TCachedMagneticField.hh.

    {
      G4cout << " Cached field: " << G4endl
             << "   Number of calls:        " << fCountCalls << G4endl
             << "   Number of evaluations : " << fCountEvaluations << G4endl;
    }

SetConstDistance()

template<class T_Field>

void G4TCachedMagneticField< T_Field >::SetConstDistance ( G4double dist )

inline

Definition at line 128 of file G4TCachedMagneticField.hh.

{ fDistanceConst = dist; }

Member Data Documentation

fCountCalls

template<class T_Field>

G4int G4TCachedMagneticField< T_Field >::fCountCalls

mutableprotected

Definition at line 140 of file G4TCachedMagneticField.hh.

Referenced by ClearCounts(), G4TCachedMagneticField(), GetCountCalls(), GetFieldValue(), operator=(), and ReportStatistics().

fCountEvaluations

template<class T_Field>

G4int G4TCachedMagneticField< T_Field >::fCountEvaluations

protected

Definition at line 140 of file G4TCachedMagneticField.hh.

Referenced by ClearCounts(), G4TCachedMagneticField(), GetCountEvaluations(), GetFieldValue(), operator=(), and ReportStatistics().

---

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

• G4TCachedMagneticField.hh