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

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

#include <BDSFieldEInterpolated.hh>

Inheritance diagram for BDSFieldEInterpolated:
Inheritance graph
Collaboration diagram for BDSFieldEInterpolated:
Collaboration graph

Public Member Functions

 BDSFieldEInterpolated (const BDSInterpolator *interpolator, const G4Transform3D &offset, G4double eScalingIn=1.0)
 
G4double EScaling () const
 
void SetEScaling (G4double eScalingIn)
 
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 BDSFieldE
 BDSFieldE ()
 
 BDSFieldE (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

G4double eScaling
 E field scaling value. More...
 
BDSExtent extentNoOffset
 Extent without offset. More...
 
G4double smallestSpatialStep
 

Additional Inherited Members

- Protected Attributes inherited from BDSFieldE
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 35 of file BDSFieldEInterpolated.hh.

Constructor & Destructor Documentation

◆ BDSFieldEInterpolated()

BDSFieldEInterpolated::BDSFieldEInterpolated ( const BDSInterpolator interpolator,
const G4Transform3D &  offset,
G4double  eScalingIn = 1.0 
)

Definition at line 25 of file BDSFieldEInterpolated.cc.

◆ ~BDSFieldEInterpolated()

virtual BDSFieldEInterpolated::~BDSFieldEInterpolated ( )
inlinevirtual

Definition at line 43 of file BDSFieldEInterpolated.hh.

Member Function Documentation

◆ EScaling()

G4double BDSFieldEInterpolated::EScaling ( ) const
inline

Definition at line 45 of file BDSFieldEInterpolated.hh.

◆ Extent()

BDSExtent BDSFieldEInterpolated::Extent ( ) const
inline

For now, we will ignore any rotation of the transform. TODO.

With offset.

Definition at line 52 of file BDSFieldEInterpolated.hh.

References extentNoOffset, BDSFieldE::transform, and BDSExtent::Translate().

Here is the call graph for this function:

◆ ExtentNoOffset()

BDSExtent BDSFieldEInterpolated::ExtentNoOffset ( ) const
inline

Extent of field without any offset (ie in its own coordinate frame).

Definition at line 49 of file BDSFieldEInterpolated.hh.

References extentNoOffset.

◆ SetEScaling()

void BDSFieldEInterpolated::SetEScaling ( G4double  eScalingIn)
inline

Definition at line 46 of file BDSFieldEInterpolated.hh.

◆ SmallestSpatialStep()

G4double BDSFieldEInterpolated::SmallestSpatialStep ( ) const
inline

Definition at line 54 of file BDSFieldEInterpolated.hh.

Field Documentation

◆ eScaling

G4double BDSFieldEInterpolated::eScaling
private

E field scaling value.

Definition at line 57 of file BDSFieldEInterpolated.hh.

◆ extentNoOffset

BDSExtent BDSFieldEInterpolated::extentNoOffset
private

Extent without offset.

Definition at line 58 of file BDSFieldEInterpolated.hh.

Referenced by Extent(), and ExtentNoOffset().

◆ smallestSpatialStep

G4double BDSFieldEInterpolated::smallestSpatialStep
private

Definition at line 59 of file BDSFieldEInterpolated.hh.


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