Interface for all 4D interpolators. More...

#include <BDSInterpolator4D.hh>

Inheritance diagram for BDSInterpolator4D:

Collaboration diagram for BDSInterpolator4D:

Public Member Functions
	BDSInterpolator4D (BDSArray4DCoords *arrayIn)

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

const BDSArray4DCoords *	Array () const

virtual BDSExtent	Extent () const
	Extent of field. More...

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

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

G4double	SmallestSpatialStep () const

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

Protected Attributes
BDSArray4DCoords *	array
	The field data. More...

Protected Attributes inherited from BDSInterpolator
G4double	smallestSpatialStep

Detailed Description

Interface for all 4D interpolators.

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

Author: Laurie Nevay

Definition at line 39 of file BDSInterpolator4D.hh.

Constructor & Destructor Documentation

◆ BDSInterpolator4D()

BDSInterpolator4D::BDSInterpolator4D ( BDSArray4DCoords * arrayIn )

explicit

Definition at line 24 of file BDSInterpolator4D.cc.

◆ ~BDSInterpolator4D()

virtual BDSInterpolator4D::~BDSInterpolator4D ( )

inlinevirtual

Definition at line 44 of file BDSInterpolator4D.hh.

Member Function Documentation

◆ Array()

const BDSArray4DCoords * BDSInterpolator4D::Array ( ) const

inline

Definition at line 49 of file BDSInterpolator4D.hh.

◆ Extent()

virtual BDSExtent BDSInterpolator4D::Extent ( ) const

inlinevirtual

Extent of field.

Implements BDSInterpolator.

Definition at line 52 of file BDSInterpolator4D.hh.

References array, and BDSArray4DCoords::Extent().

Here is the call graph for this function:

◆ GetInterpolatedValue()

G4ThreeVector BDSInterpolator4D::GetInterpolatedValue	(	G4double	x,
		G4double	y,
		G4double	z,
		G4double	t
	)		const

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

Definition at line 29 of file BDSInterpolator4D.cc.

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

Referenced by BDSFieldEInterpolated4D::GetField(), BDSFieldMagInterpolated4D::GetField(), and BDSFieldEMInterpolated4D::GetField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetInterpolatedValueT()

virtual BDSFieldValue BDSInterpolator4D::GetInterpolatedValueT	(	G4double	x,
		G4double	y,
		G4double	z,
		G4double	t
	)		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 BDSInterpolator4DCubic, BDSInterpolator4DLinear, BDSInterpolator4DLinearMag, and BDSInterpolator4DNearest.

Referenced by GetInterpolatedValue().

Here is the caller graph for this function:

Field Documentation

◆ array

BDSArray4DCoords* BDSInterpolator4D::array

protected

The field data.

Definition at line 64 of file BDSInterpolator4D.hh.

Referenced by Extent(), BDSInterpolator4DCubic::GetInterpolatedValueT(), BDSInterpolator4DLinear::GetInterpolatedValueT(), BDSInterpolator4DLinearMag::GetInterpolatedValueT(), and BDSInterpolator4DNearest::GetInterpolatedValueT().

The documentation for this class was generated from the following files:

/Users/nevay/physics/reps/bdsim/include/BDSInterpolator4D.hh
/Users/nevay/physics/reps/bdsim/src/BDSInterpolator4D.cc

Public Member Functions

Protected Member Functions

Protected Attributes