G4TCachedMagneticField< T_Field > Class Template Reference

#include <G4TCachedMagneticField.hh>

Inheritance diagram for G4TCachedMagneticField< T_Field >:

Public Member Functions
	G4TCachedMagneticField (T_Field *pTField, G4double distance)
	G4TCachedMagneticField (const G4TCachedMagneticField< T_Field > &rightCMF)
G4TCachedMagneticField *	Clone () const
virtual	~G4TCachedMagneticField ()
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 ()
G4TCachedMagneticField &	operator= (const G4TCachedMagneticField &right)
Public Member Functions inherited from G4MagneticField
	G4MagneticField ()
virtual	~G4MagneticField ()
	G4MagneticField (const G4MagneticField &r)
G4MagneticField &	operator= (const G4MagneticField &p)
G4bool	DoesFieldChangeEnergy () const
virtual void	GetFieldValue (const G4double Point[4], G4double *Bfield) const =0
Public Member Functions inherited from G4Field
	G4Field (G4bool gravityOn=false)
	G4Field (const G4Field &)
virtual	~G4Field ()
G4Field &	operator= (const G4Field &p)
virtual void	GetFieldValue (const G4double Point[4], G4double *fieldArr) const =0
virtual G4bool	DoesFieldChangeEnergy () const =0
G4bool	IsGravityActive () const
void	SetGravityActive (G4bool OnOffFlag)
virtual G4Field *	Clone () const

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 >

Definition at line 35 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 38 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;
 
    // G4cout << " Cached-B-Field constructor> Distance = " << distance <<
    // G4endl;
    this->ClearCounts();
  }

G4TCachedMagneticField() [2/2]

template<class T_Field >

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

inline

Definition at line 53 of file G4TCachedMagneticField.hh.

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

~G4TCachedMagneticField()

template<class T_Field >

virtual G4TCachedMagneticField< T_Field >::~G4TCachedMagneticField ( )

inlinevirtual

Definition at line 75 of file G4TCachedMagneticField.hh.

{ ; }

Member Function Documentation

ClearCounts()

template<class T_Field >

void G4TCachedMagneticField< T_Field >::ClearCounts ( )

inline

Definition at line 116 of file G4TCachedMagneticField.hh.

  {
    fCountCalls       = 0;
    fCountEvaluations = 0;
  }

Referenced by G4TCachedMagneticField< T_Field >::G4TCachedMagneticField().

Clone()

template<class T_Field >

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

inlinevirtual

Reimplemented from G4Field.

Definition at line 62 of file G4TCachedMagneticField.hh.

  {
    G4cout << "Clone is called" << G4endl;
    // Cannot use copy constructor: I need to clone the associated magnetif
    // 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 111 of file G4TCachedMagneticField.hh.

{ return fDistanceConst; }

GetCountCalls()

template<class T_Field >

G4int G4TCachedMagneticField< T_Field >::GetCountCalls ( ) const

inline

Definition at line 114 of file G4TCachedMagneticField.hh.

{ return fCountCalls; }

GetCountEvaluations()

template<class T_Field >

G4int G4TCachedMagneticField< T_Field >::GetCountEvaluations ( ) const

inline

Definition at line 115 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

Implements G4MagneticField.

Definition at line 85 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
    {
      // G4CachedMagneticField* thisNonC=
      // const_cast<G4CachedMagneticField*>(this);
      fpMagneticField->T_Field::GetFieldValue(Point, Bfield);
      // G4cout << " Evaluating. " << G4endl;
      fCountEvaluations++;
      // thisNonC->
      fLastLocation = G4ThreeVector(Point[0], Point[1], Point[2]);
      // thisNonC->
      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 122 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 78 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 112 of file G4TCachedMagneticField.hh.

{ fDistanceConst = dist; }

Member Data Documentation

fCountCalls

template<class T_Field >

G4int G4TCachedMagneticField< T_Field >::fCountCalls

mutableprotected

Definition at line 148 of file G4TCachedMagneticField.hh.

Referenced by G4TCachedMagneticField< T_Field >::ClearCounts(), G4TCachedMagneticField< T_Field >::GetCountCalls(), G4TCachedMagneticField< T_Field >::GetFieldValue(), G4TCachedMagneticField< T_Field >::operator=(), and G4TCachedMagneticField< T_Field >::ReportStatistics().

fCountEvaluations

template<class T_Field >

G4int G4TCachedMagneticField< T_Field >::fCountEvaluations

protected

Definition at line 148 of file G4TCachedMagneticField.hh.

Referenced by G4TCachedMagneticField< T_Field >::ClearCounts(), G4TCachedMagneticField< T_Field >::GetCountEvaluations(), G4TCachedMagneticField< T_Field >::GetFieldValue(), G4TCachedMagneticField< T_Field >::operator=(), and G4TCachedMagneticField< T_Field >::ReportStatistics().

---

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

• G4TCachedMagneticField.hh