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

Override G4Mag_UsualEqRhs, provides BDSIM integrators access to particle attributes. More...

#include <BDSMagUsualEqRhs.hh>

Inheritance diagram for BDSMagUsualEqRhs:
Inheritance graph
Collaboration diagram for BDSMagUsualEqRhs:
Collaboration graph

Public Member Functions

 BDSMagUsualEqRhs (G4MagneticField *MagField)
 
G4double FCof () const
 Accessor to variable for normalising to charge. More...
 
G4double Mass () const
 Accessor to particle mass. More...
 
G4double Beta (const G4double y[6])
 Calculate particle velocity W.R.T speed of light. More...
 
G4double Beta (const G4ThreeVector &mom)
 Calculate particle velocity W.R.T speed of light. More...
 
G4double TotalEnergy (const G4double y[])
 Calculate total particle energy. More...
 
G4double TotalEnergy (const G4ThreeVector &mom)
 Calculate total particle energy. More...
 
virtual void SetChargeMomentumMass (G4ChargeState particleCharge, G4double MomentumXc, G4double particleMass)
 Copy of class method from G4Mag_UsualEqRhs. More...
 

Protected Attributes

G4double fMassCof
 Particle mass squared. More...
 
G4double fCof_val
 

Detailed Description

Override G4Mag_UsualEqRhs, provides BDSIM integrators access to particle attributes.

Author
William Shields

Definition at line 36 of file BDSMagUsualEqRhs.hh.

Constructor & Destructor Documentation

◆ BDSMagUsualEqRhs()

BDSMagUsualEqRhs::BDSMagUsualEqRhs ( G4MagneticField *  MagField)

Definition at line 32 of file BDSMagUsualEqRhs.cc.

◆ ~BDSMagUsualEqRhs()

virtual BDSMagUsualEqRhs::~BDSMagUsualEqRhs ( )
inlinevirtual

Definition at line 41 of file BDSMagUsualEqRhs.hh.

Member Function Documentation

◆ Beta() [1/2]

G4double BDSMagUsualEqRhs::Beta ( const G4double  y[6])

Calculate particle velocity W.R.T speed of light.

Definition at line 49 of file BDSMagUsualEqRhs.cc.

References Beta().

Referenced by Beta().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Beta() [2/2]

G4double BDSMagUsualEqRhs::Beta ( const G4ThreeVector &  mom)

Calculate particle velocity W.R.T speed of light.

Definition at line 56 of file BDSMagUsualEqRhs.cc.

References fMassCof.

◆ FCof()

G4double BDSMagUsualEqRhs::FCof ( ) const
inline

Accessor to variable for normalising to charge.

Definition at line 44 of file BDSMagUsualEqRhs.hh.

◆ Mass()

G4double BDSMagUsualEqRhs::Mass ( ) const
inline

Accessor to particle mass.

Definition at line 47 of file BDSMagUsualEqRhs.hh.

References fMassCof.

◆ SetChargeMomentumMass()

void BDSMagUsualEqRhs::SetChargeMomentumMass ( G4ChargeState  particleCharge,
G4double  MomentumXc,
G4double  particleMass 
)
virtual

Copy of class method from G4Mag_UsualEqRhs.

Definition at line 38 of file BDSMagUsualEqRhs.cc.

References fMassCof.

◆ TotalEnergy() [1/2]

G4double BDSMagUsualEqRhs::TotalEnergy ( const G4double  y[])

Calculate total particle energy.

Definition at line 64 of file BDSMagUsualEqRhs.cc.

References TotalEnergy().

Referenced by BDSIntegratorDipoleQuadrupole::Stepper(), and TotalEnergy().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TotalEnergy() [2/2]

G4double BDSMagUsualEqRhs::TotalEnergy ( const G4ThreeVector &  mom)

Calculate total particle energy.

Definition at line 71 of file BDSMagUsualEqRhs.cc.

References fMassCof.

Field Documentation

◆ fCof_val

G4double BDSMagUsualEqRhs::fCof_val
protected

Definition at line 68 of file BDSMagUsualEqRhs.hh.

◆ fMassCof

G4double BDSMagUsualEqRhs::fMassCof
protected

Particle mass squared.

Definition at line 67 of file BDSMagUsualEqRhs.hh.

Referenced by Beta(), Mass(), SetChargeMomentumMass(), and TotalEnergy().


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