BDSInterpolator1D Class Reference

Interface for all 1D interpolators. More...

#include <BDSInterpolator1D.hh>

Inheritance diagram for BDSInterpolator1D:

Collaboration diagram for BDSInterpolator1D:

Public Member Functions
	BDSInterpolator1D (BDSArray1DCoords *arrayIn)
G4ThreeVector	GetInterpolatedValue (G4double x) const
	Public interface to a 1D interpolator. Returns Geant4 type as that's what will be needed.
const BDSArray1DCoords *	Array () const
	Accessor for the underlying array data.
BDSDimensionType	FirstDimension () const
	Accessor for the active dimension this represents.
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) const =0

Protected Attributes
BDSArray1DCoords *	array
	The field data.
Protected Attributes inherited from BDSInterpolator
G4double	smallestSpatialStep

Detailed Description

Interface for all 1D interpolators.

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

Author

Laurie Nevay

Definition at line 38 of file BDSInterpolator1D.hh.

Constructor & Destructor Documentation

BDSInterpolator1D()

BDSInterpolator1D::BDSInterpolator1D ( BDSArray1DCoords *  arrayIn )

explicit

Definition at line 24 of file BDSInterpolator1D.cc.

~BDSInterpolator1D()

virtual BDSInterpolator1D::~BDSInterpolator1D ( )

inlinevirtual

Definition at line 43 of file BDSInterpolator1D.hh.

Member Function Documentation

Array()

const BDSArray1DCoords * BDSInterpolator1D::Array ( ) const

inline

Accessor for the underlying array data.

Definition at line 49 of file BDSInterpolator1D.hh.

References array.

Extent()

virtual BDSExtent BDSInterpolator1D::Extent ( ) const

inlinevirtual

Extent of field.

Implements BDSInterpolator.

Definition at line 55 of file BDSInterpolator1D.hh.

References array, and BDSArray1DCoords::Extent().

Here is the call graph for this function:

FirstDimension()

BDSDimensionType BDSInterpolator1D::FirstDimension ( ) const

inline

Accessor for the active dimension this represents.

Definition at line 52 of file BDSInterpolator1D.hh.

References array, and BDSArray4DCoords::FirstDimension().

Here is the call graph for this function:

GetInterpolatedValue()

G4ThreeVector BDSInterpolator1D::GetInterpolatedValue

(

G4double

x

)

const

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

Definition at line 29 of file BDSInterpolator1D.cc.

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

Referenced by BDSFieldEInterpolated1D::GetField(), BDSFieldEMInterpolated1D::GetField(), and BDSFieldMagInterpolated1D::GetField().

Here is the call graph for this function:

Here is the caller graph for this function:

GetInterpolatedValueT()

virtual BDSFieldValue BDSInterpolator1D::GetInterpolatedValueT ( G4double  x ) 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 BDSInterpolator1DCubic, BDSInterpolator1DLinear, BDSInterpolator1DLinearMag, and BDSInterpolator1DNearest.

Referenced by GetInterpolatedValue().

Here is the caller graph for this function:

TimeVarying()

virtual G4bool BDSInterpolator1D::TimeVarying ( ) const

inlinevirtual

Implements BDSInterpolator.

Definition at line 57 of file BDSInterpolator1D.hh.

Field Documentation

array

BDSArray1DCoords* BDSInterpolator1D::array

protected

The field data.

Definition at line 66 of file BDSInterpolator1D.hh.

Referenced by Array(), Extent(), FirstDimension(), BDSInterpolator1DCubic::GetInterpolatedValueT(), BDSInterpolator1DLinear::GetInterpolatedValueT(), BDSInterpolator1DLinearMag::GetInterpolatedValueT(), and BDSInterpolator1DNearest::GetInterpolatedValueT().

---

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

• /Users/lnevay/physics/reps/bdsim/include/BDSInterpolator1D.hh
• /Users/lnevay/physics/reps/bdsim/src/BDSInterpolator1D.cc