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

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

#include <BDSFieldMagInterpolated4D.hh>

Inheritance diagram for BDSFieldMagInterpolated4D:
Inheritance graph
Collaboration diagram for BDSFieldMagInterpolated4D:
Collaboration graph

Public Member Functions

 BDSFieldMagInterpolated4D (BDSInterpolator4D *interpolatorIn, const G4Transform3D &offset=G4Transform3D::Identity, G4double scalingIn=1.0)
 
virtual G4ThreeVector GetField (const G4ThreeVector &position, const G4double t) const
 Return the interpolated field value at a given point. More...
 
const BDSInterpolator4DInterpolator () 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

BDSInterpolator4Dinterpolator
 Interpolator the field is based on. 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 4D field from an interpolated array with any interpolation.

Owns interpolator.

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

Author
Laurie Nevay

Definition at line 40 of file BDSFieldMagInterpolated4D.hh.

Constructor & Destructor Documentation

◆ BDSFieldMagInterpolated4D()

BDSFieldMagInterpolated4D::BDSFieldMagInterpolated4D ( BDSInterpolator4D interpolatorIn,
const G4Transform3D &  offset = G4Transform3D::Identity,
G4double  scalingIn = 1.0 
)
explicit

Definition at line 25 of file BDSFieldMagInterpolated4D.cc.

◆ ~BDSFieldMagInterpolated4D()

BDSFieldMagInterpolated4D::~BDSFieldMagInterpolated4D ( )
virtual

Definition at line 32 of file BDSFieldMagInterpolated4D.cc.

Member Function Documentation

◆ GetField()

G4ThreeVector BDSFieldMagInterpolated4D::GetField ( const G4ThreeVector &  position,
const G4double  t 
) const
virtual

Return the interpolated field value at a given point.

Implements BDSFieldMag.

Definition at line 37 of file BDSFieldMagInterpolated4D.cc.

References BDSInterpolator4D::GetInterpolatedValue(), and interpolator.

Here is the call graph for this function:

◆ Interpolator()

const BDSInterpolator4D * BDSFieldMagInterpolated4D::Interpolator ( ) const
inline

Definition at line 54 of file BDSFieldMagInterpolated4D.hh.

Field Documentation

◆ interpolator

BDSInterpolator4D* BDSFieldMagInterpolated4D::interpolator
private

Interpolator the field is based on.

Definition at line 57 of file BDSFieldMagInterpolated4D.hh.

Referenced by GetField().


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