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

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

#include <BDSInterpolator1DNearest.hh>

Inheritance diagram for BDSInterpolator1DNearest:
Inheritance graph
Collaboration diagram for BDSInterpolator1DNearest:
Collaboration graph

Public Member Functions

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

Private Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from BDSInterpolator1D
BDSArray1DCoordsarray
 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 BDSInterpolator1DNearest.hh.

Constructor & Destructor Documentation

◆ BDSInterpolator1DNearest()

BDSInterpolator1DNearest::BDSInterpolator1DNearest ( BDSArray1DCoords arrayIn)
explicit

Definition at line 24 of file BDSInterpolator1DNearest.cc.

◆ ~BDSInterpolator1DNearest()

BDSInterpolator1DNearest::~BDSInterpolator1DNearest ( )
virtual

Definition at line 28 of file BDSInterpolator1DNearest.cc.

Member Function Documentation

◆ GetInterpolatedValueT()

BDSFieldValue BDSInterpolator1DNearest::GetInterpolatedValueT ( G4double  x) 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 BDSInterpolator1D.

Definition at line 31 of file BDSInterpolator1DNearest.cc.

References BDSInterpolator1D::array, and BDSArray1DCoords::ExtractNearest().

Here is the call graph for this function:

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