Wrapper class to convert to global coordinates using a navigator for placements. More...

#include <BDSFieldEGlobalPlacement.hh>

Inheritance diagram for BDSFieldEGlobalPlacement:

Collaboration diagram for BDSFieldEGlobalPlacement:

Public Member Functions
	BDSFieldEGlobalPlacement (BDSFieldE *fieldIn)

virtual G4ThreeVector	GetFieldTransformed (const G4ThreeVector &position, const G4double t) const

G4ThreeVector	GetField (const G4ThreeVector &position, const G4double t) const

virtual G4bool	DoesFieldChangeEnergy () const
	Necessary overload for Geant4. More...

Public Member Functions inherited from BDSFieldE
	BDSFieldE ()

	BDSFieldE (G4Transform3D transformIn)

virtual G4ThreeVector	GetField (const G4ThreeVector &position, const G4double t=0) const =0

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

virtual G4ThreeVector	GetFieldTransformed (const G4ThreeVector &position, const G4double t) const
	Get the field value after applying transform for local offset. More...

virtual void	SetTransform (const G4Transform3D &transformIn)

G4bool	FiniteStrength () const
	Accessor. More...

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. More...

G4ThreeVector	ConvertAxisToGlobal (const G4ThreeVector &localAxis) const

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

Private Attributes
BDSFieldE *	field
	The field on which this is based. More...

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. More...

static void	ResetNavigatorStates ()

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

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

Protected Attributes inherited from BDSNavigatorPlacements
G4AffineTransform	globalToLocal

G4AffineTransform	localToGlobal

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

Detailed Description

Wrapper class to convert to global coordinates using a navigator for placements.

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 GetField function which is const.

This owns the field it wraps.

Author: Laurie Nevay

Definition at line 44 of file BDSFieldEGlobalPlacement.hh.

Constructor & Destructor Documentation

◆ BDSFieldEGlobalPlacement()

BDSFieldEGlobalPlacement::BDSFieldEGlobalPlacement ( BDSFieldE * fieldIn )

explicit

Definition at line 25 of file BDSFieldEGlobalPlacement.cc.

◆ ~BDSFieldEGlobalPlacement()

BDSFieldEGlobalPlacement::~BDSFieldEGlobalPlacement ( )

virtual

Definition at line 31 of file BDSFieldEGlobalPlacement.cc.

Member Function Documentation

◆ DoesFieldChangeEnergy()

virtual G4bool BDSFieldEGlobalPlacement::DoesFieldChangeEnergy ( ) const

inlinevirtual

Necessary overload for Geant4.

Definition at line 63 of file BDSFieldEGlobalPlacement.hh.

◆ GetField()

G4ThreeVector BDSFieldEGlobalPlacement::GetField	(	const G4ThreeVector &	position,
		const G4double	t
	)		const

virtual

Get the field - local coordinates. Apply the global to local transform, query the wrapped field object and transform this field to global coordinates before returning.

Implements BDSFieldE.

Definition at line 45 of file BDSFieldEGlobalPlacement.cc.

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

Referenced by GetFieldTransformed().

Here is the call graph for this function: