G4CachedMagneticField Class Reference

#include <G4CachedMagneticField.hh>

Inheritance diagram for G4CachedMagneticField:

Public Member Functions
void	ClearCounts ()
virtual G4Field *	Clone () const
G4bool	DoesFieldChangeEnergy () const
	G4CachedMagneticField (const G4CachedMagneticField &r)
	G4CachedMagneticField (G4MagneticField *, G4double distanceConst)
G4double	GetConstDistance () const
G4int	GetCountCalls () const
G4int	GetCountEvaluations () const
virtual void	GetFieldValue (const G4double Point[4], G4double *Bfield) const
G4bool	IsGravityActive () const
G4CachedMagneticField &	operator= (const G4CachedMagneticField &p)
void	ReportStatistics ()
void	SetConstDistance (G4double dist)
void	SetGravityActive (G4bool OnOffFlag)
virtual	~G4CachedMagneticField ()

Static Public Attributes
static constexpr G4int	MAX_NUMBER_OF_COMPONENTS = 24

Protected Attributes
G4int	fCountCalls = 0
G4int	fCountEvaluations = 0

Private Attributes
G4double	fDistanceConst
G4bool	fGravityActive = false
G4ThreeVector	fLastLocation
G4ThreeVector	fLastValue
G4MagneticField *	fpMagneticField = nullptr

Detailed Description

Definition at line 41 of file G4CachedMagneticField.hh.

Constructor & Destructor Documentation

G4CachedMagneticField() [1/2]

G4CachedMagneticField::G4CachedMagneticField	(	G4MagneticField *	pMagField,
		G4double	distanceConst
	)

Definition at line 33 of file G4CachedMagneticField.cc.

  : G4MagneticField(), fpMagneticField(pMagField), fDistanceConst(distance),
    fLastLocation(DBL_MAX,DBL_MAX,DBL_MAX), fLastValue(DBL_MAX,DBL_MAX,DBL_MAX)
{
  ClearCounts(); 
}

References ClearCounts().

Referenced by Clone().

~G4CachedMagneticField()

G4CachedMagneticField::~G4CachedMagneticField ( )

virtual

Definition at line 53 of file G4CachedMagneticField.cc.

{
}

G4CachedMagneticField() [2/2]

G4CachedMagneticField::G4CachedMagneticField

(

const G4CachedMagneticField &

r

)

Definition at line 65 of file G4CachedMagneticField.cc.

  : G4MagneticField(rightCMF)
{
  fpMagneticField= rightCMF.fpMagneticField;  // NOTE: sharing pointer here!
  fDistanceConst = rightCMF.fDistanceConst;
  fLastLocation  = rightCMF.fLastLocation;
  fLastValue     = rightCMF.fLastValue;
  ClearCounts(); 
}

References ClearCounts(), fDistanceConst, fLastLocation, fLastValue, and fpMagneticField.

Member Function Documentation

ClearCounts()

void G4CachedMagneticField::ClearCounts ( )

inline

Definition at line 61 of file G4CachedMagneticField.hh.

{ fCountCalls = 0; fCountEvaluations=0; }

References fCountCalls, and fCountEvaluations.

Referenced by G4CachedMagneticField(), and operator=().

Clone()

G4Field * G4CachedMagneticField::Clone ( ) const

virtual

Reimplemented from G4Field.

Definition at line 41 of file G4CachedMagneticField.cc.

{
  // Cannot use copy constructor: need to clone the associated magnetic field
 
  G4MagneticField* aF = static_cast<G4MagneticField*>(fpMagneticField->Clone());
  G4CachedMagneticField* cloned = new G4CachedMagneticField(aF, fDistanceConst);
 
  cloned->fLastLocation = fLastLocation;
  cloned->fLastValue = fLastValue;
  return cloned;
}

References G4Field::Clone(), fDistanceConst, fLastLocation, fLastValue, fpMagneticField, and G4CachedMagneticField().

DoesFieldChangeEnergy()

G4bool G4MagneticField::DoesFieldChangeEnergy ( ) const

inlinevirtualinherited

Implements G4Field.

Definition at line 52 of file G4MagneticField.hh.

{ return false; }

Referenced by export_G4MagneticField().

GetConstDistance()

G4double G4CachedMagneticField::GetConstDistance ( ) const

inline

Definition at line 56 of file G4CachedMagneticField.hh.

{ return fDistanceConst; } 

References fDistanceConst.

Referenced by G4NystromRK4::GetDistanceForConstantField().

GetCountCalls()

G4int G4CachedMagneticField::GetCountCalls ( ) const

inline

Definition at line 59 of file G4CachedMagneticField.hh.

{ return fCountCalls; }

References fCountCalls.

GetCountEvaluations()

G4int G4CachedMagneticField::GetCountEvaluations ( ) const

inline

Definition at line 60 of file G4CachedMagneticField.hh.

{ return fCountEvaluations; } 

References fCountEvaluations.

GetFieldValue()

void G4CachedMagneticField::GetFieldValue ( const G4double  Point[4], G4double *  Bfield  ) const

virtual

Implements G4MagneticField.

Definition at line 90 of file G4CachedMagneticField.cc.

{
  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->GetFieldValue( Point, Bfield );
     ++fCountEvaluations;
     fLastLocation = G4ThreeVector( Point[0],  Point[1],  Point[2] );
     fLastValue    = G4ThreeVector( Bfield[0], Bfield[1], Bfield[2] );
  }
}

References fCountCalls, fCountEvaluations, fDistanceConst, fLastLocation, fLastValue, fpMagneticField, G4MagneticField::GetFieldValue(), CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

IsGravityActive()

G4bool G4Field::IsGravityActive ( ) const

inlineinherited

Definition at line 101 of file G4Field.hh.

{
  return fGravityActive;
}

References G4Field::fGravityActive.

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

operator=()

G4CachedMagneticField & G4CachedMagneticField::operator=

(

const G4CachedMagneticField &

p

)

Definition at line 77 of file G4CachedMagneticField.cc.

{
  if (&p == this) { return *this; }
  G4MagneticField::operator=(p);
  fpMagneticField= p.fpMagneticField;  // NOTE: sharing pointer here!
  fDistanceConst = p.fDistanceConst;
  fLastLocation  = p.fLastLocation;
  fLastValue     = p.fLastValue;
  ClearCounts(); 
  return *this;
}

References ClearCounts(), fDistanceConst, fLastLocation, fLastValue, fpMagneticField, and G4MagneticField::operator=().

ReportStatistics()

void G4CachedMagneticField::ReportStatistics

(

)

Definition at line 58 of file G4CachedMagneticField.cc.

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

References fCountCalls, fCountEvaluations, G4cout, and G4endl.

SetConstDistance()

void G4CachedMagneticField::SetConstDistance ( G4double  dist )

inline

Definition at line 57 of file G4CachedMagneticField.hh.

{ fDistanceConst= dist;}

References fDistanceConst.

Referenced by G4NystromRK4::SetDistanceForConstantField().

SetGravityActive()

void G4Field::SetGravityActive ( G4bool  OnOffFlag )

inlineinherited

Definition at line 106 of file G4Field.hh.

{ 
  fGravityActive = OnOffFlag; 
}

References G4Field::fGravityActive.

Field Documentation

fCountCalls

G4int G4CachedMagneticField::fCountCalls = 0

mutableprotected

Definition at line 68 of file G4CachedMagneticField.hh.

Referenced by ClearCounts(), GetCountCalls(), GetFieldValue(), and ReportStatistics().

fCountEvaluations

G4int G4CachedMagneticField::fCountEvaluations = 0

protected

Definition at line 68 of file G4CachedMagneticField.hh.

Referenced by ClearCounts(), GetCountEvaluations(), GetFieldValue(), and ReportStatistics().

fDistanceConst

G4double G4CachedMagneticField::fDistanceConst

private

Definition at line 73 of file G4CachedMagneticField.hh.

Referenced by Clone(), G4CachedMagneticField(), GetConstDistance(), GetFieldValue(), operator=(), and SetConstDistance().

fGravityActive

G4bool G4Field::fGravityActive = false

privateinherited

Definition at line 96 of file G4Field.hh.

Referenced by G4Field::IsGravityActive(), G4Field::operator=(), and G4Field::SetGravityActive().

fLastLocation

G4ThreeVector G4CachedMagneticField::fLastLocation

mutableprivate

Definition at line 78 of file G4CachedMagneticField.hh.

Referenced by Clone(), G4CachedMagneticField(), GetFieldValue(), and operator=().

fLastValue

G4ThreeVector G4CachedMagneticField::fLastValue

mutableprivate

Definition at line 79 of file G4CachedMagneticField.hh.

Referenced by Clone(), G4CachedMagneticField(), GetFieldValue(), and operator=().

fpMagneticField

G4MagneticField* G4CachedMagneticField::fpMagneticField = nullptr

private

Definition at line 72 of file G4CachedMagneticField.hh.

Referenced by Clone(), G4CachedMagneticField(), GetFieldValue(), and operator=().

MAX_NUMBER_OF_COMPONENTS

constexpr G4int G4Field::MAX_NUMBER_OF_COMPONENTS = 24

staticconstexprinherited

Definition at line 92 of file G4Field.hh.

Referenced by G4BFieldIntegrationDriver::CurvatureRadius().

---

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

• source/geometry/magneticfield/include/G4CachedMagneticField.hh
• source/geometry/magneticfield/src/G4CachedMagneticField.cc