A base class for electro-magnetic fields in local to be used in global coordinates. More...

#include <BDSFieldEMGlobal.hh>

Inheritance diagram for BDSFieldEMGlobal:

Collaboration diagram for BDSFieldEMGlobal:

Public Member Functions
	BDSFieldEMGlobal (BDSFieldEM *fieldIn)

virtual std::pair< G4ThreeVector, G4ThreeVector >	GetFieldTransformed (const G4ThreeVector &position, const G4double t) const

virtual std::pair< G4ThreeVector, G4ThreeVector >	GetField (const G4ThreeVector &position, const G4double t) const

virtual G4bool	DoesFieldChangeEnergy () const
	Necessary overload for Geant4.

Public Member Functions inherited from BDSFieldEM
	BDSFieldEM ()

	BDSFieldEM (G4Transform3D transformIn)

virtual std::pair< G4ThreeVector, G4ThreeVector >	GetField (const G4ThreeVector &position, const G4double t=0) const =0

virtual G4bool	TimeVarying () const

virtual void	GetFieldValue (const G4double point[4], G4double *field) const

virtual std::pair< G4ThreeVector, G4ThreeVector >	GetFieldTransformed (const G4ThreeVector &position, const G4double t) const
	Get the field value after applying transform for local offset.

virtual void	SetTransform (const G4Transform3D &transformIn)

virtual G4bool	DoesFieldChangeEnergy () const
	Required overload by Geant4.

void	SetModulator (BDSModulator *modulatorIn)
	Set the optional modulator.

G4bool	FiniteStrength () const
	Accessor.

Public Member Functions inherited from BDSAuxiliaryNavigator
G4VPhysicalVolume *	LocateGlobalPointAndSetup (const G4ThreeVector &point, const G4ThreeVector *direction=nullptr, const G4bool pRelativeSearch=true, const G4bool ignoreDirection=true, G4bool useCurvilinear=true) const
	A wrapper for the underlying static navigator instance located within this class.

G4VPhysicalVolume *	LocateGlobalPointAndSetup (G4Step const *const step, G4bool useCurvilinear=true) const

BDSStep	ConvertToLocal (G4Step const *const step, G4bool useCurvilinear=true) const

BDSStep	ConvertToLocal (const G4ThreeVector &globalPosition, const G4ThreeVector &globalDirection, const G4double stepLength=0, const G4bool useCurvilinear=true, const G4double marginLength=1) const

BDSStep	ConvertToGlobalStep (const G4ThreeVector &localPosition, const G4ThreeVector &localDirection, const G4bool useCurvilinear=true) const

G4ThreeVector	ConvertToLocal (const G4double globalPoint[3], const G4bool useCurvilinear=true) const

G4ThreeVector	ConvertToLocal (const G4ThreeVector &globalPosition, const G4bool useCurvilinear=true) const
	Vector version - see notes above.

G4ThreeVector	ConvertToLocalNoSetup (const G4ThreeVector &globalPosition, const G4bool useCurvilinear=true) const
	Similar to above function but does NOT initialise the transforms.

G4ThreeVector	ConvertAxisToLocal (const G4ThreeVector &globalAxis, const G4bool useCurvilinear=true) const

G4ThreeVector	ConvertAxisToLocal (const G4double globalPoint[3], const G4double globalAxis[3], const G4bool useCurvilinear=true) const

G4ThreeVector	ConvertAxisToLocal (const G4ThreeVector &globalPoint, const G4ThreeVector &globalAxis, const G4bool useCurvilinear=true) const
	Vector version.

G4ThreeVector	ConvertAxisToGlobal (const G4ThreeVector &localAxis, const G4bool useCurvilinear=true) const

std::pair< G4ThreeVector, G4ThreeVector >	ConvertAxisToGlobal (const std::pair< G4ThreeVector, G4ThreeVector > &localAxis, const G4bool useCurvilinear=true) const

G4ThreeVector	ConvertToGlobal (const G4ThreeVector &localPosition, const G4bool useCurvilinear=true) const

G4ThreeVector	ConvertAxisToGlobal (const G4ThreeVector &globalPosition, const G4ThreeVector &localAxis, const G4bool useCurvilinear=true) const

G4ThreeVector	ConvertToGlobal (const G4ThreeVector &globalPosition, const G4ThreeVector &localPosition, const G4bool useCurvilinear=true) const

BDSStep	GlobalToCurvilinear (const G4double fieldArcLength, const G4ThreeVector &unitField, const G4double angle, const G4ThreeVector &position, const G4ThreeVector &unitMomentum, const G4double h, const G4bool useCurvilinearWorld, const G4double FCof, const G4double tilt=0)

BDSStep	GlobalToCurvilinear (const G4ThreeVector &position, const G4ThreeVector &unitMomentum, const G4double h, const G4bool useCurvilinearWorld)

BDSStep	CurvilinearToGlobal (const G4ThreeVector &localPosition, const G4ThreeVector &localMomentum, const G4bool useCurvilinearWorld)

BDSStep	CurvilinearToGlobal (const G4double fieldArcLength, const G4ThreeVector &unitField, const G4double angle, const G4ThreeVector &CLPosition, const G4ThreeVector &CLMomentum, const G4bool useCurvilinearWorld, const G4double FCof, const G4double tilt=0)

Private Attributes
BDSFieldEM *	field
	The field on which this is based.

Additional Inherited Members
Static Public Member Functions inherited from BDSAuxiliaryNavigator
static void	AttachWorldVolumeToNavigator (G4VPhysicalVolume *worldPVIn)
	Setup the navigator w.r.t. to a world volume - typically real world.

static void	AttachWorldVolumeToNavigatorCL (G4VPhysicalVolume *curvilinearWorldPVIn)

static void	RegisterCurvilinearBridgeWorld (G4VPhysicalVolume *curvilinearBridgeWorldPVIn)

static void	ResetNavigatorStates ()

Protected Attributes inherited from BDSFieldEM
G4bool	finiteStrength
	Flag to cache whether finite nor not.

G4Transform3D	transform
	Transform to apply for the field relative to the local coordinates of the geometry.

G4bool	transformIsNotIdentity
	Cache of whether to use transform at all.

BDSModulator *	modulator
	Optional modulator;.

Protected Attributes inherited from BDSAuxiliaryNavigator
G4AffineTransform	globalToLocal

G4AffineTransform	localToGlobal

G4AffineTransform	globalToLocalCL

G4AffineTransform	localToGlobalCL

G4bool	bridgeVolumeWasUsed

Static Protected Attributes inherited from BDSAuxiliaryNavigator
static G4Navigator *	auxNavigator = new G4Navigator()

static G4Navigator *	auxNavigatorCL = new G4Navigator()

static G4Navigator *	auxNavigatorCLB = new G4Navigator()

Detailed Description

A base class for electro-magnetic fields in local to be used in global coordinates.

This base class provides the aggregate inheritance and utility functions for magnetic fields in local coordinates to be used in global coordinates.

Constness is particularly important here as member functions are called from inside G4MagneticField::GetField function which is const.

This owns the field it wraps.

Author: Laurie Nevay

Definition at line 44 of file BDSFieldEMGlobal.hh.

Constructor & Destructor Documentation

◆ BDSFieldEMGlobal()

BDSFieldEMGlobal::BDSFieldEMGlobal ( BDSFieldEM * fieldIn )

explicit

Definition at line 28 of file BDSFieldEMGlobal.cc.

◆ ~BDSFieldEMGlobal()

BDSFieldEMGlobal::~BDSFieldEMGlobal ( )

virtual

Definition at line 34 of file BDSFieldEMGlobal.cc.

Member Function Documentation

◆ DoesFieldChangeEnergy()

virtual G4bool BDSFieldEMGlobal::DoesFieldChangeEnergy ( ) const

inlinevirtual

Necessary overload for Geant4.

Reimplemented from BDSFieldEM.

Definition at line 63 of file BDSFieldEMGlobal.hh.

◆ GetField()

std::pair< G4ThreeVector, G4ThreeVector > BDSFieldEMGlobal::GetField	(	const G4ThreeVector &	position,
		const G4double	t
	)		const

virtual

Get the field - local coordinates. First G4ThreeVector is B field, second is E Field x,y,z respectively. Apply the global to local transform, query the wrapped field object and transform this field to global coordinates before returning.

Implements BDSFieldEM.

Definition at line 48 of file BDSFieldEMGlobal.cc.

References BDSAuxiliaryNavigator::ConvertAxisToGlobal(), BDSAuxiliaryNavigator::ConvertToLocal(), field, and BDSFieldEM::GetFieldTransformed().

Referenced by GetFieldTransformed().

Here is the call graph for this function: