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

Class to provide scaling and a base class pointer for interpolator fields. More...

#include <BDSFieldEMInterpolated.hh>

Inheritance diagram for BDSFieldEMInterpolated:
Inheritance graph
Collaboration diagram for BDSFieldEMInterpolated:
Collaboration graph

Public Member Functions

 BDSFieldEMInterpolated (const BDSInterpolator *eInterpolator, const BDSInterpolator *bInterpolator, const G4Transform3D &offset, G4double eScalingIn=1.0, G4double bScalingIn=1.0)
 
G4double SmallestSpatialStep () const
 
G4double EScaling () const
 Accessor. More...
 
G4double BScaling () const
 Accessor. More...
 
void SetEScaling (G4double eScalingIn)
 Setter. More...
 
void SetBScaling (G4double bScalingIn)
 Setter. More...
 
- Public Member Functions inherited from BDSFieldEM
 BDSFieldEM ()
 
 BDSFieldEM (G4Transform3D transformIn)
 
virtual std::pair< G4ThreeVector, G4ThreeVector > GetField (const G4ThreeVector &position, const G4double t=0) const =0
 
virtual void GetFieldValue (const G4double point[4], G4double *field) const
 
virtual std::pair< G4ThreeVector, 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)
 
virtual G4bool DoesFieldChangeEnergy () const
 Required overload by Geant4. More...
 
G4bool FiniteStrength () const
 Accessor. More...
 

Private Attributes

G4double eScaling
 E field scaling value. More...
 
G4double bScaling
 B field scaling value. More...
 
G4double smallestSpatialStep
 

Additional Inherited Members

- Protected Attributes inherited from BDSFieldEM
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

Class to provide scaling and a base class pointer for interpolator fields.

Author
Laurie Nevay

Definition at line 34 of file BDSFieldEMInterpolated.hh.

Constructor & Destructor Documentation

◆ BDSFieldEMInterpolated()

BDSFieldEMInterpolated::BDSFieldEMInterpolated ( const BDSInterpolator eInterpolator,
const BDSInterpolator bInterpolator,
const G4Transform3D &  offset,
G4double  eScalingIn = 1.0,
G4double  bScalingIn = 1.0 
)

Definition at line 25 of file BDSFieldEMInterpolated.cc.

◆ ~BDSFieldEMInterpolated()

virtual BDSFieldEMInterpolated::~BDSFieldEMInterpolated ( )
inlinevirtual

Definition at line 43 of file BDSFieldEMInterpolated.hh.

Member Function Documentation

◆ BScaling()

G4double BDSFieldEMInterpolated::BScaling ( ) const
inline

Accessor.

Definition at line 47 of file BDSFieldEMInterpolated.hh.

References bScaling.

Referenced by BDSFieldEMInterpolated1D::GetField(), BDSFieldEMInterpolated2D::GetField(), BDSFieldEMInterpolated3D::GetField(), and BDSFieldEMInterpolated4D::GetField().

Here is the caller graph for this function:

◆ EScaling()

G4double BDSFieldEMInterpolated::EScaling ( ) const
inline

Accessor.

Definition at line 46 of file BDSFieldEMInterpolated.hh.

References eScaling.

Referenced by BDSFieldEMInterpolated1D::GetField(), BDSFieldEMInterpolated2D::GetField(), BDSFieldEMInterpolated3D::GetField(), and BDSFieldEMInterpolated4D::GetField().

Here is the caller graph for this function:

◆ SetBScaling()

void BDSFieldEMInterpolated::SetBScaling ( G4double  bScalingIn)
inline

Setter.

Definition at line 52 of file BDSFieldEMInterpolated.hh.

References bScaling.

◆ SetEScaling()

void BDSFieldEMInterpolated::SetEScaling ( G4double  eScalingIn)
inline

Setter.

Definition at line 51 of file BDSFieldEMInterpolated.hh.

References eScaling.

◆ SmallestSpatialStep()

G4double BDSFieldEMInterpolated::SmallestSpatialStep ( ) const
inline

Definition at line 55 of file BDSFieldEMInterpolated.hh.

Field Documentation

◆ bScaling

G4double BDSFieldEMInterpolated::bScaling
private

B field scaling value.

Definition at line 59 of file BDSFieldEMInterpolated.hh.

Referenced by BScaling(), and SetBScaling().

◆ eScaling

G4double BDSFieldEMInterpolated::eScaling
private

E field scaling value.

Definition at line 58 of file BDSFieldEMInterpolated.hh.

Referenced by EScaling(), and SetEScaling().

◆ smallestSpatialStep

G4double BDSFieldEMInterpolated::smallestSpatialStep
private

Definition at line 60 of file BDSFieldEMInterpolated.hh.


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