Interface for all 3D interpolators. More...

#include <BDSInterpolator3D.hh>

Inheritance diagram for BDSInterpolator3D:

Collaboration diagram for BDSInterpolator3D:

Public Member Functions
	BDSInterpolator3D (BDSArray3DCoords *arrayIn)

G4ThreeVector	GetInterpolatedValue (G4double x, G4double y, G4double z) const
	Public interface to a 3D interpolator. Returns Geant4 type as that's what will be needed.

const BDSArray3DCoords *	Array () const

BDSDimensionType	FirstDimension () const
	Accessor for the active dimension this represents (first).

BDSDimensionType	SecondDimension () const
	Accessor for the active dimension this represents (second).

BDSDimensionType	ThirdDimension () const
	Accessor for the active dimension this represents (second).

virtual BDSExtent	Extent () const
	Extent of field.

virtual G4bool	TimeVarying () const

Public Member Functions inherited from BDSInterpolator
	BDSInterpolator (BDSArray4DCoords *arrayIn=nullptr)

virtual BDSExtent	Extent () const =0
	Interface each derived class must provide.

virtual G4bool	TimeVarying () const =0

G4double	SmallestSpatialStep () const

Protected Member Functions
virtual BDSFieldValue	GetInterpolatedValueT (G4double x, G4double y, G4double z) const =0

Protected Attributes
BDSArray3DCoords *	array
	The field data.

Protected Attributes inherited from BDSInterpolator
G4double	smallestSpatialStep

Detailed Description

Interface for all 3D interpolators.

Does not own data - so multiple interpolators could be used on same data.

Author: Laurie Nevay

Definition at line 38 of file BDSInterpolator3D.hh.

Constructor & Destructor Documentation

◆ BDSInterpolator3D()

BDSInterpolator3D::BDSInterpolator3D ( BDSArray3DCoords * arrayIn )

explicit

Definition at line 24 of file BDSInterpolator3D.cc.

◆ ~BDSInterpolator3D()

virtual BDSInterpolator3D::~BDSInterpolator3D ( )

inlinevirtual

Definition at line 43 of file BDSInterpolator3D.hh.

Member Function Documentation

◆ Array()

const BDSArray3DCoords * BDSInterpolator3D::Array ( ) const

inline

Definition at line 48 of file BDSInterpolator3D.hh.

◆ Extent()

virtual BDSExtent BDSInterpolator3D::Extent ( ) const

inlinevirtual

Extent of field.

Implements BDSInterpolator.

Definition at line 60 of file BDSInterpolator3D.hh.

References array, and BDSArray4DCoords::Extent().

Here is the call graph for this function:

◆ FirstDimension()

BDSDimensionType BDSInterpolator3D::FirstDimension ( ) const

inline

Accessor for the active dimension this represents (first).

Definition at line 51 of file BDSInterpolator3D.hh.

References array, and BDSArray4DCoords::FirstDimension().

Here is the call graph for this function:

◆ GetInterpolatedValue()

G4ThreeVector BDSInterpolator3D::GetInterpolatedValue	(	G4double	x,
		G4double	y,
		G4double	z
	)		const

Public interface to a 3D interpolator. Returns Geant4 type as that's what will be needed.

Definition at line 29 of file BDSInterpolator3D.cc.

References GetInterpolatedValueT(), BDSThreeVector< T >::x(), BDSThreeVector< T >::y(), and BDSThreeVector< T >::z().

Referenced by BDSFieldEInterpolated3D::GetField(), BDSFieldEMInterpolated3D::GetField(), and BDSFieldMagInterpolated3D::GetField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetInterpolatedValueT()

virtual BDSFieldValue BDSInterpolator3D::GetInterpolatedValueT	(	G4double	x,
		G4double	y,
		G4double	z
	)		const

protectedpure virtual

Each derived class should implement this function. Note T suffix (was templated) to distinguish it from GetInterpolatedValue which returns Geant4 types and is the main interface to should have the clean name.

Implemented in BDSInterpolator3DCubic, BDSInterpolator3DLinear, BDSInterpolator3DLinearMag, and BDSInterpolator3DNearest.

Referenced by GetInterpolatedValue().

Here is the caller graph for this function: