Linear interpolation over 4d array. More...

#include <BDSInterpolator4DLinear.hh>

Inheritance diagram for BDSInterpolator4DLinear:

Collaboration diagram for BDSInterpolator4DLinear:

Public Member Functions
	BDSInterpolator4DLinear (BDSArray4DCoords *arrayIn)

Public Member Functions inherited from BDSInterpolator4D
	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.

const BDSArray4DCoords *	Array () const

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, G4double t) const

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

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

Additional Inherited Members
Protected Attributes inherited from BDSInterpolator4D
BDSArray4DCoords *	array
	The field data.

Protected Attributes inherited from BDSInterpolator
G4double	smallestSpatialStep

Detailed Description

Linear interpolation over 4d array.

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

This uses a quad-linear algorithm to interpolate a 3d 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.

This is based on an extension of the trilinear algorithm described in BDSInterpolator3DLinear.hh.

Author: Laurie Nevay

Definition at line 45 of file BDSInterpolator4DLinear.hh.

Constructor & Destructor Documentation

◆ BDSInterpolator4DLinear()

BDSInterpolator4DLinear::BDSInterpolator4DLinear ( BDSArray4DCoords * arrayIn )

explicit

Definition at line 26 of file BDSInterpolator4DLinear.cc.

◆ ~BDSInterpolator4DLinear()

BDSInterpolator4DLinear::~BDSInterpolator4DLinear ( )

virtual

Definition at line 30 of file BDSInterpolator4DLinear.cc.

Member Function Documentation

◆ GetInterpolatedValueT()

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

Definition at line 33 of file BDSInterpolator4DLinear.cc.

References BDSInterpolator4D::array, BDSArray4DCoords::ExtractSection2x2x2x2(), and BDS::Linear4D().

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/BDSInterpolator4DLinear.hh
/Users/lnevay/physics/reps/bdsim/src/BDSInterpolator4DLinear.cc

Public Member Functions

Protected Member Functions