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

A 2D field from an interpolated array with any interpolation. More...

#include <BDSFieldMagInterpolated2D.hh>

Inheritance diagram for BDSFieldMagInterpolated2D:
Inheritance graph
Collaboration diagram for BDSFieldMagInterpolated2D:
Collaboration graph

Public Member Functions

 BDSFieldMagInterpolated2D (BDSInterpolator2D *interpolatorIn, const G4Transform3D &offset=G4Transform3D::Identity, G4double scalingIn=1.0)
 
virtual G4ThreeVector GetField (const G4ThreeVector &position, const G4double t=0) const
 
const BDSInterpolator2DInterpolator () const
 
- Public Member Functions inherited from BDSFieldMagInterpolated
 BDSFieldMagInterpolated (const BDSInterpolator *interpolator, const G4Transform3D &offset, G4double scalingIn=1.0)
 
G4double Scaling () const
 
void SetScaling (G4double scalingIn)
 
BDSExtent ExtentNoOffset () const
 Extent of field without any offset (ie in its own coordinate frame). More...
 
BDSExtent Extent () const
 For now, we will ignore any rotation of the transform. TODO. More...
 
G4double SmallestSpatialStep () const
 
- Public Member Functions inherited from BDSFieldMag
 BDSFieldMag ()
 
 BDSFieldMag (G4Transform3D transformIn)
 
virtual G4ThreeVector GetField (const G4ThreeVector &position, const G4double t=0) const =0
 
virtual void GetFieldValue (const G4double point[4], G4double *field) const
 
virtual G4ThreeVector GetFieldTransformed (const G4ThreeVector &position, const G4double t) const
 Get the field value after applying transform for local offset. More...
 
virtual void SetTransform (const G4Transform3D &transformIn)
 
G4bool FiniteStrength () const
 Accessor. More...
 

Private Attributes

BDSInterpolator2Dinterpolator
 Interpolator the field is based on. More...
 
const G4int firstDimensionIndex
 Integer index to dimension to use. More...
 
const G4bool firstTime
 Cache of whether to use time coordinate. More...
 
const G4int secondDimensionIndex
 Integer index to dimension to use. More...
 
const G4bool secondTime
 Cache of whether to use time coordinate. More...
 

Additional Inherited Members

- Protected Attributes inherited from BDSFieldMag
G4bool finiteStrength
 Flag to cache whether finite nor not. More...
 
G4Transform3D transform
 Transform to apply for the field relative to the local coordinates of the geometry. More...
 

Detailed Description

A 2D field from an interpolated array with any interpolation.

Owns interpolator.

This provides a simple interface for magnetic fields to use a 2D interpolator irrespective of which type of interpolator it is.

Author
Laurie Nevay

Definition at line 40 of file BDSFieldMagInterpolated2D.hh.

Constructor & Destructor Documentation

◆ BDSFieldMagInterpolated2D()

BDSFieldMagInterpolated2D::BDSFieldMagInterpolated2D ( BDSInterpolator2D interpolatorIn,
const G4Transform3D &  offset = G4Transform3D::Identity,
G4double  scalingIn = 1.0 
)
explicit

Definition at line 25 of file BDSFieldMagInterpolated2D.cc.

◆ ~BDSFieldMagInterpolated2D()

BDSFieldMagInterpolated2D::~BDSFieldMagInterpolated2D ( )
virtual

Definition at line 36 of file BDSFieldMagInterpolated2D.cc.

Member Function Documentation

◆ GetField()

G4ThreeVector BDSFieldMagInterpolated2D::GetField ( const G4ThreeVector &  position,
const G4double  t = 0 
) const
virtual

Return the interpolated field value at a given point. Note this doesn't depend on the z position, only x & y.

Implements BDSFieldMag.

Definition at line 41 of file BDSFieldMagInterpolated2D.cc.

References firstDimensionIndex, firstTime, BDSInterpolator2D::GetInterpolatedValue(), interpolator, secondDimensionIndex, and secondTime.

Here is the call graph for this function:

◆ Interpolator()

const BDSInterpolator2D * BDSFieldMagInterpolated2D::Interpolator ( ) const
inline

Definition at line 55 of file BDSFieldMagInterpolated2D.hh.

Field Documentation

◆ firstDimensionIndex

const G4int BDSFieldMagInterpolated2D::firstDimensionIndex
private

Integer index to dimension to use.

Definition at line 59 of file BDSFieldMagInterpolated2D.hh.

Referenced by GetField().

◆ firstTime

const G4bool BDSFieldMagInterpolated2D::firstTime
private

Cache of whether to use time coordinate.

Definition at line 60 of file BDSFieldMagInterpolated2D.hh.

Referenced by GetField().

◆ interpolator

BDSInterpolator2D* BDSFieldMagInterpolated2D::interpolator
private

Interpolator the field is based on.

Definition at line 58 of file BDSFieldMagInterpolated2D.hh.

Referenced by GetField().

◆ secondDimensionIndex

const G4int BDSFieldMagInterpolated2D::secondDimensionIndex
private

Integer index to dimension to use.

Definition at line 61 of file BDSFieldMagInterpolated2D.hh.

Referenced by GetField().

◆ secondTime

const G4bool BDSFieldMagInterpolated2D::secondTime
private

Cache of whether to use time coordinate.

Definition at line 62 of file BDSFieldMagInterpolated2D.hh.

Referenced by GetField().


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