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

#include <BDSFieldEMGlobalPlacement.hh>

Inheritance diagram for BDSFieldEMGlobalPlacement:

Collaboration diagram for BDSFieldEMGlobalPlacement:

Public Member Functions
	BDSFieldEMGlobalPlacement (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 BDSNavigatorPlacements
G4ThreeVector	ConvertToLocal (const G4ThreeVector &globalPosition, G4bool &foundAPlacementVolume) const

G4ThreeVector	ConvertToLocalNoSetup (const G4ThreeVector &globalPosition) const
	Similar to above function but does NOT initialise the transforms.

G4ThreeVector	ConvertAxisToGlobal (const G4ThreeVector &localAxis) const

std::pair< G4ThreeVector, G4ThreeVector >	ConvertAxisToGlobal (const std::pair< G4ThreeVector, G4ThreeVector > &localAxis) const

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

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

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 BDSNavigatorPlacements
G4AffineTransform	globalToLocal

G4AffineTransform	localToGlobal

Static Protected Attributes inherited from BDSNavigatorPlacements
static G4Navigator *	navigator = new G4Navigator()

Detailed Description

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

This is done using a navigator for the placement world not the curvilinear one.

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 46 of file BDSFieldEMGlobalPlacement.hh.

Constructor & Destructor Documentation

◆ BDSFieldEMGlobalPlacement()

BDSFieldEMGlobalPlacement::BDSFieldEMGlobalPlacement ( BDSFieldEM * fieldIn )

explicit

Definition at line 27 of file BDSFieldEMGlobalPlacement.cc.

◆ ~BDSFieldEMGlobalPlacement()

BDSFieldEMGlobalPlacement::~BDSFieldEMGlobalPlacement ( )

virtual

Definition at line 33 of file BDSFieldEMGlobalPlacement.cc.

Member Function Documentation

◆ DoesFieldChangeEnergy()

virtual G4bool BDSFieldEMGlobalPlacement::DoesFieldChangeEnergy ( ) const

inlinevirtual

Necessary overload for Geant4.

Reimplemented from BDSFieldEM.

Definition at line 65 of file BDSFieldEMGlobalPlacement.hh.

◆ GetField()

std::pair< G4ThreeVector, G4ThreeVector > BDSFieldEMGlobalPlacement::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 47 of file BDSFieldEMGlobalPlacement.cc.

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

Referenced by GetFieldTransformed().

Here is the call graph for this function: