Interpolated field array that gives the nearest neighbour value. More...

#include <BDSInterpolator3DNearest.hh>

Inheritance diagram for BDSInterpolator3DNearest:

Collaboration diagram for BDSInterpolator3DNearest:

Public Member Functions
	BDSInterpolator3DNearest (BDSArray3DCoords *arrayIn)

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

const BDSArray3DCoords *	Array () const

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

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

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

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) const

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

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

Additional Inherited Members
Protected Attributes inherited from BDSInterpolator3D
BDSArray3DCoords *	array
	The field data. More...

Protected Attributes inherited from BDSInterpolator
G4double	smallestSpatialStep

Detailed Description

Interpolated field array that gives the nearest neighbour value.

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

Author: Laurie Nevay

Definition at line 37 of file BDSInterpolator3DNearest.hh.

Constructor & Destructor Documentation

◆ BDSInterpolator3DNearest()

BDSInterpolator3DNearest::BDSInterpolator3DNearest ( BDSArray3DCoords * arrayIn )

explicit

Definition at line 23 of file BDSInterpolator3DNearest.cc.

◆ ~BDSInterpolator3DNearest()

BDSInterpolator3DNearest::~BDSInterpolator3DNearest ( )

virtual

Definition at line 27 of file BDSInterpolator3DNearest.cc.

Member Function Documentation

◆ GetInterpolatedValueT()

BDSFieldValue BDSInterpolator3DNearest::GetInterpolatedValueT	(	G4double	x,
		G4double	y,
		G4double	z
	)		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 BDSInterpolator3D.

Definition at line 30 of file BDSInterpolator3DNearest.cc.

References BDSInterpolator3D::array, and BDSArray3DCoords::ExtractNearest().

Here is the call graph for this function:

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

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

Public Member Functions

Protected Member Functions