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

#include <BDSFieldEMInterpolated1D.hh>

Inheritance diagram for BDSFieldEMInterpolated1D:

Collaboration diagram for BDSFieldEMInterpolated1D:

Public Member Functions
	BDSFieldEMInterpolated1D (BDSInterpolator1D eInterpolatorIn, BDSInterpolator1D bInterpolatorIn, const G4Transform3D &offset=G4Transform3D::Identity, G4double eScalingIn=1.0, G4double bScalingIn=1.0)

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

const BDSInterpolator1D *	EInterpolator () const

const BDSInterpolator1D *	BInterpolator () const

Public Member Functions inherited from BDSFieldEMInterpolated
	BDSFieldEMInterpolated (const BDSInterpolator eInterpolator, const BDSInterpolator bInterpolator, const G4Transform3D &offset, G4double eScalingIn=1.0, G4double bScalingIn=1.0)

virtual G4bool	TimeVarying () const

G4double	SmallestSpatialStep () const

G4double	EScaling () const
	Accessor.

G4double	BScaling () const
	Accessor.

void	SetEScaling (G4double eScalingIn)
	Setter.

void	SetBScaling (G4double bScalingIn)
	Setter.

Public Member Functions inherited from BDSFieldEM
	BDSFieldEM ()

	BDSFieldEM (G4Transform3D transformIn)

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.

Private Attributes
BDSInterpolator1D *	eInterpolator
	E Inteprolator the field is based on.

BDSInterpolator1D *	bInterpolator
	B Interpolator the field is based on.

const G4int	eDimensionIndex
	E Integer index to dimension to use.

const G4bool	eTime
	E Cache of whether to use time coordinate.

const G4int	bDimensionIndex
	B Integer index to dimension to use.

const G4bool	bTime
	B Cache of whether to use time coordinate.

Additional Inherited Members
Protected Attributes inherited from BDSFieldEMInterpolated
G4bool	timeVarying

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

Detailed Description

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

Owns interpolators.

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

Author: Laurie Nevay

Definition at line 42 of file BDSFieldEMInterpolated1D.hh.

Constructor & Destructor Documentation

◆ BDSFieldEMInterpolated1D()

BDSFieldEMInterpolated1D::BDSFieldEMInterpolated1D	(	BDSInterpolator1D *	eInterpolatorIn,
		BDSInterpolator1D *	bInterpolatorIn,
		const G4Transform3D &	offset = `G4Transform3D::Identity`,
		G4double	eScalingIn = `1.0`,
		G4double	bScalingIn = `1.0`
	)