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

Null B field - for special cases where we need a valid object. More...

#include <BDSFieldMagZero.hh>

Inheritance diagram for BDSFieldMagZero:
Inheritance graph
Collaboration diagram for BDSFieldMagZero:
Collaboration graph

Public Member Functions

virtual G4ThreeVector GetField (const G4ThreeVector &, const G4double=0) const
 Access the field value. More...
 
- 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...
 

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

Null B field - for special cases where we need a valid object.

Simply returns 0,0,0,0,0,0 for all field components. Used for teleporter or specifically written tracking routines that may ignore the 'field' but still need a valid object that can be called by Geant4 in order to fit into its scheme.

Author
Laurie Nevay.

Definition at line 38 of file BDSFieldMagZero.hh.

Constructor & Destructor Documentation

◆ BDSFieldMagZero()

BDSFieldMagZero::BDSFieldMagZero ( )
inline

Definition at line 41 of file BDSFieldMagZero.hh.

◆ ~BDSFieldMagZero()

virtual BDSFieldMagZero::~BDSFieldMagZero ( )
inlinevirtual

Definition at line 43 of file BDSFieldMagZero.hh.

Member Function Documentation

◆ GetField()

virtual G4ThreeVector BDSFieldMagZero::GetField ( const G4ThreeVector &  ,
const  G4double = 0 
) const
inlinevirtual

Access the field value.

Implements BDSFieldMag.

Definition at line 46 of file BDSFieldMagZero.hh.


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