BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Public Member Functions | Protected Member Functions | Private Member Functions
BDSInterpolator4DNearest Class Reference

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

#include <BDSInterpolator4DNearest.hh>

Inheritance diagram for BDSInterpolator4DNearest:
Inheritance graph
Collaboration diagram for BDSInterpolator4DNearest:
Collaboration graph

Public Member Functions

 BDSInterpolator4DNearest (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. More...
 
const BDSArray4DCoordsArray () 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
 
virtual BDSFieldValue GetInterpolatedValueT (G4double x, G4double y, G4double z, G4double t) const =0
 

Private Member Functions

 BDSInterpolator4DNearest ()=delete
 Private default constructor to force the use of the provided one.
 

Additional Inherited Members

- Protected Attributes inherited from BDSInterpolator4D
BDSArray4DCoordsarray
 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 BDSInterpolator4DNearest.hh.

Constructor & Destructor Documentation

◆ BDSInterpolator4DNearest()

BDSInterpolator4DNearest::BDSInterpolator4DNearest ( BDSArray4DCoords arrayIn)
explicit

Definition at line 22 of file BDSInterpolator4DNearest.cc.

◆ ~BDSInterpolator4DNearest()

BDSInterpolator4DNearest::~BDSInterpolator4DNearest ( )
virtual

Definition at line 26 of file BDSInterpolator4DNearest.cc.

Member Function Documentation

◆ GetInterpolatedValueT()

BDSFieldValue BDSInterpolator4DNearest::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 29 of file BDSInterpolator4DNearest.cc.

References BDSInterpolator4D::array, and BDSArray4DCoords::ExtractNearest().

Here is the call graph for this function:

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