A 1D field from an interpolated array with any interpolation. More...

Inheritance diagram for BDSFieldMagInterpolated1D:

Collaboration diagram for BDSFieldMagInterpolated1D:

Public Member Functions
	BDSFieldMagInterpolated1D (BDSInterpolator1D *interpolatorIn, const G4Transform3D &offset=G4Transform3D::Identity, G4double scalingIn=1.0)

virtual G4ThreeVector	GetField (const G4ThreeVector &position, const G4double t=0) const
	Return the interpolated field value at a given point.

const BDSInterpolator1D *	Interpolator () const

Public Member Functions inherited from BDSFieldMagInterpolated
	BDSFieldMagInterpolated (const BDSInterpolator *interpolator, const G4Transform3D &offset, G4double scalingIn=1.0)

virtual G4bool	TimeVarying () const

G4double	Scaling () const

void	SetScaling (G4double scalingIn)

BDSExtent	ExtentNoOffset () const
	Extent of field without any offset (ie in its own coordinate frame).

BDSExtent	Extent () const
	For now, we will ignore any rotation of the transform. TODO.

G4double	SmallestSpatialStep () const

Public Member Functions inherited from BDSFieldMag
	BDSFieldMag ()

	BDSFieldMag (G4Transform3D transformIn)

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.

virtual void	SetTransform (const G4Transform3D &transformIn)

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

G4bool	FiniteStrength () const
	Accessor.

Private Attributes
BDSInterpolator1D *	interpolator
	Interpolator field is based on.

const G4int	dimensionIndex
	Integer index to dimension to use.

const G4bool	time
	Cache of whether to use time coordinate.

Additional Inherited Members
Protected Attributes inherited from BDSFieldMagInterpolated
G4bool	timeVarying

Protected Attributes inherited from BDSFieldMag
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;.

Detailed Description

A 1D field from an interpolated array with any interpolation.

Owns interpolator.

This provides a simple interface for magnetic fields to use a 1D interpolator irrespective of which type of interpolator it is.

Optional dimension index to specify which dimension in space to vary with.

Constructor & Destructor Documentation

BDSFieldMagInterpolated1D::BDSFieldMagInterpolated1D	(	BDSInterpolator1D *	interpolatorIn,
		const G4Transform3D &	offset = `G4Transform3D::Identity`,
		G4double	scalingIn = `1.0`
	)