Linear interpolation over 2d array including magnitude interpolation. More...

#include <BDSInterpolator2DLinearMag.hh>

Inheritance diagram for BDSInterpolator2DLinearMag:

Collaboration diagram for BDSInterpolator2DLinearMag:

Public Member Functions
	BDSInterpolator2DLinearMag (BDSArray2DCoords *arrayIn)

Public Member Functions inherited from BDSInterpolator2D
	BDSInterpolator2D (BDSArray2DCoords *arrayIn)

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

const BDSArray2DCoords *	Array () const

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

BDSDimensionType	SecondDimension () 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) const

virtual BDSFieldValue	GetInterpolatedValueT (G4double x, G4double y) const =0

Private Member Functions
	BDSInterpolator2DLinearMag ()=delete
	Private default constructor to force use of provided one.

Additional Inherited Members
Protected Attributes inherited from BDSInterpolator2D
BDSArray2DCoords *	array
	The field data.

Protected Attributes inherited from BDSInterpolator
G4double	smallestSpatialStep

Detailed Description

Linear interpolation over 2d array including magnitude interpolation.

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

This uses a bilinear algorithm to interpolate a 2d array and return the value at any arbitrary point. If the point lies outside the array the default value for the templated parameter is returned (typically 0). Therefore, the field drops to 0 outside the specified region.

Author: Laurie Nevay

Definition at line 42 of file BDSInterpolator2DLinearMag.hh.

Constructor & Destructor Documentation

◆ BDSInterpolator2DLinearMag()

BDSInterpolator2DLinearMag::BDSInterpolator2DLinearMag ( BDSArray2DCoords * arrayIn )

explicit

Definition at line 26 of file BDSInterpolator2DLinearMag.cc.

◆ ~BDSInterpolator2DLinearMag()

BDSInterpolator2DLinearMag::~BDSInterpolator2DLinearMag ( )

virtual

Definition at line 30 of file BDSInterpolator2DLinearMag.cc.

Member Function Documentation

◆ GetInterpolatedValueT()

BDSFieldValue BDSInterpolator2DLinearMag::GetInterpolatedValueT	(	G4double	x,
		G4double	y
	)		const

protectedvirtual

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.

Implements BDSInterpolator2D.

Definition at line 33 of file BDSInterpolator2DLinearMag.cc.

References BDSInterpolator2D::array, BDSArray2DCoords::ExtractSection2x2(), and BDS::Linear2DMag().

Here is the call graph for this function:

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

/Users/lnevay/physics/reps/bdsim/include/BDSInterpolator2DLinearMag.hh
/Users/lnevay/physics/reps/bdsim/src/BDSInterpolator2DLinearMag.cc

Public Member Functions

Protected Member Functions